API-referentie

Facturen

Facturen aanmaken, definitief maken, versturen en downloaden.

Facturen oplijstenLink naar deze sectie

GET/api/v1/facturen

Geeft facturen en creditnota's terug, nieuwste eerst.

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

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

Toon voorbeeldresponse

{
  "data": [
    {
      "id": "9a2b...",
      "type": "factuur",
      "nummer": "2026-0042",
      "status": "verzonden",
      "datum": "2026-10-10",
      "totaal_incl": 726
    }
  ],
  "total": 1
}

Factuur ophalenLink naar deze sectie

GET/api/v1/facturen/{id}

Geeft één factuur met regels terug.

Naam	Type	Verplicht	Uitleg
`id`	uuid	ja	ID van de factuur

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

Toon voorbeeldresponse

{
  "data": {
    "id": "9a2b...",
    "type": "factuur",
    "nummer": "2026-0042",
    "status": "verzonden",
    "datum": "2026-10-10",
    "totaal_incl": 726,
    "vervaldatum": "2026-11-09",
    "customer_id": "6f1c...",
    "ogm": "+++123/4567/89012+++",
    "totaal_excl": 600,
    "totaal_btw": 126,
    "regels": [
      {
        "omschrijving": "Webdesign",
        "aantal": 8,
        "eenheidsprijs": 75,
        "btw_percentage": 21,
        "totaal": 600
      }
    ]
  }
}

Conceptfactuur aanmakenLink naar deze sectie

POST/api/v1/facturen

Maakt een factuur in concept. De vervaldatum volgt je standaard betaaltermijn.

Naam	Type	Verplicht	Uitleg
`klant_id`	uuid	ja	Klant van het document
`regels`	array	ja	Minstens één regel: omschrijving, aantal, eenheidsprijs, btw_percentage, of een product_id
`datum`	date	nee	Standaard vandaag
`notities`	string	nee	Vrije tekst onderaan het document

curl -X POST https://profactuur.be/api/v1/facturen \
  -H "Authorization: Bearer $PROFACTUUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"klant_id":"6f1c...","regels":[{"omschrijving":"Webdesign","aantal":8,"eenheidsprijs":75,"btw_percentage":21}]}'

Toon voorbeeldresponse

{
  "data": {
    "id": "9a2b...",
    "nummer": null,
    "status": "concept",
    "totaal_incl": 726
  }
}

Factuur definitief makenLink naar deze sectie

POST/api/v1/facturen/{id}/definitief

Kent het volgende factuurnummer en de gestructureerde mededeling toe. Daarna kan de factuur niet meer wijzigen.

Naam	Type	Verplicht	Uitleg
`id`	uuid	ja	ID van de factuur

curl -X POST https://profactuur.be/api/v1/facturen/9a2b.../definitief \
  -H "Authorization: Bearer $PROFACTUUR_KEY"

Toon voorbeeldresponse

{
  "data": {
    "id": "9a2b...",
    "nummer": "2026-0042",
    "status": "verzonden",
    "ogm": "+++123/4567/89012+++"
  }
}

Factuur versturenLink naar deze sectie

POST/api/v1/facturen/{id}/versturen

Verstuurt een definitieve factuur via Peppol of per e-mail met de PDF als bijlage.

Naam	Type	Verplicht	Uitleg
`id`	uuid	ja	ID van de factuur
`kanaal`	string	ja	peppol of email
`email`	string	nee	Ander adres dan dat van de klant (enkel bij email)
`simuleer`	string	nee	Enkel met een testsleutel: afgeleverd (standaard), geweigerd of fout

curl -X POST https://profactuur.be/api/v1/facturen/9a2b.../versturen \
  -H "Authorization: Bearer $PROFACTUUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kanaal":"peppol"}'

Toon voorbeeldresponse

{
  "data": {
    "kanaal": "peppol",
    "peppol_status": "verzonden"
  }
}

PDF downloadenLink naar deze sectie

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

Geeft de factuur als PDF-bestand terug.

Naam	Type	Verplicht	Uitleg
`id`	uuid	ja	ID van de factuur

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

Toon voorbeeldresponse

(binair PDF-bestand)

UBL downloadenLink naar deze sectie

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

Geeft de factuur als Peppol BIS Billing 3.0 XML terug.

Naam	Type	Verplicht	Uitleg
`id`	uuid	ja	ID van de factuur

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

Toon voorbeeldresponse

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

VorigeOffertes VolgendeCreditnota's