Für Entwickler und Unternehmen mit eigener Software
ZUGFeRD nicht selbst implementieren.
Eine HTTP-Schnittstelle: JSON rein, geprüfte ZUGFeRD-PDF oder XRechnung raus. Mit E-Rechnungsfreund müssen Sie EN 16931, Schematron-Prüfung und PDF/A-Umwandlung nicht in Ihrem eigenen Code umsetzen.
REST-API mit OpenAPI-Dokumentation
Ein Beispiel
Rechnung aus JSON anlegen und ZUGFeRD-PDF abholen
# 1. Rechnung aus Ihren JSON-Daten anlegen
curl -X POST https://www.e-rechnungsfreund.de/api/v1/invoices/ \
-H "Authorization: Api-Key $API_KEY" \
-H "Content-Type: application/json" \
-d @invoice.json
# 2. ZUGFeRD-PDF für die zurückgegebene id erzeugen (PDF/A-3b mit eingebettetem XML)
curl -X POST https://www.e-rechnungsfreund.de/api/v1/invoices/42/generate_zugferd_pdf/ \
-H "Authorization: Api-Key $API_KEY" \
-o invoice.pdfFür eine XRechnung an Behörden rufen Sie stattdessen generate_xrechnung auf und erhalten das XML. Alle Felder des Request-Bodys und der Antworten sind in der API-Doku beschrieben. API-Doku ansehen · Codebeispiele und Ablauf
Was Sie bekommen
Was Ihnen die API abnimmt
Versionierte REST-API
Öffentliche API unter /api/v1/ mit Anmeldung per API-Key und OpenAPI-Schema – nutzbar aus jedem System, das HTTP und JSON spricht.
Geprüftes Ergebnis
ZUGFeRD 2.4 (EN 16931) als PDF/A-3b oder XRechnung 3.0.2 als XML, beim Export nach den KoSIT-Regeln geprüft. Fehler kommen in der Antwort zurück.
Prüfen und verwalten
Empfangene E-Rechnungen (XML oder PDF) per API prüfen und Status und Zahlungen Ihrer Rechnungen erfassen.
Fragen und Einwände
Was Sie sich vielleicht fragen
Wie stabil ist die API?
Die öffentliche API ist unter /api/v1/ versioniert und in einem OpenAPI-Schema beschrieben, aus dem Sie auch einen Client erzeugen können.
Ist der API-Zugang im kostenlosen Plan enthalten?
Nein. API-Zugang gibt es nur in Bezahlplänen, die ihn enthalten. Weboberfläche und Validator können Sie kostenlos ausprobieren. Pläne mit API-Zugang
Wie melde ich mich an?
Mit einem API-Key im Authorization-Header: „Api-Key“, gefolgt von Ihrem Schlüssel. Schlüssel legen Sie in Ihrem Konto an, sobald Ihr Plan API-Zugang enthält.