Skip to main content
POST

Authorizations

x-api-key
string
header
required

Identifies the partner software. Issued by Codaclean. Required on every call, including POST /token.

Authorization
string
header
required

Identifies the user and their accounting firm. Send the idToken returned by POST /token as Authorization: Bearer <idToken>. Valid for 1 hour.

Body

application/json
q
string

Case-insensitive search on name, enterprise number and accounting reference.

enterpriseNumber
string

Exact match, formatted 0123.456.789.

accountingRef
string

Exact match.

iban
string

Exact match on an active bank account. Spaces are ignored.

limit
integer
default:50
Required range: x <= 200
offset
integer
default:0

Response

Matching customers.

records
object[]
recordsTotal
integer

Number of customers visible to the user, before filters.

recordsFiltered
integer

Number of customers matching the filters.