Ga naar de inhoud
CijfrAPI
cijfr.com

Resources

Klanten

GET en POST /api/v1/customers. Klanten zijn de ontvangers van facturen en checkouts.

Als Markdown

Klanten ophalen

GET /api/v1/customers vraagt customers:read en geeft de honderd nieuwste klanten terug.

Antwoord
{
  "data": [
    {
      "id": "c0a8…",
      "company_name": "Bakkerij De Korenaar",
      "contact_name": null,
      "email": "sanne@korenaar.nl",
      "city": "Utrecht"
    }
  ]
}

Klant aanmaken

POST /api/v1/customers vraagt customers:write en accepteert Idempotency-Key.

VeldTypeVerplichtToelichting
namestringof companyNameNaam van de klant
companyNamestringof nameBedrijfsnaam, komt op de factuur
emailstringneeE-mailadres voor verzending
externalIdstringneeJouw eigen id, zie dedupe hieronder
addressLine1stringneeStraat en huisnummer
postalCodestringneePostcode
citystringneePlaats
countryCodestringneeISO-landcode, standaard NL
btwIdstringneeBtw-identificatienummer
kvkNumberstringneeKvK-nummer
Voorbeeld
curl https://app.cijfr.com/api/v1/customers \
  -H "Authorization: Bearer $CIJFR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: customer-sync-42" \
  -d '{
    "companyName": "Bakkerij De Korenaar",
    "email": "sanne@korenaar.nl",
    "addressLine1": "Dorpsstraat 12",
    "postalCode": "3511 AB",
    "city": "Utrecht",
    "kvkNumber": "12345678",
    "externalId": "shop-customer-42"
  }'
201
{ "data": { "id": "c0a8…" } }
Klanten · Cijfr