API-referentie

Klanten

Klanten oplijsten, ophalen, aanmaken en bijwerken.

Klanten oplijstenLink naar deze sectie

GET/api/v1/klanten

Geeft alle klanten terug, alfabetisch op naam.

Naam	Type	Verplicht	Uitleg
`limit`	integer	nee	1 tot 100, standaard 50
`offset`	integer	nee	Aantal over te slaan, standaard 0
`q`	string	nee	Zoek op naam

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

Toon voorbeeldresponse

{
  "data": [
    {
      "id": "6f1c...",
      "naam": "Bakkerij Peeters"
    }
  ],
  "total": 1
}

Klant ophalenLink naar deze sectie

GET/api/v1/klanten/{id}

Geeft één klant met alle gegevens terug.

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

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

Toon voorbeeldresponse

{
  "data": {
    "id": "6f1c...",
    "naam": "Bakkerij Peeters",
    "type": "bedrijf",
    "email": "boekhouding@peeters.be",
    "land": "BE",
    "kbo_btw_nummer": "BE0123456789"
  }
}

Klant aanmakenLink naar deze sectie

POST/api/v1/klanten

Maakt een nieuwe klant aan.

Naam	Type	Verplicht	Uitleg
`naam`	string	ja	Naam van de klant
`type`	string	nee	bedrijf of particulier, standaard bedrijf
`email`	string	nee	Adres voor facturen per e-mail
`adres`	string	nee	Volledig adres
`land`	string	nee	ISO-landcode, standaard BE
`kbo_btw_nummer`	string	nee	Ondernemings- of btw-nummer
`peppol_id`	string	nee	Peppol-adres, bv. 0208:0123456789

curl -X POST https://profactuur.be/api/v1/klanten \
  -H "Authorization: Bearer $PROFACTUUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"naam":"Bakkerij Peeters","email":"boekhouding@peeters.be"}'

Toon voorbeeldresponse

{
  "data": {
    "id": "6f1c...",
    "naam": "Bakkerij Peeters"
  }
}

Klant bijwerkenLink naar deze sectie

PATCH/api/v1/klanten/{id}

Wijzigt enkel de velden die je meestuurt. Zelfde velden als bij aanmaken.

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

curl -X PATCH https://profactuur.be/api/v1/klanten/6f1c... \
  -H "Authorization: Bearer $PROFACTUUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"nieuw@peeters.be"}'

Toon voorbeeldresponse

{
  "data": {
    "id": "6f1c...",
    "email": "nieuw@peeters.be"
  }
}

VorigeAPI-referentie VolgendeProducten