API-referentie

Creditnota's

Creditnota's maken op basis van een factuur en versturen.

Creditnota aanmakenLink naar deze sectie

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

Maakt een conceptcreditnota met dezelfde regels als de definitieve factuur.

NaamTypeVerplichtUitleg
iduuidjaID van de originele factuur
curl -X POST https://profactuur.be/api/v1/facturen/9a2b.../creditnota \
  -H "Authorization: Bearer $PROFACTUUR_KEY"
Toon voorbeeldresponse
{
  "data": {
    "id": "b3c4...",
    "type": "creditnota",
    "status": "concept",
    "gekoppelde_factuur_id": "9a2b..."
  }
}

Creditnota's oplijstenLink naar deze sectie

GET/api/v1/creditnotas

Geeft creditnota's terug, nieuwste eerst.

NaamTypeVerplichtUitleg
limitintegernee1 tot 100, standaard 50
offsetintegerneeAantal over te slaan, standaard 0
statusstringneeconcept, verzonden of betaald
vandateneeVanaf datum (YYYY-MM-DD)
totdateneeTot en met datum
curl https://profactuur.be/api/v1/creditnotas \
  -H "Authorization: Bearer $PROFACTUUR_KEY"
Toon voorbeeldresponse
{
  "data": [
    {
      "id": "b3c4...",
      "type": "creditnota",
      "nummer": "2026-0043",
      "status": "verzonden",
      "datum": "2026-10-10",
      "totaal_incl": 726
    }
  ],
  "total": 1
}

Creditnota versturenLink naar deze sectie

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

Verstuurt een definitieve creditnota via Peppol of per e-mail.

NaamTypeVerplichtUitleg
iduuidjaID van de creditnota
kanaalstringjapeppol of email
emailstringneeAnder adres dan dat van de klant (enkel bij email)
simuleerstringneeEnkel met een testsleutel: afgeleverd (standaard), geweigerd of fout
curl -X POST https://profactuur.be/api/v1/creditnotas/9a2b.../versturen \
  -H "Authorization: Bearer $PROFACTUUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kanaal":"email"}'
Toon voorbeeldresponse
{
  "data": {
    "kanaal": "email",
    "naar": "boekhouding@peeters.be"
  }
}