Peppox API — API Documentation

Authenticatie

Type
APIKEY — API-SLEUTEL
Locatie
vraag / parameter: apikey
Terugval via query/body-parameter "apikey"
GET /sendsms/?apikey=UW_API_SLEUTEL

Factuurbeheer

/factuur/toevoegen • Methoden: NA

Een verkoopfactuurkoptekst toevoegen

Creëert een nieuwe factuurkop met de status CONCEPT. Het eindpunt registreert alle leveranciers- en klantgegevens, uitgiftedata, betalingsvoorwaarden en leveringsdetails. Leveranciersgegevens worden automatisch geladen vanuit uw API-sleutelregistratie (customer_api).
NA /factuur/toevoegen • Tarief: 60 aanvragen/min • Autorisatie vereist

Parameters

NaamInTypeVereistStandaardBeschrijving
apikey snaar Ja Uw Peppox API-sleutel (van uw geregistreerde leveranciersaccount).
netwerk snaar Nee Optionele netwerk-ID (standaard Peppol).
uitnodigings-id snaar Nee Optioneel intern factuurnummer.
uitgiftedatum snaar Ja Datum van factuuruitgifte (JJJJ-MM-DD).
deadline snaar Nee Vervaldatum factuur (JJJJ-MM-DD).
factuur_type_code snaar Nee 380 Peppol factuurtypecode (bijv. 380 = Factuur, 381 = CreditNote).
munteenheid snaar Nee EUR ISO-valutacode.
boekhoudkundige kosten snaar Nee Interne boekhoudcodereferentie.
kopersreferentie snaar Nee Koperreferentie / PO-nummer.
betaling.middel_code snaar Nee 1 Betaalmiddelen (Peppol-codelijst).
betaling.betalings_id snaar Nee Betalingsidentificatie / referentie.
betaling.iban snaar Nee IBAN van de begunstigde.
betalingsaccountnaam snaar Nee Naam van de rekeninghouder van de begunstigde.
betaling.bic snaar Nee BIC/SWIFT-code van de begunstigde.
betalingsvoorwaarden snaar Nee Betalingsvoorwaarden.
leveringsdatum snaar Nee Leverdatum.
leveringslocatieschema snaar Nee 0088 Identificatie van het afleverlocatieschema.
bezorglocatie_id snaar Nee ID van de bezorglocatie.
bezorgstraat snaar Nee Straat van het afleveradres.
bezorgstad snaar Nee Plaats van afleveradres.
bezorging.post snaar Nee Postcode van het afleveradres.
levering.land snaar Nee Landcode van het afleveradres.
bezorgpartijnaam snaar Nee Naam van de bezorger.
klant.eindpuntschema snaar Nee 0208 Peppol-schema-ID van de klant.
klant.eindpunt_id snaar Nee Klant Peppol-deelnemers-ID.
klantnaam snaar Nee Naam van de klant.
klant.straat snaar Nee Klantenstraat.
klant.stad snaar Nee Klantstad.
klant.postal snaar Nee Postcode van de klant.
klant.land snaar Nee Landcode van de klant.
klant.vat_id snaar Nee BTW-nummer van de klant.
klant.bedrijfs_id_schema snaar Nee 0208 Klantbedrijf-ID-schema.
klant.bedrijfs_id snaar Nee Klant-bedrijfs-ID (nationaal nummer).
klant.telefoon snaar Nee Telefoonnummer klantcontact.
klant.e-mailadres snaar Nee E-mailadres voor klantcontact.

Voorbeelden van aanvragen

KRUL
PYTHON
curl -X POST "https://api.peppox.com/factuur/toevoegen/" \ -H "Autorisatie: Drager UW_API_SLEUTEL" \ -H "Inhoudstype: application/json" \ -d "{ "issue_date": "2025-10-17", "due_date": "2025-11-17", "klant": { "endpoint_id": "9915:BE0123456789", "name": "ACME SPRL", "land": "BE" }, "betaling": { "iban": "BE12345678901234", "bic": "GEBABEBB", "account_name": "Peppox Leverancier" } }"

Reacties

Status: 200 — Factuur succesvol aangemaakt (concept).
JSON
{ "ok": true, "invoice_guid": "inv-8c3b4a99-2025-10-17", "status": "CONCEPT" }
Status: 400 — Ongeldige of ontbrekende velden.
Status: 401 — Ongeldige of verlopen API-sleutel.
Status: 500 — Interne server- of databasefout.
/factuurregel/toevoegen • Methoden: NA

Een factuurregel toevoegen aan een bestaande factuur

Voegt een nieuwe regel toe aan een bestaande factuur (geïdentificeerd door invoice_guid). Ondersteunt eenheid, hoeveelheid, prijs, btw-categorie en productidentificatiecodes.
NA /factuurregel/toevoegen • Tarief: 60 aanvragen/min • Autorisatie vereist

Parameters

NaamInTypeVereistStandaardBeschrijving
apikey snaar Ja Uw Peppox API-sleutel (vereist voor authenticatie).
factuur_gids snaar Ja De unieke factuur-GUID die wordt geretourneerd vanuit /invoice/add.
lijn_id snaar Nee Optionele interne lijn-ID (standaard gegenereerde GUID).
hoeveelheid nummer Ja Hoeveelheid van het artikel of de dienst.
eenheidscode snaar Nee Eenheidscode volgens UNECE Rec 20 (bijv. H87 voor “stuk”).
prijs_bedrag nummer Ja Prijs per stuk (exclusief belasting).
artikelbeschrijving snaar Nee Omschrijving van het artikel of de dienst.
item_naam snaar Nee Itemnaam of titel.
verkoper_artikel_id snaar Nee Interne artikel-ID of SKU van de verkoper.
std_item_id_schema snaar Nee 0088 Standaard schema-ID voor itemidentificatie (bijv. GTIN).
standaard_item_id snaar Nee Gestandaardiseerde artikel-ID (GTIN, EAN, enz.).
land van herkomst snaar Nee Land van herkomst (ISO 3166-1 alfa-2).
belastingcategorie snaar Nee BTW-categoriecode (bijv. S, Z, AE).
belastingpercentage nummer Nee BTW-tariefpercentage (bijv. 21,00).

Voorbeelden van aanvragen

KRUL
PYTHON
curl -X POST "https://api.peppox.com/factuurregel/toevoegen/" \ -H "Autorisatie: Drager UW_API_SLEUTEL" \ -H "Inhoudstype: application/json" \ -d "{ "factuur_guid": "inv-8c3b4a99-2025-10-17", "hoeveelheid": 2, "eenheidscode": "H87", "prijs_bedrag": 49,99, "artikelnaam": "Adviesdienst", "belastingpercentage": 21 }"

Reacties

Status: 200 — Factuurregel succesvol toegevoegd.
JSON
{ "ok": waar, "line_guid": "line-2b4fa3c1-2025-10-17" }
Status: 400 — Ongeldige parameters (ontbrekende invoice_guid of ongeldige numerieke velden).
Status: 401 — Ongeldige of verlopen API-sleutel.
Status: 500 — Interne database- of serverfout.
/factuur_bijlage_pdf/toevoegen • Methoden: NA

Voeg een PDF toe aan een bestaande factuur

Voegt een PDF-document (via upload, Base64 of externe URL) toe aan een bestaande factuur, geïdentificeerd door invoice_guid. Er wordt slechts één bijlage per factuur opgeslagen; elk eerder bestand wordt vervangen.
NA /factuur_bijlage_pdf/toevoegen • Tarief: 30 aanvragen/min • Autorisatie vereist

Parameters

NaamInTypeVereistStandaardBeschrijving
apikey snaar Ja Uw Peppox API-sleutel (authenticatie).
factuur_gids snaar Ja De GUID van de factuur waaraan u de PDF wilt toevoegen.
doc_id snaar Nee Optionele document-ID (standaard factuur-ID of een gegenereerde UUID).
bestandsnaam snaar Nee bijlage.pdf Naam van het bijlagebestand (bijv. factuur.pdf).
mime snaar Nee applicatie/pdf MIME-type van het bestand.
inhoud_base64 snaar Nee PDF-inhoud als Base64-string. Accepteert data-URI-formaat.
bestands_url snaar Nee Externe HTTPS-URL van een PDF om te downloaden en bij te voegen.
bestand bestand Nee Bestand uploaden veld (multipart/form-data).

Voorbeelden van aanvragen

KRUL
KRUL
KRUL
curl -X POST "https://api.peppox.com/invoice_attach_pdf/add/" \ -H "Autorisatie: Drager UW_API_SLEUTEL" \ -F "invoice_guid=inv-8c3b4a99-2025-10-17" \ -F "file=@invoice.pdf"

Reacties

Status: 200 — PDF succesvol bijgevoegd bij de factuur.
JSON
{ "ok": true, "invoice_guid": "inv-8c3b4a99-2025-10-17", "doc_id": "DOC-1452", "bestandsnaam": "factuur-2025-10.pdf", "mime": "application/pdf", "size_bytes": 184527 }
Status: 400 — Ongeldige parameters of ontbrekende inhoud (geen Base64, bestand of URL).
Status: 401 — Ongeldige of verlopen API-sleutel.
Status: 404 — Factuur niet gevonden.
Status: 500 — Interne server- of databasefout.

XML-generatie

/xml/genereren • Methoden: NA

Genereer een UBL XML-bestand voor een factuur of creditnota.

Combineert de factuur-/creditnota-header, regels en bijgevoegde PDF (indien aanwezig) tot een Peppol-compatibel UBL 3.0 XML-document. Retourneert het lokale pad naar het gegenereerde bestand en werkt de status van de factuur/creditnota bij naar XML_BUILT.
NA /xml/genereren • Tarief: 30 aanvragen/min • Autorisatie vereist

Parameters

NaamInTypeVereistStandaardBeschrijving
apikey snaar Ja Uw Peppox API-sleutel voor authenticatie.
factuur_gids snaar Ja De unieke identificatie van de factuur die naar XML moet worden geconverteerd.
gids snaar Nee Alternatieve sleutel voor invoice_guid.

Voorbeelden van aanvragen

KRUL
PYTHON
curl -X POST "https://api.peppox.com/xml/generate/" \ -H "Autorisatie: Drager UW_API_SLEUTEL" \ -H "Inhoudstype: application/json" \ -d "{ "invoice_guid": "inv-8c3b4a99-2025-10-17" }"

Reacties

Status: 200 — XML succesvol gegenereerd en opgeslagen op de server.
JSON
{ "ok": true, "status": "XML_BUILT", "xml_path": "/var/www/vhosts/peppox.com/httpdocs/invoices_xml/inv-8c3b4a99-2025-10-17.xml" }
Status: 400 — Ontbrekende invoice_guid of factuurregels.
Status: 401 — Ongeldige of verlopen API-sleutel.
Status: 404 — Factuur niet gevonden.
Status: 500 — Interne XML-generatie- of schrijffout.

Kredietnota's

/creditnote/add • Methoden: NA

Voeg een koptekst voor de creditnota toe.

Hiermee wordt een nieuwe creditnota-header in de status CONCEPT aangemaakt. Leveranciersgegevens worden automatisch geladen vanuit het API-sleutelaccount, terwijl klant-, betalings- en leveringsvelden uit het verzoek worden overgenomen.
NA /creditnote/add • Tarief: 60 aanvragen/min • Autorisatie vereist

Parameters

NaamInTypeVereistStandaardBeschrijving
apikey snaar Ja Uw Peppox API-sleutel.
netwerk snaar Nee Optionele netwerk-ID.
creditnote_id snaar Nee Voorkeursnummer/identificatiecode voor de creditnota.
cn_id snaar Nee Alternatieve alias voor creditnota-ID.
credit_note_id snaar Nee Alternatieve alias voor creditnota-ID.
uitnodigings-id snaar Nee Alternatieve, verouderde identificatiecode.
uitgiftedatum snaar Ja Uitgiftedatum van de creditnota (JJJJ-MM-DD).
deadline snaar Nee Uiterste vervaldatum (JJJJ-MM-DD).
factuur_type_code snaar Nee 381 Documenttypecode. Standaard 381 = Creditnota.
munteenheid snaar Nee EUR ISO-valutacode.
boekhoudkundige kosten snaar Nee Interne boekhoudkundige referentie.
kopersreferentie snaar Nee Referentienummer koper / referentienummer inkooporder klant.
betaling.middel_code snaar Nee 1 Betaling via code.
betaling.betalings_id snaar Nee Betalingskenmerk.
betaling.iban snaar Nee IBAN van de begunstigde.
betalingsaccountnaam snaar Nee Naam van de begunstigde rekening.
betaling.bic snaar Nee BIC-code/SWIFT-code van de begunstigde.
betalingsvoorwaarden snaar Nee Betalingsvoorwaarden.
leveringsdatum snaar Nee Leverdatum.
leveringslocatieschema snaar Nee 0088 Leveringslocatieschema.
bezorglocatie_id snaar Nee Identificatiecode voor de bezorglocatie.
bezorgstraat snaar Nee Bezorgstraat.
bezorgstad snaar Nee Bezorgstad.
bezorging.post snaar Nee Postcode voor bezorging.
levering.land snaar Nee Landcode voor levering.
bezorgpartijnaam snaar Nee Naam van de bezorger.
leverancier.eindpunt_schema snaar Nee 0208 Schema voor leveranciers-eindpunten. Leverancierswaarden worden anders vanuit het API-account geladen.
klant.eindpuntschema snaar Nee 0208 Schema voor klanteindpunten.
klant.eindpunt_id snaar Nee Klant-eindpunt-ID.
klantnaam snaar Nee Wettelijke naam van de klant.
klant.straat snaar Nee Klantenstraat.
klant.stad snaar Nee Klantstad.
klant.postal snaar Nee Postcode van de klant.
klant.land snaar Nee Landcode van de klant.
klant.vat_id snaar Nee BTW-nummer van de klant.
klant.bedrijfs_id_schema snaar Nee 0208 Klantbedrijf-ID-schema.
klant.bedrijfs_id snaar Nee Klantbedrijfs-ID.
klant.telefoon snaar Nee Telefoonnummer van de klant.
klant.e-mailadres snaar Nee E-mailadres van de klant.

Voorbeelden van aanvragen

KRUL
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" } }"

Reacties

Status: 200 — Creditnota succesvol aangemaakt.
JSON
{ "ok": true, "invoice_guid": "cn-8c3b4a99-2025-10-17", "document_type": "CREDIT_NOTE", "status": "DRAFT" }
Status: 400 — Ongeldige of ontbrekende velden.
Status: 401 — Ongeldige of verlopen API-sleutel.
Status: 500 — Interne server- of databasefout.
/creditnote_line/add • Methoden: NA

Voeg een creditnota toe

Voegt een regel toe aan een bestaande creditnota. Accepteert automatisch aliassen voor creditnote_guid en berekent de tax_category op basis van het tax_percent indien mogelijk.
NA /creditnote_line/add • Tarief: 60 aanvragen/min • Autorisatie vereist

Parameters

NaamInTypeVereistStandaardBeschrijving
apikey snaar Ja Uw Peppox API-sleutel.
creditnote_guid snaar Ja De GUID van de betreffende kredietnota.
factuur_gids snaar Nee Alias voor creditnote_guid.
gids snaar Nee Alias voor creditnote_guid.
lijn_id snaar Nee Optionele interne regelidentificatie.
order_line_id snaar Nee Alias voor line_id.
hoeveelheid nummer Ja Aantal regels.
aantal nummer Nee Alias voor hoeveelheid.
Q nummer Nee Alias voor hoeveelheid.
eenheidscode snaar Nee Eenheidscode.
eenheid snaar Nee Alias voor unit_code.
u snaar Nee Alias voor unit_code.
prijs_bedrag nummer Ja Eenheidsprijs.
prijs nummer Nee Alias voor price_amount.
eenheidsprijs nummer Nee Alias voor price_amount.
artikelbeschrijving snaar Nee Lijnomschrijving.
beschrijving snaar Nee Alias voor item_description.
beschrijving snaar Nee Alias voor item_description.
item_naam snaar Nee Artikelnaam/titel.
naam snaar Nee Alias voor item_name.
titel snaar Nee Alias voor item_name.
verkoper_artikel_id snaar Nee Artikelnummer/SKU van de verkoper.
verkoper_id snaar Nee Alias voor seller_item_id.
sku snaar Nee Alias voor seller_item_id.
std_item_id_schema snaar Nee 0088 Standaard identificatieschema voor artikelen.
std_scheme snaar Nee Alias voor std_item_id_scheme.
schema snaar Nee Alias voor std_item_id_scheme.
standaard_item_id snaar Nee Standaard artikel-ID (EAN, GTIN, enz.).
gtin snaar Nee Alias voor std_item_id.
ean snaar Nee Alias voor std_item_id.
land van herkomst snaar Nee Land van herkomst.
land snaar Nee Alias voor origin_country.
belastingcategorie snaar Nee BTW-categoriecode. Wordt automatisch ingesteld op S of Z, afhankelijk van het belastingpercentage.
belasting_kat snaar Nee Alias voor tax_category.
btw_categorie snaar Nee Alias voor tax_category.
belastingpercentage nummer Nee BTW-percentage.
btw_tarief nummer Nee Alias voor belastingpercentage.
belasting nummer Nee Alias voor belastingpercentage.
vat nummer Nee Alias voor belastingpercentage.

Voorbeelden van aanvragen

KRUL
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 }"

Reacties

Status: 200 — Creditnota succesvol toegevoegd.
JSON
{ "ok": waar, "line_guid": "line-2b4fa3c1-2025-10-17" }
Status: 400 — Er ontbreken verplichte waarden zoals creditnote_guid, quantity of price_amount.
Status: 401 — Ongeldige of verlopen API-sleutel.
Status: 500 — Interne databasefout.
/creditnote_attach_pdf/add • Methoden: NA

Voeg een PDF-bestand toe aan een creditnota.

Voegt een PDF-document toe aan een bestaande creditnota met behulp van multipart-upload, Base64-payload of externe URL. De vorige bijlage wordt vervangen.
NA /creditnote_attach_pdf/add • Tarief: 30 aanvragen/min • Autorisatie vereist

Parameters

NaamInTypeVereistStandaardBeschrijving
apikey snaar Ja Uw Peppox API-sleutel.
creditnote_guid snaar Ja De creditnota-GUID waaraan u het PDF-bestand moet koppelen.
factuur_gids snaar Nee Alias voor creditnote_guid.
gids snaar Nee Alias voor creditnote_guid.
doc_id snaar Nee Optionele document-ID. Standaard is dit inv_id of een gegenereerde UUID.
bestandsnaam snaar Nee bijlage.pdf Bestandsnaam van de bijlage.
mime snaar Nee applicatie/pdf Bijlage MIME-type.
inhoud_base64 snaar Nee PDF-inhoud gecodeerd als Base64.
pdf_base64 snaar Nee Alias voor content_base64.
bestands_url snaar Nee HTTP/HTTPS-URL van het PDF-bestand dat u wilt downloaden en bijvoegen.
pdf_url snaar Nee Alias voor file_url.
bestand bestand Nee Geüploade bestand bestaande uit meerdere delen.

Voorbeelden van aanvragen

KRUL
KRUL
KRUL
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"

Reacties

Status: 200 — Het PDF-bestand is succesvol aan de creditnota gekoppeld.
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 — Ongeldig verzoek: creditnote_guid ontbreekt, ongeldige Base64-codering, ongeldige URL of geen inhoud opgegeven.
Status: 401 — Ongeldige of verlopen API-sleutel.
Status: 404 — Creditnota niet gevonden.
Status: 500 — Interne database- of bestandsverwerkingsfout.

Webhooks

Er zijn geen webhooks gedocumenteerd.

SDK's

Geen SDK's vermeld.

Foutencatalogus

Er zijn geen fouten gedefinieerd.

Wijzigingslogboek

Nog geen releases.
Gegenereerd vanuit database • Peppox API • Alle rechten voorbehouden.