Dokumente
XRechnung und ZUGFeRD erzeugen, parsen, validieren und herunterladen.
Auf dieser Seite
Dokumentendpunkte
Alle Pfade sind relativ zu /api/v1/sandbox oder /api/v1/live. Die vollständigen JSON-Schemas stehen im OpenAPI-Vertrag.
| Endpunkt | Eingabe / Funktion | Recht |
|---|---|---|
| POST/documents/generate | JSON → XRechnung-UBL oder ZUGFeRD-PDF samt Prüfung. | Generate |
| POST/documents/parse | Original-XML oder ZUGFeRD-PDF → strukturierte Daten. | Process |
| POST/documents/validate | Original technisch prüfen und Bericht erhalten. | Process |
| GET/documents/{id} | Daten, Befunde, Prüfsummen und Artefakt-URLs. | Read |
Eingaben und unterstützte Profile
Senden Sie XML/PDF als unveränderten Anfragekörper, ohne Multipart-Verpackung: application/xml oder application/pdf. Generierung verwendet application/json. Jeder Verarbeitungs-POST benötigt einen stabilen Idempotency-Key.
- Generierung: EUR, 0 / 7 / 19 % Umsatzsteuer, maximal 100 Positionen mit positiven Mengen. Menge und Einzelpreis bis 1.000.000, jeweils höchstens vier Nachkommastellen.
- Bei 0 % sind Steuerschlüssel und erforderlicher Befreiungsgrund anzugeben. Profilabhängige Pflichtangaben bleiben erforderlich.
- Gutschriften/Stornos:
documentType: credit_note,sourceNumberundsourceDate. Die Referenz wird vom Aufrufer geliefert und verknüpft keine App-Buchung. - Parsing liest UBL Invoice/CreditNote und CII, ohne fehlende Beträge als Null zu erfinden. Normale Bild-PDFs werden hier nicht per OCR gelesen.
Technische Ergebnisse richtig einordnen
XRechnung wird mit KoSIT geprüft. ZUGFeRD-EN16931-PDFs werden mit Mustang einschließlich PDF/A geprüft. Eine eigenständige generische CII-Datei ist keine ZUGFeRD-PDF.
| validationStatus | Bedeutung |
|---|---|
| valid | Die angegebenen technischen Regeln wurden bestanden. |
| invalid | Prüfung abgeschlossen, Fehler gefunden. Original und Bericht bleiben erhalten. |
| not_checked | Nur Parsing. Keine Aussage über Konformität. |
Antworten enthalten Regelwerk und Prüfzeitpunkt. Technische Prüfungen beweisen weder steuerliche Richtigkeit noch Übereinstimmung von sichtbarem PDF-Inhalt und eingebettetem XML.
Originale und Berichte herunterladen
| GET /documents/{id}/… | Artefakt |
|---|---|
| original | Unveränderte hochgeladene oder erzeugte Originaldatei. |
| xml | Strukturierte XML, sofern vorhanden. |
| PDF-Ansicht einer gültig erzeugten XRechnung, sofern vorhanden. | |
| report | Originaler technischer Prüfbericht, sofern vorhanden. |
Nicht vorhandene Artefakte liefern 404. Downloads tragen X-Content-SHA256; die Metadaten enthalten Dateigröße, Typ und Hash. Der SDK verifiziert die Prüfsumme. Bei Downloadfehlern die unvollständige Zieldatei verwerfen.
Erneute Verarbeitung ersetzt keine historischen Originale oder Berichte. Eine automatische Löschung ist nicht aktiviert; Betreiber planen Backups und Speicherüberwachung.