Ga naar de inhoud
CijfrAPI
cijfr.com

Integratie

Referentie

Alle endpoints in één tabel, gegenereerd uit de OpenAPI-beschrijving. Dezelfde beschrijving draait live.

Als Markdown ↗

OpenAPI

De machineleesbare beschrijving staat op https://docs.cijfr.com/openapi.json (CORS open) en op https://app.cijfr.com/api/v1/openapi. Importeer hem in Postman, Insomnia of je eigen codegen.

Spec ophalen
curl https://docs.cijfr.com/openapi.json

Endpoints

GET /api/v1/me

Current organisation and profile

scope none

GET /api/v1/customers

List customers

scope customers:read

POST /api/v1/customers

Create a customer

scope customers:write

  • name string
  • email? string
  • companyName? string
  • addressLine1? string
  • postalCode? string
  • city? string
  • countryCode? string
  • btwId? string
  • kvkNumber? string
  • externalId? string

GET /api/v1/products

List products

scope products:read

POST /api/v1/products

Create a product

scope products:write

  • name string
  • unitPriceCents integer
  • vatRateBps? integer
  • unit? string
  • sku? string

GET /api/v1/invoices

List invoices

scope invoices:read

POST /api/v1/invoices

Create an invoice (draft or sent)

scope invoices:write

  • customerId string uuid
  • issueDate? string date
  • dueDate? string date
  • send? boolean · When true, lock the invoice and dispatch email. The response includes emailed and emailError. A missing Resend config still issues the invoice.
  • profileId? string uuid
  • lines array

GET /api/v1/subscriptions

List recurring schedules

scope subscriptions:read

POST /api/v1/subscriptions

Create a subscription from invoice-like lines

scope subscriptions:write

  • customerId string uuid
  • freq string · `weekly`, `monthly`, `quarterly`, `yearly`
  • interval? integer
  • autoSendEmail? boolean
  • autoSendPost? boolean
  • lines array

GET /api/v1/checkouts

List hosted checkout sessions

scope checkouts:read

POST /api/v1/checkouts

Create a hosted checkout session. The response `url` is a Cijfr-hosted checkout page where the payer picks a payment method and enters invoice details; the invoice is issued and emailed after payment.

scope checkouts:write

  • title string
  • lines array
  • customer? object · Optional prefill for the checkout details form.
  • redirectUrl? string uri · Where the payer lands after a successful payment.
  • methods? array · Mollie method ids; defaults to all enabled.
  • expiresInHours? integer

GET /api/v1/openapi

This OpenAPI document as JSON (unauthenticated, CORS open)

scope none

POST /api/v1/credits

Grant mail credits after a paid top-up (platform billing / Edge Functions)

scope credits:write (platform)

  • orgId string uuid
  • credits integer
  • reason? string
Referentie · Cijfr