ZUGFeRD API für PDF/A-3b-Hybridrechnungen
Erzeugen Sie ZUGFeRD-Rechnungen als PDF/A-3b mit eingebettetem EN 16931 CII XML über den öffentlichen gPdf E-Invoice Render-Endpunkt.
/api/v1/e-invoice/render Verpacken Sie Rechnungs-PDF-Ausgabe als ZUGFeRD PDF/A-3b mit eingebettetem EN 16931 CII XML, nachdem Ihr ERP- oder Billing-System die korrekten Rechnungsdaten vorbereitet hat.
Wann diese API passt
- Sie benötigen native ZUGFeRD-Ausgabe aus dem öffentlichen E-Invoice Render-Endpunkt.
- Ihr System hat bereits gültiges EN 16931 CII XML für die Rechnung.
- Sie benötigen PDF/A-3b-Paketierung mit ZUGFeRD-Metadaten und Verknüpfung der zugehörigen Datei.
- Sie benötigen eine klare Geschwisterseite zu den breiteren E-Invoice- und Factur-X-Seiten.
Was sie nicht ersetzt
- Sie benötigen native XRechnung-Erzeugung oder Portalübermittlung.
- Sie benötigen, dass gPdf Steuern berechnet, Rechnungssemantik ableitet oder XML aus Buchhaltungsdaten erzeugt.
- Sie benötigen Standards, die nicht im öffentlichen OpenAPI-Vertrag aufgeführt sind.
Welchen Endpoint aufrufen
/api/v1/e-invoice/render
E-Invoice Render ist der Standardpfad für diesen Workflow.
/api/v1/e-invoice/capabilities
Nutzen Sie dies, wenn der Workflow den zugehörigen API-Pfad, einen Template-Vertrag oder eine Capability-Abfrage braucht.
Minimaler Request
POST /api/v1/e-invoice/render - minimale ZUGFeRD-Paketform.
{
"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" }
}
]
}
]
}
Was gPdf übernimmt
- ZUGFeRD-Paketierung über E-Invoice Render.
- PDF/A-3b-Profilbehandlung für hybride Rechnungsausgabe.
- Einbettung von CII XML als zugehörige Datei mit ZUGFeRD-Metadaten.
- Inline-PDF- oder Object-Delivery-Verhalten wie dokumentiert.
Was Ihr System verantwortet
- Korrektheit von EN 16931 CII XML, Rechnungsdaten, Steuerlogik sowie Käufer- und Verkäufersemantik.
- Externe Validierung, Empfängeranforderungen, Portalübermittlung und rechtliche Interpretation.
- Retry-Verhalten, Speicherung, Audit-Nachweise und Kundenzustellung.
Produktions-Checkliste
- Setzen Sie settings.e_invoice.standard = zugferd und settings.e_invoice.profile = en16931.
- Nutzen Sie CII XML mit format = cii und encoding = utf8.
- Setzen Sie settings.profile auf pdfa-3b oder lassen Sie es weg, damit der E-Invoice-Default greift.
- Validieren Sie das zurückgegebene PDF mit Ihrem ZUGFeRD-Validierungsworkflow.
- Halten Sie XRechnung- oder Portalübermittlungsarbeit außerhalb dieses Endpunkts.
Aussagegrenzen
- Diese Seite behandelt ZUGFeRD-Ausgabe über E-Invoice Render.
- Sie behauptet keine native XRechnung-Erzeugung.
- Ihr System verantwortet Rechnungsdaten und XML-Gültigkeit.
ZUGFeRD nutzt den E-Invoice-Render-Pfad
ZUGFeRD ist kein separater Root-Endpunkt. Es wird über das Feld
settings.e_invoice.standard auf POST /api/v1/e-invoice/render ausgewählt.
Die gleiche Grenze gilt: gPdf paketiert die hybride PDF/A-3b-Rechnung; Ihr
System verantwortet Rechnungsfakten und XML-Gültigkeit.
FAQ
- Welcher Endpunkt rendert ZUGFeRD?
- Nutzen Sie POST /api/v1/e-invoice/render mit settings.e_invoice.standard = zugferd.
- Behandelt diese Seite XRechnung?
- Nein. Diese Seite ist auf den öffentlichen ZUGFeRD-Vertrag beschränkt. XRechnung wird hier nicht als native Ausgabe beansprucht.
- Erzeugt gPdf das CII XML?
- Ihr System liefert das EN 16931 CII XML und verantwortet dessen Korrektheit.
- Kann ich das Ergebnis prüfen?
- Nutzen Sie Ihren ZUGFeRD-Validierungsworkflow und die gPdf Validator-Seiten als Validierungskontext.