API-referentie

Inbox

Documenten die je via Peppol ontving.

Ontvangen documenten oplijstenLink naar deze sectie

GET/api/v1/inbox

Geeft facturen en creditnota's terug die je via Peppol ontving.

Naam	Type	Verplicht	Uitleg
`limit`	integer	nee	1 tot 100, standaard 50
`offset`	integer	nee	Aantal over te slaan, standaard 0
`status`	string	nee	Bv. nieuw of betaald
`van`	date	nee	Vanaf datum (YYYY-MM-DD)
`tot`	date	nee	Tot en met datum

curl https://profactuur.be/api/v1/inbox \
  -H "Authorization: Bearer $PROFACTUUR_KEY"

Toon voorbeeldresponse

{
  "data": [
    {
      "id": "c4d5...",
      "leverancier": "Leverancier BV",
      "factuurnummer": "INV-881",
      "datum": "2026-10-05",
      "bedrag": 242,
      "status": "nieuw"
    }
  ],
  "total": 1
}

Ontvangen document ophalenLink naar deze sectie

GET/api/v1/inbox/{id}

Geeft één ontvangen document met alle gegevens terug.

Naam	Type	Verplicht	Uitleg
`id`	uuid	ja	ID van het document

curl https://profactuur.be/api/v1/inbox/c4d5... \
  -H "Authorization: Bearer $PROFACTUUR_KEY"

Toon voorbeeldresponse

{
  "data": {
    "id": "c4d5...",
    "leverancier": "Leverancier BV",
    "factuurnummer": "INV-881",
    "datum": "2026-10-05",
    "bedrag": 242,
    "status": "nieuw",
    "heeft_pdf": true,
    "heeft_ubl": true
  }
}

PDF van ontvangen documentLink naar deze sectie

GET/api/v1/inbox/{id}/pdf

Geeft de PDF terug die de leverancier meestuurde.

Naam	Type	Verplicht	Uitleg
`id`	uuid	ja	ID van het document

curl https://profactuur.be/api/v1/inbox/c4d5.../pdf \
  -H "Authorization: Bearer $PROFACTUUR_KEY" \
  -o factuur.pdf

Toon voorbeeldresponse

(binair PDF-bestand)

UBL van ontvangen documentLink naar deze sectie

GET/api/v1/inbox/{id}/ubl

Geeft het originele Peppol-XML terug.

Naam	Type	Verplicht	Uitleg
`id`	uuid	ja	ID van het document

curl https://profactuur.be/api/v1/inbox/c4d5.../ubl \
  -H "Authorization: Bearer $PROFACTUUR_KEY" \
  -o factuur.xml

Toon voorbeeldresponse

<Invoice xmlns="urn:oasis:names:specification:ubl:schema:xsd:Invoice-2">...</Invoice>

Testdocument ontvangenLink naar deze sectie

POST/api/v1/test/inbox

Maakt een fictief ontvangen document aan. Werkt enkel met een testsleutel.

Naam	Type	Verplicht	Uitleg
`leverancier`	string	nee	Standaard Testleverancier BV
`factuurnummer`	string	nee	Standaard een willekeurig TEST-nummer
`bedrag`	number	nee	Standaard 121
`datum`	date	nee	Standaard vandaag

curl -X POST https://profactuur.be/api/v1/test/inbox \
  -H "Authorization: Bearer $PROFACTUUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"leverancier":"Drukkerij Janssens","bedrag":242}'

Toon voorbeeldresponse

{
  "data": {
    "id": "5f6a...",
    "leverancier": "Drukkerij Janssens",
    "factuurnummer": "TEST-48213",
    "bedrag": 242,
    "status": "nieuw"
  }
}

VorigeCreditnota's VolgendeFouten en limieten