Peppox API — API Documentation

Authentifizierung

Typ
APIKEY — API-Schlüssel
Standort
Abfrage / Parameter: API-Schlüssel
Fallback über Query-/Body-Parameter "apikey"
GET /sendsms/?apikey=IHR_API-SCHLÜSSEL

Rechnungsverwaltung

/Rechnung/hinzufügen • Methoden: POST

Fügen Sie einen Kopf für eine Verkaufsrechnung hinzu.

Erstellt einen neuen Rechnungskopf im Entwurfsstatus. Der Endpunkt erfasst alle Lieferanten- und Kundeninformationen, Ausstellungsdaten, Zahlungsbedingungen und Lieferdetails. Lieferantendaten werden automatisch aus Ihrer API-Schlüsselregistrierung (customer_api) geladen.
POST /Rechnung/hinzufügen • Rate: 60 Anfragen/Minute • Authentifizierung erforderlich

Parameter

NameInTypErforderlichStandardBeschreibung
API-Schlüssel Zeichenkette Ja Ihr Peppox-API-Schlüssel (aus Ihrem registrierten Lieferantenkonto).
Netzwerk Zeichenkette NEIN Optionale Netzwerkkennung (standardmäßig Peppol).
inv_id Zeichenkette NEIN Optionale interne Rechnungsnummer.
Ausgabedatum Zeichenkette Ja Rechnungsdatum (JJJJ-MM-TT).
Fälligkeitsdatum Zeichenkette NEIN Fälligkeitsdatum der Rechnung (JJJJ-MM-TT).
Rechnungsartcode Zeichenkette NEIN 380 Peppol-Rechnungstypcode (z. B. 380 = Rechnung, 381 = Gutschrift).
Währung Zeichenkette NEIN EUR ISO-Währungscode.
Buchhaltungskosten Zeichenkette NEIN Verweis auf interne Buchhaltungscodes.
Käuferreferenz Zeichenkette NEIN Käuferreferenz / Bestellnummer.
payment.means_code Zeichenkette NEIN 1 Zahlungsmittel (Peppol-Codeliste).
payment.payment_id Zeichenkette NEIN Zahlungsidentifikationsnummer / Referenznummer.
payment.iban Zeichenkette NEIN IBAN des Zahlungsempfängers.
Zahlungskontoname Zeichenkette NEIN Name des Kontoinhabers des Zahlungsempfängers.
payment.bic Zeichenkette NEIN BIC/SWIFT-Code des Zahlungsempfängers.
Zahlungsbedingungen Zeichenkette NEIN Zahlungsbedingungen.
Liefertermin Zeichenkette NEIN Liefertermin.
Lieferortschema Zeichenkette NEIN 0088 Kennung des Lieferortsystems.
Lieferort-ID Zeichenkette NEIN Lieferort-ID.
delivery.street Zeichenkette NEIN Lieferadresse Straße.
Lieferstadt Zeichenkette NEIN Lieferadresse Stadt.
Lieferung.post Zeichenkette NEIN Postleitzahl der Lieferadresse.
Lieferland Zeichenkette NEIN Ländercode der Lieferadresse.
Name der Lieferpartei Zeichenkette NEIN Name des Zustellers.
customer.endpoint_scheme Zeichenkette NEIN 0208 Kunden-Peppol-Programm-ID.
customer.endpoint_id Zeichenkette NEIN Peppol-Teilnehmer-ID des Kunden.
Kundenname Zeichenkette NEIN Kundenname.
customer.street Zeichenkette NEIN Kundenstraße.
Kunde.Stadt Zeichenkette NEIN Kundenstadt.
customer.postal Zeichenkette NEIN Postleitzahl des Kunden.
Kunde.Land Zeichenkette NEIN Kundenländercode.
Kunden-Umsatzsteuer-Identifikationsnummer Zeichenkette NEIN Umsatzsteuer-Identifikationsnummer des Kunden.
customer.company_id_scheme Zeichenkette NEIN 0208 Kunden-Firmen-ID-System.
Kunden-Firmen-ID Zeichenkette NEIN Firmen-ID des Kunden (nationale Nummer).
Kundentelefon Zeichenkette NEIN Telefonnummer des Kundendienstes.
Kunden-E-Mail Zeichenkette NEIN E-Mail-Adresse des Kundenkontakts.

Beispiele anfordern

CURL
PYTHON
curl -X POST "https://api.peppox.com/invoice/add/" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d "{ "issue_date": "2025-10-17", "due_date": "2025-11-17", "customer": { "endpoint_id": "9915:BE0123456789", "name": "ACME SPRL", "country": "BE" }, "payment": { "iban": "BE12345678901234", "bic": "GEBABEBB", "account_name": "Peppox Supplier" } }"

Antworten

Status: 200 — Rechnung erfolgreich erstellt (Entwurf).
JSON
{ "ok": true, "invoice_guid": "inv-8c3b4a99-2025-10-17", "status": "DRAFT" }
Status: 400 — Ungültige oder fehlende Felder.
Status: 401 — Ungültiger oder abgelaufener API-Schlüssel.
Status: 500 — Interner Server- oder Datenbankfehler.
/invoice_line/add • Methoden: POST

Fügen Sie einer bestehenden Rechnung eine Rechnungsposition hinzu.

Fügt einer bestehenden Rechnung (identifiziert durch invoice_guid) eine neue Zeile hinzu. Unterstützt Einheit, Menge, Preis, Mehrwertsteuerkategorie und Produktidentifikationscodes.
POST /invoice_line/add • Rate: 60 Anfragen/Minute • Authentifizierung erforderlich

Parameter

NameInTypErforderlichStandardBeschreibung
API-Schlüssel Zeichenkette Ja Ihr Peppox-API-Schlüssel (zur Authentifizierung erforderlich).
Rechnungs-GUID Zeichenkette Ja Die eindeutige Rechnungs-GUID, die von /invoice/add zurückgegeben wird.
Zeilen-ID Zeichenkette NEIN Optionale interne Leitungskennung (standardmäßig generierte GUID).
Menge Nummer Ja Menge des Artikels oder der Dienstleistung.
Einheitencode Zeichenkette NEIN Einheitencode gemäß UNECE Rec 20 (z. B. H87 für „Stück“).
Preisbetrag Nummer Ja Preis pro Einheit (ohne Steuern).
Artikelbeschreibung Zeichenkette NEIN Beschreibung des Artikels oder der Dienstleistung.
Artikelname Zeichenkette NEIN Artikelname oder -titel.
Verkäufer-Artikel-ID Zeichenkette NEIN Interne Artikel-ID oder SKU des Verkäufers.
std_item_id_scheme Zeichenkette NEIN 0088 Standard-Schema-ID zur Artikelidentifizierung (z. B. GTIN).
std_item_id Zeichenkette NEIN Standardisierte Artikel-ID (GTIN, EAN usw.).
Herkunftsland Zeichenkette NEIN Ursprungsland (ISO 3166-1 alpha-2).
Steuerkategorie Zeichenkette NEIN Umsatzsteuerkategoriecode (z. B. S, Z, AE).
Steuerprozent Nummer NEIN Mehrwertsteuersatz in Prozent (z. B. 21,00).

Beispiele anfordern

CURL
PYTHON
curl -X POST "https://api.peppox.com/invoice_line/add/" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d "{ "invoice_guid": "inv-8c3b4a99-2025-10-17", "quantity": 2, "unit_code": "H87", "price_amount": 49.99, "item_name": "Consulting service", "tax_percent": 21 }"

Antworten

Status: 200 — Rechnungsposition erfolgreich hinzugefügt.
JSON
{ "ok": true, "line_guid": "line-2b4fa3c1-2025-10-17" }
Status: 400 — Ungültige Parameter (fehlende invoice_guid oder ungültige numerische Felder).
Status: 401 — Ungültiger oder abgelaufener API-Schlüssel.
Status: 500 — Interner Datenbank- oder Serverfehler.
/invoice_attach_pdf/add • Methoden: POST

Fügen Sie einer bestehenden Rechnung eine PDF-Datei bei.

Fügt einer bestehenden Rechnung, die durch invoice_guid identifiziert wird, ein PDF-Dokument (per Upload, Base64 oder Remote-URL) hinzu. Pro Rechnung wird nur ein Anhang gespeichert; alle vorherigen Dateien werden überschrieben.
POST /invoice_attach_pdf/add • Rate: 30 Anfragen/Minute • Authentifizierung erforderlich

Parameter

NameInTypErforderlichStandardBeschreibung
API-Schlüssel Zeichenkette Ja Ihr Peppox-API-Schlüssel (Authentifizierung).
Rechnungs-GUID Zeichenkette Ja Die GUID der Rechnung, an die die PDF-Datei angehängt werden soll.
doc_id Zeichenkette NEIN Optionale Dokumentenkennung (standardmäßig Rechnungs-ID oder eine generierte UUID).
Dateiname Zeichenkette NEIN attachment.pdf Name der Anlagedatei (z. B. invoice.pdf).
Mime Zeichenkette NEIN application/pdf MIME-Typ der Datei.
content_base64 Zeichenkette NEIN PDF-Inhalte als Base64-Zeichenkette. Akzeptiert das Daten-URI-Format.
Datei-URL Zeichenkette NEIN Remote-HTTPS-URL einer PDF-Datei zum Herunterladen und Anhängen.
Datei Datei NEIN Datei-Upload-Feld (multipart/form-data).

Beispiele anfordern

CURL
CURL
CURL
curl -X POST "https://api.peppox.com/invoice_attach_pdf/add/" \ -H "Authorization: Bearer YOUR_API_KEY" \ -F "invoice_guid=inv-8c3b4a99-2025-10-17" \ -F "file=@invoice.pdf"

Antworten

Status: 200 — Die PDF-Datei wurde erfolgreich an die Rechnung angehängt.
JSON
{ "ok": true, "invoice_guid": "inv-8c3b4a99-2025-10-17", "doc_id": "DOC-1452", "filename": "invoice-2025-10.pdf", "mime": "application/pdf", "size_bytes": 184527 }
Status: 400 — Ungültige Parameter oder fehlender Inhalt (keine Base64-Kodierung, Datei oder URL).
Status: 401 — Ungültiger oder abgelaufener API-Schlüssel.
Status: 404 — Rechnung nicht gefunden.
Status: 500 — Interner Server- oder Datenbankfehler.

XML-Generierung

/xml/generate • Methoden: POST

Erstellen Sie eine UBL-XML-Datei für eine Rechnung oder Gutschrift.

Kombiniert Rechnungs-/Gutschriftskopf, Positionen und gegebenenfalls angehängte PDF-Dateien zu einem Peppol-konformen UBL 3.0-XML-Dokument. Gibt den lokalen Pfad zur generierten Datei zurück und aktualisiert den Rechnungs-/Gutschriftsstatus auf XML_BUILT.
POST /xml/generate • Rate: 30 Anfragen/Minute • Authentifizierung erforderlich

Parameter

NameInTypErforderlichStandardBeschreibung
API-Schlüssel Zeichenkette Ja Ihr Peppox-API-Schlüssel zur Authentifizierung.
Rechnungs-GUID Zeichenkette Ja Die eindeutige Kennung der Rechnung, die in XML konvertiert werden soll.
Leitfaden Zeichenkette NEIN Alternativer Schlüssel für invoice_guid.

Beispiele anfordern

CURL
PYTHON
curl -X POST "https://api.peppox.com/xml/generate/" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d "{ "invoice_guid": "inv-8c3b4a99-2025-10-17" }"

Antworten

Status: 200 — XML wurde erfolgreich generiert und auf dem Server gespeichert.
JSON
{ "ok": true, "status": "XML_BUILT", "xml_path": "/var/www/vhosts/peppox.com/httpdocs/invoices_xml/inv-8c3b4a99-2025-10-17.xml" }
Status: 400 — Fehlende invoice_guid oder Rechnungspositionen.
Status: 401 — Ungültiger oder abgelaufener API-Schlüssel.
Status: 404 — Rechnung nicht gefunden.
Status: 500 — Interner XML-Generierungs- oder Schreibfehler.

Gutschriften

/creditnote/add • Methoden: POST

Fügen Sie eine Gutschriftsüberschrift hinzu

Erstellt einen neuen Gutschriftskopf im Entwurfsstatus. Lieferantendaten werden automatisch aus dem API-Schlüsselkonto geladen, während Kunden-, Zahlungs- und Lieferfelder aus der Anfrage übernommen werden.
POST /creditnote/add • Rate: 60 Anfragen/Minute • Authentifizierung erforderlich

Parameter

NameInTypErforderlichStandardBeschreibung
API-Schlüssel Zeichenkette Ja Ihr Peppox-API-Schlüssel.
Netzwerk Zeichenkette NEIN Optionale Netzwerk-Kennung.
Gutschrift-ID Zeichenkette NEIN Bevorzugte Gutschriftsnummer/Kennung.
cn_id Zeichenkette NEIN Alternativer Alias für die Gutschrifts-ID.
Gutschrift-ID Zeichenkette NEIN Alternativer Alias für die Gutschrifts-ID.
inv_id Zeichenkette NEIN Alternativer Legacy-Identifikator.
Ausgabedatum Zeichenkette Ja Ausstellungsdatum der Gutschrift (JJJJ-MM-TT).
Fälligkeitsdatum Zeichenkette NEIN Fälligkeitsdatum (JJJJ-MM-TT).
Rechnungsartcode Zeichenkette NEIN 381 Dokumenttypcode. Standardwert: 381 = Gutschrift.
Währung Zeichenkette NEIN EUR ISO-Währungscode.
Buchhaltungskosten Zeichenkette NEIN Interne Buchhaltungsreferenz.
Käuferreferenz Zeichenkette NEIN Käuferreferenz / Kundenbestellreferenz.
payment.means_code Zeichenkette NEIN 1 Zahlungsmittelcode.
payment.payment_id Zeichenkette NEIN Zahlungsreferenz.
payment.iban Zeichenkette NEIN IBAN des Zahlungsempfängers.
Zahlungskontoname Zeichenkette NEIN Name des Zahlungsempfängerkontos.
payment.bic Zeichenkette NEIN Zahlungsempfänger-BIC / SWIFT.
Zahlungsbedingungen Zeichenkette NEIN Zahlungsbedingungen.
Liefertermin Zeichenkette NEIN Liefertermin.
Lieferortschema Zeichenkette NEIN 0088 Lieferortschema.
Lieferort-ID Zeichenkette NEIN Lieferortkennung.
delivery.street Zeichenkette NEIN Lieferstraße.
Lieferstadt Zeichenkette NEIN Lieferort.
Lieferung.post Zeichenkette NEIN Lieferpostleitzahl.
Lieferland Zeichenkette NEIN Lieferlandcode.
Name der Lieferpartei Zeichenkette NEIN Name des Zustellers.
supplier.endpoint_scheme Zeichenkette NEIN 0208 Lieferanten-Endpunktschema. Lieferantenwerte werden andernfalls aus dem API-Konto geladen.
customer.endpoint_scheme Zeichenkette NEIN 0208 Kundenendpunktschema.
customer.endpoint_id Zeichenkette NEIN Kundenendpunkt-ID.
Kundenname Zeichenkette NEIN Firmenname des Kunden.
customer.street Zeichenkette NEIN Kundenstraße.
Kunde.Stadt Zeichenkette NEIN Kundenstadt.
customer.postal Zeichenkette NEIN Postleitzahl des Kunden.
Kunde.Land Zeichenkette NEIN Kundenländercode.
Kunden-Umsatzsteuer-Identifikationsnummer Zeichenkette NEIN Umsatzsteuer-Identifikationsnummer des Kunden.
customer.company_id_scheme Zeichenkette NEIN 0208 Kunden-Firmen-ID-System.
Kunden-Firmen-ID Zeichenkette NEIN Kunden-Firmen-ID.
Kundentelefon Zeichenkette NEIN Kundentelefon.
Kunden-E-Mail Zeichenkette NEIN Kunden-E-Mail.

Beispiele anfordern

CURL
PYTHON
curl -X POST "https://api.peppox.com/creditnote/add/" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{ "creditnote_id": "CN-2025-001", "issue_date": "2025-10-17", "currency": "EUR", "customer": { "endpoint_id": "9915:BE0123456789", "name": "ACME SPRL", "country": "BE" } }"

Antworten

Status: 200 — Gutschrift erfolgreich erstellt.
JSON
{ "ok": true, "invoice_guid": "cn-8c3b4a99-2025-10-17", "document_type": "CREDIT_NOTE", "status": "DRAFT" }
Status: 400 — Ungültige oder fehlende Felder.
Status: 401 — Ungültiger oder abgelaufener API-Schlüssel.
Status: 500 — Interner Server- oder Datenbankfehler.
/creditnote_line/add • Methoden: POST

Fügen Sie eine Gutschriftszeile hinzu.

Fügt einer bestehenden Gutschrift eine Zeile hinzu. Akzeptiert automatisch Aliase für creditnote_guid und berechnet die Steuerkategorie aus dem Steuersatz, sofern möglich.
POST /creditnote_line/add • Rate: 60 Anfragen/Minute • Authentifizierung erforderlich

Parameter

NameInTypErforderlichStandardBeschreibung
API-Schlüssel Zeichenkette Ja Ihr Peppox-API-Schlüssel.
Gutschrifts-GUID Zeichenkette Ja Die Ziel-Gutschrift-GUID.
Rechnungs-GUID Zeichenkette NEIN Alias für creditnote_guid.
Leitfaden Zeichenkette NEIN Alias für creditnote_guid.
Zeilen-ID Zeichenkette NEIN Optionale interne Leitungskennung.
Auftragszeilen-ID Zeichenkette NEIN Alias für line_id.
Menge Nummer Ja Zeilenanzahl.
Menge Nummer NEIN Alias für Menge.
Q Nummer NEIN Alias für Menge.
Einheitencode Zeichenkette NEIN Gerätecode.
Einheit Zeichenkette NEIN Alias für unit_code.
u Zeichenkette NEIN Alias für unit_code.
Preisbetrag Nummer Ja Stückpreis.
Preis Nummer NEIN Alias für price_amount.
Einzelpreis Nummer NEIN Alias für price_amount.
Artikelbeschreibung Zeichenkette NEIN Linienbeschreibung.
Beschreibung Zeichenkette NEIN Alias für item_description.
Beschreibung Zeichenkette NEIN Alias für item_description.
Artikelname Zeichenkette NEIN Artikelname/Titel.
Name Zeichenkette NEIN Alias für item_name.
Titel Zeichenkette NEIN Alias für item_name.
Verkäufer-Artikel-ID Zeichenkette NEIN Verkäufer-Artikelnummer / SKU.
Verkäufer-ID Zeichenkette NEIN Alias für seller_item_id.
Artikelnummer Zeichenkette NEIN Alias für seller_item_id.
std_item_id_scheme Zeichenkette NEIN 0088 Standardisiertes Artikelidentifizierungsschema.
Standardschema Zeichenkette NEIN Alias für std_item_id_scheme.
Schema Zeichenkette NEIN Alias für std_item_id_scheme.
std_item_id Zeichenkette NEIN Standard-Artikel-ID (EAN, GTIN usw.).
gtin Zeichenkette NEIN Alias für std_item_id.
Ean Zeichenkette NEIN Alias für std_item_id.
Herkunftsland Zeichenkette NEIN Ursprungsland.
Land Zeichenkette NEIN Alias für origin_country.
Steuerkategorie Zeichenkette NEIN Umsatzsteuerkategoriecode. Wird je nach Steuersatz automatisch auf S oder Z gesetzt.
Steuerkategorie Zeichenkette NEIN Alias für tax_category.
Mehrwertsteuerkategorie Zeichenkette NEIN Alias für tax_category.
Steuerprozent Nummer NEIN Mehrwertsteuersatz.
Mehrwertsteuersatz Nummer NEIN Alias für Steuerprozentsatz.
Steuer Nummer NEIN Alias für Steuerprozentsatz.
Mehrwertsteuer Nummer NEIN Alias für Steuerprozentsatz.

Beispiele anfordern

CURL
PYTHON
curl -X POST "https://api.peppox.com/creditnote_line/add/" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{ "creditnote_guid": "cn-8c3b4a99-2025-10-17", "quantity": 2, "unit_code": "H87", "price_amount": 49.99, "item_name": "Returned consulting service", "tax_percent": 21 }"

Antworten

Status: 200 — Gutschriftszeile erfolgreich hinzugefügt.
JSON
{ "ok": true, "line_guid": "line-2b4fa3c1-2025-10-17" }
Status: 400 — Fehlende erforderliche Werte wie creditnote_guid, quantity oder price_amount.
Status: 401 — Ungültiger oder abgelaufener API-Schlüssel.
Status: 500 — Interner Datenbankfehler.
/creditnote_attach_pdf/add • Methoden: POST

Fügen Sie einer Gutschrift eine PDF-Datei bei.

Fügt einem bestehenden Gutschriftsbeleg ein PDF-Dokument per Multipart-Upload, Base64-Payload oder Remote-URL hinzu. Der vorherige Anhang wird ersetzt.
POST /creditnote_attach_pdf/add • Rate: 30 Anfragen/Minute • Authentifizierung erforderlich

Parameter

NameInTypErforderlichStandardBeschreibung
API-Schlüssel Zeichenkette Ja Ihr Peppox-API-Schlüssel.
Gutschrifts-GUID Zeichenkette Ja Die Gutschrift-GUID, an die die PDF-Datei angehängt werden soll.
Rechnungs-GUID Zeichenkette NEIN Alias für creditnote_guid.
Leitfaden Zeichenkette NEIN Alias für creditnote_guid.
doc_id Zeichenkette NEIN Optionale Dokumentkennung. Standardmäßig inv_id oder eine generierte UUID.
Dateiname Zeichenkette NEIN attachment.pdf Name der Anlagedatei.
Mime Zeichenkette NEIN application/pdf MIME-Typ des Anhangs.
content_base64 Zeichenkette NEIN PDF-Inhalt als Base64 kodiert.
pdf_base64 Zeichenkette NEIN Alias für content_base64.
Datei-URL Zeichenkette NEIN HTTP/HTTPS-URL der herunterzuladenden und anzuhängenden PDF-Datei.
pdf_url Zeichenkette NEIN Alias für file_url.
Datei Datei NEIN Mehrteilige hochgeladene Datei.

Beispiele anfordern

CURL
CURL
CURL
curl -X POST "https://api.peppox.com/creditnote_attach_pdf/add/" -H "Authorization: Bearer YOUR_API_KEY" -F "creditnote_guid=cn-8c3b4a99-2025-10-17" -F "file=@creditnote.pdf"

Antworten

Status: 200 — Die PDF-Datei wurde erfolgreich an die Gutschrift angehängt.
JSON
{ "ok": true, "creditnote_guid": "cn-8c3b4a99-2025-10-17", "doc_id": "CN-2025-001", "filename": "creditnote.pdf", "mime": "application/pdf", "size_bytes": 184527 }
Status: 400 — Ungültige Anfrage: Fehlende creditnote_guid, ungültige Base64-Kodierung, ungültige URL oder kein Inhalt angegeben.
Status: 401 — Ungültiger oder abgelaufener API-Schlüssel.
Status: 404 — Gutschrift nicht gefunden.
Status: 500 — Interner Datenbank- oder Dateiverarbeitungsfehler.

Webhooks

Es sind keine Webhooks dokumentiert.

SDKs

Es sind keine SDKs aufgeführt.

Fehlerkatalog

Es wurden keine Fehler definiert.

Änderungsprotokoll

Noch keine Veröffentlichungen.
Generiert aus der Datenbank • Peppox API • Alle Rechte vorbehalten.