Compliance และการเก็บถาวร
ZUGFeRD API สำหรับ hybrid invoice แบบ PDF/A-3b
สร้าง invoice แบบ ZUGFeRD PDF/A-3b พร้อม EN 16931 CII XML ที่ฝังอยู่โดยใช้ public gPdf E-Invoice Render endpoint
PRIMARY API E-Invoice Render
ENDPOINT
/api/v1/e-invoice/render SYSTEMS ERP / billing backend / German finance workflow / บริการ compliance automation
งานที่ต้องทำให้เสร็จ
package invoice PDF output เป็น ZUGFeRD PDF/A-3b พร้อม EN 16931 CII XML ที่ฝังอยู่ หลังจาก ERP หรือ billing system ของคุณเตรียม invoice data ที่ถูกต้องแล้ว
ควรใช้ API นี้เมื่อใด
- คุณต้องการ native ZUGFeRD output จาก public E-Invoice Render endpoint
- ระบบของคุณมี EN 16931 CII XML ที่ถูกต้องสำหรับ invoice อยู่แล้ว
- คุณต้องการ PDF/A-3b packaging พร้อม ZUGFeRD metadata และ associated-file wiring
- คุณต้องการ sibling page ที่ชัดเจนกับหน้า e-invoice และ Factur-X ที่กว้างกว่า
สิ่งที่ไม่ได้ทดแทน
- คุณต้องการ native XRechnung generation หรือ portal submission
- คุณต้องการให้ gPdf คำนวณ tax, infer invoice semantics หรือสร้าง XML จาก accounting records
- คุณต้องการ standards ที่ไม่ได้ระบุใน public OpenAPI contract
ควรเรียก endpoint ใด
/api/v1/e-invoice/render
E-Invoice Render คือ path หลักสำหรับเวิร์กโฟลว์นี้.
/api/v1/e-invoice/capabilities
ใช้เมื่อเวิร์กโฟลว์ต้องการ API path ที่เกี่ยวข้อง สัญญาเทมเพลต หรือการค้นหา capability.
Minimal request
POST /api/v1/e-invoice/render - รูปแบบแพ็กเกจ ZUGFeRD ขั้นต่ำ
{
"settings": {
"profile": "pdfa-3b",
"e_invoice": {
"standard": "zugferd",
"profile": "en16931",
"document_type": "invoice",
"xml": {
"format": "cii",
"encoding": "utf8",
"content": "<rsm:CrossIndustryInvoice>...</rsm:CrossIndustryInvoice>"
}
}
},
"pages": [
{
"size": "a4",
"elements": [
{
"type": "text",
"x": 20,
"y": 24,
"content": "ZUGFeRD invoice",
"style": { "font_size": 16, "font_family": "NotoSans-Regular" }
}
]
}
]
}
gPdf จัดการอะไร
- ZUGFeRD packaging ผ่าน E-Invoice Render
- การจัดการ PDF/A-3b profile สำหรับ hybrid invoice output
- การฝัง CII XML เป็น associated file พร้อม ZUGFeRD metadata
- พฤติกรรม inline PDF หรือ object delivery ตามที่ documented
ระบบของคุณรับผิดชอบอะไร
- EN 16931 CII XML correctness, invoice data, tax logic, buyer and seller semantics
- external validation, recipient requirements, portal submission และ legal interpretation
- retry behavior, storage, audit evidence และ customer delivery
Production checklist
- ตั้ง settings.e_invoice.standard = zugferd และ settings.e_invoice.profile = en16931
- ใช้ CII XML พร้อม format = cii และ encoding = utf8
- ตั้ง settings.profile เป็น pdfa-3b หรือ omit เพื่อใช้ e-invoice default
- validate PDF ที่ได้ด้วย ZUGFeRD validation workflow ของคุณ
- เก็บ XRechnung หรือ portal submission work ไว้นอก endpoint นี้
ขอบเขตของ claim
- หน้านี้ครอบคลุม ZUGFeRD output ผ่าน E-Invoice Render
- ไม่ได้อ้าง native XRechnung generation
- ระบบของคุณเป็นเจ้าของ invoice business data และ XML validity
ZUGFeRD ใช้เส้นทาง e-invoice render
ZUGFeRD ไม่ใช่ root endpoint แยกต่างหาก แต่ถูกเลือกผ่าน field settings.e_invoice.standard บน POST /api/v1/e-invoice/render boundary เดียวกันยังใช้: gPdf package hybrid invoice แบบ PDF/A-3b; ระบบของคุณเป็นเจ้าของ invoice facts และ XML validity
FAQ
- endpoint ใดเรนเดอร์ ZUGFeRD
- ใช้ POST /api/v1/e-invoice/render โดยตั้ง settings.e_invoice.standard เป็น zugferd
- หน้านี้ครอบคลุม XRechnung หรือไม่
- ไม่ หน้านี้จำกัดอยู่ที่ public ZUGFeRD contract และไม่ได้อ้างว่า XRechnung เป็น native output ที่นี่
- gPdf สร้าง CII XML หรือไม่
- ระบบของคุณเป็นผู้ส่ง EN 16931 CII XML และเป็นเจ้าของความถูกต้อง
- ตรวจสอบผลลัพธ์ได้หรือไม่
- ใช้ ZUGFeRD validation workflow ของคุณและหน้า validator ของ gPdf เป็น validation context