API – Documentation

Authenticatie

Type

APIKEY — API-SLEUTEL

Locatie

vraag / parameter: apikey

Terugval via query/body-parameter "apikey"

GET https://api.peppox.com//sendsms/?apikey=YOUR_API_KEY

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

Naam	Type	Vereist	Standaard	Beschrijving
`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

Naam	Type	Vereist	Standaard	Beschrijving
`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

Naam	Type	Vereist	Standaard	Beschrijving
`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

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"

curl -X POST "https://api.peppox.com/invoice_attach_pdf/add/" \ -H "Autorisatie: Drager UW_API_SLEUTEL" \ -H "Inhoudstype: application/json" \ -d "{ "invoice_guid": "inv-8c3b4a99-2025-10-17", "bestandsnaam": "factuur.pdf", "content_base64": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlIC9QYWdl..." }"

curl -X POST "https://api.peppox.com/factuur_bijlage_pdf/toevoegen/" \ -H "Autorisatie: Drager UW_API_SLEUTEL" \ -H "Inhoudstype: application/json" \ -d "{ "factuur_guid": "inv-8c3b4a99-2025-10-17", "file_url": "https://example.com/factuur-2025.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

Naam	Type	Vereist	Beschrijving
`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

Naam	Type	Vereist	Standaard	Beschrijving
`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

Naam	Type	Vereist	Standaard	Beschrijving
`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

Naam	Type	Vereist	Standaard	Beschrijving
`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

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"

curl -X POST "https://api.peppox.com/creditnote_attach_pdf/add/" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{ "creditnote_guid": "cn-8c3b4a99-2025-10-17", "filename": "creditnote.pdf", "content_base64": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlIC9QYWdl..." }"

curl -X POST "https://api.peppox.com/creditnote_attach_pdf/add/" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{ "creditnote_guid": "cn-8c3b4a99-2025-10-17", "file_url": "https://example.com/creditnote-2025.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.

Verzonden documenten

/doc-sent/header/list • Methoden: KRIJGEN

Lijst met verzonden factuurheaders

Toont een lijst met verzonden factuurheaders voor een leverancier. Ondersteunt zoeken op trefwoorden, datumfilters, Peppol-statusfilters, lokale statusfilters, het opnemen van onbewerkte antwoorden, sorteren en paginering.

KRIJGEN /doc-sent/header/list • Tarief: 300 req/min

Parameters

Naam	Type	Vereist	Standaard	Beschrijving
`leverancier_id`	snaar	Ja		Vereiste leveranciersidentificatie. Deze waarde komt overeen met invoices.apikey.
`Q`	snaar	Nee		Zoeken op trefwoorden in de koptekstvelden van facturen.
`pagina`	geheel getal	Nee	1	Paginanummer.
`per_pagina`	geheel getal	Nee	300	Aantal rijen per pagina. Maximum: 300.
`datum`	snaar	Nee		Filteren op exacte datum in JJJJ-MM-DD-formaat.
`datum_van`	snaar	Nee		Begindatum voor periodefilter in JJJJ-MM-DD-formaat.
`datum_tot`	snaar	Nee		Einddatum voor periodefilter in JJJJ-MM-DD-formaat.
`datum_veld`	snaar	Nee	verzonden_op	Datumveld gebruikt voor datum/datum_van/datum_tot. Toegestaan: issue_date, due_date, delivery_date, xml_built_at, sent_at, created_at, updated_at, status_from_peppol_date.
`status_from_peppol`	snaar	Nee		Filteren op Peppol-status. Ondersteunt CSV-waarden.
`peppol_status`	snaar	Nee		Alias voor status_from_peppol.
`status`	snaar	Nee		Alias voor status_from_peppol.
`lokale_status`	snaar	Nee		Filteren op lokale factuurstatus uit invoices.status. Ondersteunt CSV-waarden.
`include_raw`	booleaans	Nee	0	Stel deze waarde in op 1 om sent_reply_api en all_response_api in het antwoord op te nemen.
`zoek_ruw`	booleaans	Nee	0	Stel deze waarde in op 1 om sent_reply_api en all_response_api mee te nemen in de zoekopdracht op trefwoorden.
`sorteren_op`	snaar	Nee	verzonden_op	Sorteerkolom. Toegestane kolommen: id, invoice_guid, inv_id, issue_date, due_date, xml_built_at, sent_at, status, created_at, updated_at, status_from_peppol, status_from_peppol_date, c_name, s_name, currency, network.
`sorteermap`	snaar	Nee	DESC	Sorteerrichting: oplopend of aflopend.

Voorbeelden van aanvragen

KRUL

PYTHON

curl "https://api.peppox.com/doc-sent/header/list/?supplier_id=YOUR_SUPPLIER_ID"

curl "https://api.peppox.com/doc-sent/header/list/?supplier_id=YOUR_SUPPLIER_ID&date_from=2025-10-01&date_to=2025-10-31&date_field=sent_at&status_from_peppol=sent&page=1&per_page=100"

curl "https://api.peppox.com/doc-sent/header/list/?supplier_id=YOUR_SUPPLIER_ID&q=INV-2025&include_raw=1&search_raw=1"

import requests url = "https://api.peppox.com/doc-sent/header/list/" params = { "supplier_id": "YOUR_SUPPLIER_ID", "date_from": "2025-10-01", "date_to": "2025-10-31", "date_field": "sent_at", "status_from_peppol": "sent", "page": 1, "per_page": 100 } r = requests.get(url, params=params) print(r.json())

Reacties

Status: 200 — Succes — retourneert factuurheaders met filters, sorteerinformatie, paginering en gegevensrijen.

JSON

{ "ok": true, "endpoint": "doc-sent/header/list", "method": "GET", "filters": { "supplier_id": "YOUR_SUPPLIER_ID", "q": "", "date": "", "date_from": "2025-10-01", "date_to": "2025-10-31", "date_field": "sent_at", "status_from_peppol": "sent", "local_status": "", "include_raw": "0", "search_raw": "0" }, "sort": { "sort_by": "sent_at", "sort_dir": "DESC" }, "pagination": { "page": 1, "per_page": 300, "total": 1, "total_pages": 1, "has_prev": false, "has_next": false }, "count": 1, "data": [ { "id": 125, "invoice_guid": "inv-8c3b4a99-2025-10-17", "inv_id": "INV-2025-001", "issue_date": "2025-10-17", "due_date": "2025-11-17", "invoice_type_code": "380", "currency": "EUR", "buyer_reference": "PO-12345", "s_name": "Supplier Company", "s_endpoint_id": "0208:0123456789", "c_name": "Customer Company", "c_endpoint_id": "0208:0987654321", "status": "SENT", "sent_at": "2025-10-17 14:30:00", "sent_http_code": 200, "network": "peppol", "status_from_peppol": "sent", "status_from_peppol_date": "2025-10-17 14:31:00", "status_from_peppol_error": null, "flowin_invoice_id_from_sent_reply_api": "flowin-doc-id-123", "flowin_document_endpoint_used": "/peppol/suppliers/.../invoices" } ] }

Status: 400 — Het vereiste supplier_id ontbreekt.

Status: 500 — Serverfout.

/doc-sent/lines/list • Methoden: KRIJGEN

Lijst met verzonden factuurregels

Geeft een overzicht van de regels van een verzonden factuur aan de hand van supplier_id en invoice_guid. De supplier_id moet overeenkomen met invoices.apikey voor de beveiliging.

KRIJGEN /doc-sent/lines/list • Tarief: 300 req/min

Parameters

Naam	In	Type	Vereist	Standaard	Beschrijving
`leverancier_id`	vraag	snaar	Ja		Vereiste leveranciersidentificatie. Deze waarde moet overeenkomen met invoices.apikey.
`factuur_gids`	vraag	snaar	Ja		Factuur-GUID gebruikt om factuurregels weer te geven.
`Q`	vraag	snaar	Nee		Optioneel zoeken op trefwoorden in alle velden van de factuurregel.
`pagina`	vraag	geheel getal	Nee	1	Paginanummer.
`per_pagina`	vraag	geheel getal	Nee	300	Aantal rijen per pagina. Maximum: 300.

Voorbeelden van aanvragen

KRUL

PYTHON

curl "https://api.peppox.com/doc-sent/lines/list/?supplier_id=YOUR_SUPPLIER_ID&invoice_guid=inv-8c3b4a99-2025-10-17"

curl "https://api.peppox.com/doc-sent/lines/list/?supplier_id=YOUR_SUPPLIER_ID&invoice_guid=inv-8c3b4a99-2025-10-17&q=consulting&page=1&per_page=100"

import requests url = "https://api.peppox.com/doc-sent/lines/list/" params = { "supplier_id": "YOUR_SUPPLIER_ID", "invoice_guid": "inv-8c3b4a99-2025-10-17", "q": "consulting", "page": 1, "per_page": 100 } r = requests.get(url, params=params) print(r.json())

Reacties

Status: 200 — Succes — retourneert factuurmetadata, filters, paginering en factuurregels.

JSON

{ "ok": true, "endpoint": "doc-send/lines/list", "invoice": { "invoice_guid": "inv-8c3b4a99-2025-10-17", "inv_id": "INV-2025-001", "status": "VERZONDEN", "sent_at": "2025-10-17 14:30:00" }, "filters": { "supplier_id": "UW_LEVERANCIER_ID", "invoice_guid": "inv-8c3b4a99-2025-10-17", "q": "consulting" }, "pagination": { "page": 1, "per_page": 300, "total": 1, "total_pages": 1, "has_prev": false, "has_next": false }, "count": 1, "data": [ { "id": 1, "invoice_guid": "inv-8c3b4a99-2025-10-17", "line_guid": "line-001", "line_id": "1", "quantity": "2.00", "unit_code": "H87", "price_amount": "49.99", "item_description": "Consulting service", "item_name": "Consulting", "seller_item_id": "SKU-001", "std_item_id_scheme": "0088", "std_item_id": null, "origin_country": "BE", "tax_category": "S", "tax_percent": "21.00", "created_at": "2025-10-17 14:00:00", "updated_at": null } ] }

Status: 400 — De vereiste supplier_id of invoice_guid ontbreekt.

Status: 404 — Factuur niet gevonden of niet toegestaan voor deze leveranciers-ID.

Status: 500 — Serverfout.

Ontvangen documenten

/doc-received/header/list • Methoden: KRIJGEN

Lijst met kopteksten van ontvangen inkoopfacturen

Toont de kopteksten van inkoopfacturen die een leverancier via Peppol heeft ontvangen. Ondersteunt zoeken op trefwoorden, datumfilters, importstatus, documenttypecode, onbewerkte velden, sorteren en paginering.

KRIJGEN /doc-received/header/list • Tarief: 300 req/min

Parameters

Naam	Type	Vereist	Standaard	Beschrijving
`leverancier_id`	snaar	Ja		Vereiste leveranciersidentificatie. Deze waarde komt overeen met peppox_inbound_purchase_invoices.supplier_id.
`Q`	snaar	Nee		Zoeken op trefwoorden in de koptekstvelden van ontvangen facturen.
`pagina`	geheel getal	Nee	1	Paginanummer.
`per_pagina`	geheel getal	Nee	300	Aantal rijen per pagina. Maximum: 300.
`datum`	snaar	Nee		Filteren op exacte datum in JJJJ-MM-DD-formaat.
`datum_van`	snaar	Nee		Begindatum voor periodefilter in JJJJ-MM-DD-formaat.
`datum_tot`	snaar	Nee		Einddatum voor periodefilter in JJJJ-MM-DD-formaat.
`datum_veld`	snaar	Nee	api_created_at	Datumveld gebruikt voor datum/datum_van/datum_tot. Toegestaan: api_created_at, issue_date, due_date, tax_point_date, created_at, updated_at.
`import_status`	snaar	Nee		Filteren op importstatus. Ondersteunt CSV-waarden.
`status`	snaar	Nee		Alias voor import_status.
`document_type_code`	snaar	Nee		Filteren op documenttypecode. Ondersteunt CSV-waarden. Voorbeeld: 380 factuur, 381 creditnota.
`type_code`	snaar	Nee		Alias voor document_type_code.
`include_raw`	booleaans	Nee	0	Stel in op 1 om customization_id, profile_id, xml_without_pdf, api_attributes_json, parser_json en notification_sent_by_email_response mee te nemen.
`zoek_ruw`	booleaans	Nee	0	Stel de waarde in op 1 om te zoeken binnen onbewerkte/lange velden.
`sorteren_op`	snaar	Nee	api_created_at	Sorteerkolom. Toegestaan: id, customer_id, supplier_id, flowin_document_id, api_created_at, document_type_code, document_number, issue_date, due_date, tax_point_date, currency, supplier_name, customer_name, total_excl_vat, total_vat, total_incl_vat, payable_amount, import_status, created_at, updated_at.
`sorteermap`	snaar	Nee	DESC	Sorteerrichting: oplopend of aflopend.

Voorbeelden van aanvragen

KRUL

PYTHON

curl "https://api.peppox.com/doc-received/header/list/?supplier_id=327c58aa-f3e1-4c56-ae75-327c58916148"

curl "https://api.peppox.com/doc-received/header/list/?supplier_id=327c58aa-4c56-ae75-327c58916148&date_from=2025-10-01&date_to=2025-10-31&date_field=api_created_at&document_type_code=380&page=1&per_page=100"

curl "https://api.peppox.com/doc-received/header/list/?supplier_id=327c58aa-f3e1-4c56-ae75-327c58916148&q=INV-2025&include_raw=1&search_raw=1"

import requests url = "https://api.peppox.com/doc-received/header/list/" params = { "supplier_id": "327c58aa-f3e1-4c56-ae75-327c58916148", "date_from": "2025-10-01", "date_to": "2025-10-31", "document_type_code": "380", "page": 1, "per_page": 100 } r = requests.get(url, params=params) print(r.json())

Reacties

Status: 200 — Succes — retourneert de kopteksten van de ontvangen inkoopfacturen met filters, sortering, paginering en gegevensrijen.

JSON

{ "ok": true, "endpoint": "doc-received/header/list", "method": "GET", "filters": { "supplier_id": 327c58aa-f3e1-4c56-ae75-327c58916148", "q": "", "date": "", "date_from": "2025-10-01", "date_to": "2025-10-31", "date_field": "api_created_at", "import_status": "imported", "document_type_code": "380", "include_raw": "0", "search_raw": "0" }, "sort": { "sort_by": "api_created_at", "sort_dir": "DESC" }, "pagination": { "page": 1, "per_page": 300, "total": 1, "total_pages": 1, "has_prev": false, "has_next": false }, "count": 1, "data": [ { "id": 25, "customer_id": 7, "supplier_id": 327c58aa-f3e1-4c56-ae75-327c58916148", "document_id": "flowin-doc-id-123", "environment": "production", "api_created_at": "2025-10-17 14:30:00", "document_type_label": "Factuur", "document_type_code": "380", "document_number": "INV-2025-001", "issue_date": "2025-10-17", "vervaldatum": "2025-11-17", "belastingdatum": "2025-10-17", "valuta": "EUR", "kopersreferentie": "PO-12345", "orderreferentie": "ORD-987", "leveranciersnaam": "Leveranciersbedrijf", "leveranciersbedrijfs-ID": "0123456789", "leverancierseindpunt-ID": "0208:0123456789", "leveranciers-btw-ID": "BE0123456789", "leveranciersstraat": "Leveranciersstraat 1", "leveranciersstad": "Brussel", "leverancierspostcode": "1000", "leveranciersland": "BE", "customer_name": "Customer Company", "customer_company_id": "0987654321", "customer_endpoint_id": "0208:0987654321", "customer_vat_id": "BE0987654321", "customer_street": "Customer Street 2", "customer_city": "Namur", "customer_zip": "5000", "customer_country": "BE", "total_excl_vat": "100.00", "total_vat": "21.00", "total_incl_vat": "121.00", "payable_amount": "121.00", "line_extension_amount": "100.00", "tax_exclusive_amount": "100.00", "tax_inclusive_amount": "121.00", "allowance_total_amount": "0.00", "charge_total_amount": "0.00", "prepaid_amount": "0.00", "payment_means_code": "30", "payment_id": "INV-2025-001", "iban": "BE12345678901234", "bic": "GEBABEBB", "has_embedded_pdf": 1, "created_at": "2025-10-17 14:31:00" } ] }

Status: 400 — Het vereiste supplier_id ontbreekt.

Status: 500 — Serverfout.

/doc-received/lines/list • Methoden: KRIJGEN

Lijst met ontvangen inkoopfactuurregels

Geeft een overzicht van de regels van een ontvangen inkoopfactuur aan de hand van supplier_id en document_id. De document_id komt overeen met peppox_inbound_purchase_invoices.flowin_document_id.

KRIJGEN /doc-received/lines/list • Tarief: 300 req/min

Parameters

Naam	Type	Vereist	Standaard	Beschrijving
`leverancier_id`	snaar	Ja		Vereiste leveranciersidentificatie.
`document_id`	snaar	Ja		Vereist ID van ontvangen document. Komt overeen met flowin_document_id.
`Q`	snaar	Nee		Zoeken op trefwoorden in de velden van de ontvangen factuurregels.
`pagina`	geheel getal	Nee	1	Paginanummer.
`per_pagina`	geheel getal	Nee	300	Aantal rijen per pagina. Maximum: 300.
`include_raw`	booleaans	Nee	0	Stel deze waarde in op 1 om raw_line_xml en parser_json mee te nemen.
`zoek_ruw`	booleaans	Nee	0	Stel deze waarde in op 1 om te zoeken in raw_line_xml en parser_json.
`sorteren_op`	snaar	Nee	regelnummer	Sorteerkolom. Toegestane waarden: id, invoice_header_id, customer_id, supplier_id, flowin_document_id, line_no, line_id, item_name, quantity, unit_code, unit_price, vat_rate, line_total_excl_vat, line_total_vat, line_total_incl_vat, currency, created_at.
`sorteermap`	snaar	Nee	ASC	Sorteerrichting: oplopend of aflopend.

Voorbeelden van aanvragen

KRUL

PYTHON

curl "https://api.peppox.com/doc-received/lines/list/?supplier_id=327c58aa-f3e1-4c56-ae75-327c58916148&document_id=e1de8615-ce41-425a-ba88-0b834bf3ccf9"

curl "https://api.peppox.com/doc-received/lines/list/?supplier_id=327c58aa-f3e1-4c56-ae75-327c58916148&document_id=e1de8615-ce41-425a-ba88-0b834bf3ccf9&q=consulting&page=1&per_page=100"

curl "https://api.peppox.com/doc-received/lines/list/?supplier_id=327c58aa-4c56-ae75-327c58916148&document_id=e1de8615-ce41-425a-ba88-0b834bf3ccf9&include_raw=1&search_raw=1"

import requests url = "https://api.peppox.com/doc-received/lines/list/" params = { "supplier_id": "327c58aa-f3e1-4c56-ae75-327c58916148", "document_id": "e1de8615-ce41-425a-ba88-0b834bf3ccf9", "q": "consulting", "page": 1, "per_page": 100 } r = requests.get(url, params=params) print(r.json())

Reacties

Status: 200 — Succes — retourneert ontvangen factuurmetadata, filters, sortering, paginering en regelnummers.

JSON

{ "ok": true, "endpoint": "doc-received/lines/list", "method": "GET", "invoice": { "id": 25, "customer_id": 7, "supplier_id": 327c58aa-f3e1-4c56-ae75-327c58916148", "document_id": "e1de8615-ce41-425a-ba88-0b834bf3ccf9", "document_number": "INV-2025-001", "document_type_code": "380", "document_type_label": "Factuur", "issue_date": "2025-10-17", "due_date": "2025-11-17", "currency": "EUR", "supplier_name": "Supplier "Company", "customer_name": "Customer Company", "total_excl_vat": "100.00", "total_vat": "21.00", "total_incl_vat": "121.00", "payable_amount": "121.00", "import_status": "imported", "api_created_at": "2025-10-17 14:30:00" }, "filters": { "supplier_id": 327c58aa-f3e1-4c56-ae75-327c58916148", "document_id": "e1de8615-ce41-425a-ba88-0b834bf3ccf9", "q": "", "include_raw": "0", "search_raw": "0" }, "sort": { "sort_by": "line_no", "sort_dir": "ASC" }, "pagination": { "page": 1, "per_page": 300, "total": 1, "total_pages": 1, "has_prev": false, "has_next": false }, "count": 1, "data": [ { "supplier_id": 327c58aa-f3e1-4c56-ae75-327c58916148", "document_id": "e1de8615-ce41-425a-ba88-0b834bf3ccf9", "line_id": "1", "description": "Consulting service", "item_name": "Consulting", "item_seller_id": "SKU-001", "item_buyer_id": null, "quantity": "2.00", "unit_code": "H87", "unit_price": "50.00", "base_quantity": "1.00", "vat_category_id": "S", "vat_rate": "21.00", "vat_scheme": "VAT", "line_total_excl_vat": "100.00", "line_total_vat": "21.00", "line_total_incl_vat": "121.00", "currency": "EUR", "created_at": "2025-10-17 14:31:00" } ] }

Status: 400 — Ontbrekende vereiste supplier_id of document_id.

Status: 404 — Ontvangen factuur niet gevonden of niet toegestaan voor deze leveranciers-ID/document-ID.

Status: 500 — Serverfout.

PDF naar Peppol

/pdf2peppol/add • Methoden: NA

Upload een PDF voor Peppol-conversie.

Ontvangt een PDF-document via bestandsupload, base64 of URL. Peppox slaat het op in de PDF naar Peppol-wachtrij en start het conversieproces. Het document wordt niet direct naar Peppol verzonden: het moet eerst worden verwerkt, gecontroleerd, bevestigd en pas daarna verzonden.

NA /pdf2peppol/add • Tarief: Standaard 50 PDF's per maand

Parameters

Naam	In	Type	Vereist	Standaard	Beschrijving
`leverancier_id`		snaar	Ja		Leveranciersidentificatie. Alias toegestaan: apikey of api_key.
`pdf_url`		snaar	Nee		Openbare URL van het te importeren PDF-bestand. Alias: file_url, document_url, url.
`pdf_base64`	lichaam	snaar	Nee		PDF-inhoud gecodeerd in base64. Aliassen: content_base64, file_base64, document_base64, base64.
`pdf`		bestand	Nee		Uploaden van PDF-bestanden. Geaccepteerde veldnamen: pdf, file, invoice_pdf, document, pdf_file.
`bestandsnaam`		snaar	Nee	document.pdf	Oorspronkelijke bestandsnaam. Wordt gebruikt bij het verzenden van base64 of URL.
`netwerk`		snaar	Nee	productie	Peppol-netwerk. Toegestaan: productie of integratie. Alias: net_work, environment.
`document_type_code`		snaar	Nee	380	Documenttype. 380 = verkoopfactuur, 381 = creditnota. Aliassen: invoice_type_code, document_type, type.

Voorbeelden van aanvragen

KRUL

curl "https://api.peppox.com/pdf2peppol/add/?supplier_id=de5c7119-0f03-4058-9d3b-9f9520c2a46e&pdf_url=https://peppox.com/invoice2.pdf"

curl -X POST "https://api.peppox.com/pdf2peppol/add/" -F "supplier_id=de5c7119-0f03-4058-9d3b-9f9520c2a46e" -F "pdf=@invoice.pdf"

curl -X POST "https://api.peppox.com/pdf2peppol/add/" -H "Content-Type: application/json" -d "{"supplier_idde5c7119-0f03-4058-9d3b-9f9520c2a46epdf_base64JVBERi0xLjQ...filenameinvoice.pdf"}"

Reacties

Status: 200 — Het PDF-bestand is geaccepteerd en toegevoegd aan de conversiewachtrij.

JSON

{ "success": true, "message": "PDF-document ontvangen. Het wacht nu op verwerking.", "queue_guid": "pdf-6e9466501393cfbb32b1ec80498a1dfa", "status": "pending", "from_api": 1, "supplier_id": "de5c569-0f03-4248-9dae-9f9520c2a477e", "queue_customer_id": 12, "document_type_code": "380", "document_type_label": "Verkoopfactuur", "network": "production", "pdf_source": "url", "filename": "invoice2.pdf", "monthly_limit": { "limit": 50, "used": 4, "remaining_before_upload": 46 } }

Status: 400 — Ongeldig verzoek, ongeldige leverancier, ongeldig PDF-bestand, bestand te groot of maandelijkse limiet bereikt.

/pdf2peppol/check • Methoden: KRIJGEN

Controleer de conversie van PDF naar Peppol.

Geeft de conversiestatus, geëxtraheerde headergegevens, geëxtraheerde regels, PDF-link en Peppol-gereedheidscontroles terug voor een in de wachtrij geplaatst PDF-document.

KRIJGEN /pdf2peppol/check • Tarief: 300 req/min

Parameters

Naam	In	Type	Vereist	Standaard	Beschrijving
`leverancier_id`		snaar	Ja		Leveranciersidentificatie. Alias toegestaan: apikey of api_key.
`wachtrij_guid`		snaar	Ja		Wachtrij-GUID geretourneerd door /pdf2peppol/add. Alias: guid.
`download_pdf`	vraag	booleaans	Nee	0	Indien ingesteld op 1, wordt het originele PDF-bestand in plaats van JSON geretourneerd.

Voorbeelden van aanvragen

KRUL

curl "https://api.peppox.com/pdf2peppol/check/?supplier_id=de5c7119-0f03-4058-9d3b-9f9520c2a46e&queue_guid=pdf-6e9466501393cfbb32b1ec80498a1dfa"

Reacties

Status: 200 — Conversie succesvol geladen.

JSON

{ "success": true, "message": "PDF naar Peppol-conversie succesvol geladen.", "queue": { "queue_guid": "pdf-6e9466501393cfbb32b1ec80498a1dfa", "supplier_id": "de5c569-0f03-4248-9dae-9f9520c2a477e", "document_type_code": "380", "document_type_label": "Verkoopfactuur", "network": "production", "filename": "invoice.pdf", "pdf_url": "https://api.peppox.com/pdf2peppol/check/?download_pdf=1&supplier_id=de5c569-0f03-4248-9dae-9f9520c2a477e&queue_guid=pdf-6e9466501393cfbb32b1ec80498a1dfa", "processing": { "status": "parsed", "is_waiting": false, "is_finished": true, "has_error": false }, "verification": { "confirmed": false, "confirmed_at": "" }, "peppol_send": { "status": "blocked", "requested_at": "", "completed_at": "", "peppox_invoice_guid": "", "error": "" } }, "peppol_readiness": { "ready_for_peppol": true, "can_be_verified": true, "verification_confirmed": false, "can_be_sent_now": false, "send_block_reason": "Het document moet worden geverifieerd voordat het kan worden verzonden." } }, "converted_data": { "header": { "document": { "document_number": "INV-2025-001", "document_date": "2025-10-17", "document_type_code": "380", "document_type_label": "Verkoopfactuur", "currency": "EUR", "peppol_ready": true }, "buyer": { "name": "Customer Company", "company_number": "0123456789", "country": "BE" }, "totals": { "total_excl_vat": "100.00", "total_vat": "21.00", "total_incl_vat": "121.00" } }, "lines_count": 1, "lines": [ { "line_no": 1, "description": "Consulting service", "quantity": "1", "unit_price": "100.00", "vat_rate": "21" } ] } }

Status: 400 — Ongeldige supplier_id, queue_guid of conversie niet gevonden.

/pdf2peppol/confirm • Methoden: NA

Bevestig de geconverteerde PDF-informatie.

Bevestigt dat de geëxtraheerde factuur- of creditnota-informatie correct is. Deze bevestiging is vereist voordat het document naar Peppol kan worden verzonden.

NA /pdf2peppol/confirm • Tarief: 300 req/min

Parameters

Naam	Type	Vereist	Standaard	Beschrijving
`leverancier_id`	snaar	Ja		Leveranciersidentificatie. Alias toegestaan: apikey of api_key.
`wachtrij_guid`	snaar	Ja		Wachtrij-GUID geretourneerd door /pdf2peppol/add. Alias: guid.
`bevestigd`	booleaans	Nee	1	Optionele bevestigingsvlag. Het eindpunt bevestigt het document als alle vereiste Peppol-velden beschikbaar zijn.

Voorbeelden van aanvragen

KRUL

curl "https://api.peppox.com/pdf2peppol/confirm/?supplier_id=ed751d5a-661e-4f6e-9d74-2d7447be4a9d&queue_guid=pdf-6e9466501393cfbb32b1ec80498a1dfa"

Reacties

Status: 200 — Documentverificatie bevestigd en klaar voor verzending.

JSON

{ "success": true, "message": "Documentverificatie bevestigd. Het document is klaar om naar Peppol te worden verzonden.", "supplier_id": "ed751d5a-661e-4f6e-9d74-2d7447be4a9d", "queue_guid": "pdf-6e9466501393cfbb32b1ec80498a1dfa", "document_type_code": "380", "document_type_label": "Verkoopfactuur", "verification_confirmed": true, "verification_confirmed_at": "2025-10-17 15:10:00", "send_status": "ready", "ready_for_peppol": true, "checks": { "document_number": true, "document_date": true, "buyer_name": true, "koper_identificatie": true, "koper_straat": true, "koper_stad": true, "koper_postcode": true, "koper_land": true, "documentregels": true }, "ontbrekende_velden": [] }

Status: 400 — Het document kan niet worden bevestigd omdat er gegevens ontbreken of de conversie nog niet gereed is.

/pdf2peppol/send • Methoden: NA

Stuur het bevestigde PDF-document naar Peppol.

Verstuurt een bevestigde PDF naar Peppol. Peppol maakt de factuur of creditnota aan, voegt regels toe, voegt de originele PDF toe, genereert de Peppol XML en start de verzendworkflow. Belangrijk: na het aanroepen van dit eindpunt kan het enkele minuten duren, omdat verschillende interne processen het document voltooien en valideren voordat het definitief naar Peppol wordt verzonden.

NA /pdf2peppol/send • Tarief: 300 req/min

Parameters

Naam	In	Type	Vereist	Standaard	Beschrijving
`leverancier_id`		snaar	Ja		Leveranciersidentificatie. Alias toegestaan: apikey of api_key.
`wachtrij_guid`		snaar	Ja		Wachtrij-GUID geretourneerd door /pdf2peppol/add. Alias: guid.

Voorbeelden van aanvragen

KRUL

curl "https://api.peppox.com/pdf2peppol/send/?supplier_id=ed751d5a-661e-4f6e-9d74-2d7447be4a9d&queue_guid=pdf-6e9466501393cfbb32b1ec80498a1dfa"

Reacties

Status: 200 — Document verzonden of reeds verzonden. De definitieve leveringsstatus van Peppol kan enkele minuten duren, omdat de interne verwerking na het verzoek nog doorgaat.

JSON

{ "success": true, "message": "Verkoopfactuur succesvol naar Peppol verzonden.", "supplier_id": "ed751d5a-661e-4f6e-9d74-2d7447be4a9d", "queue_guid": "pdf-6e9466501393cfbb32b1ec80498a1dfa", "peppox_document_guid": "0e8b3c9d-1111-4444-9999-aabbccddeeff", "document_type_code": "380", "document_type_label": "Verkoopfactuur", "network": "production", "send_status": "sent", "payment_reference": "INV-2025-001", "buyer": { "name": "Customer Company", "vat_id": "BE0123456789", "company_id": "0123456789", "street": "Customer Street 1", "city": "Brussel", "postal": "1000", "country": "BE", "phone": "+32123456789", "email": "customer@example.com" }, "steps": { "document_create": "ok", "document_lines": "ok", "pdf_attachment": "ok", "xml_generate": "ok" }, "peppox_responses": { "invoice_add": { "ok": true, "invoice_guid": "0e8b3c9d-1111-4444-9999-aabbccddeeff", "status": "DRAFT" }, "xml_generate": { "ok": true, "status": "XML_BUILT", "xml_path": "created" } } }

Status: 400 — Het document kan niet worden verzonden. Het is mogelijk dat het niet is geparseerd, niet is bevestigd, al wordt verzonden, gegevens ontbreken of dat de Peppox API een foutmelding heeft gegeven.

Status: 405 — Methode niet toegestaan.

Webhooks

Er zijn geen webhooks gedocumenteerd.

SDK's

Geen SDK's vermeld.

Foutencatalogus

Er zijn geen fouten gedefinieerd.

Wijzigingslogboek

Nog geen releases.