Skip to main content
POST
Create a customer

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
enterpriseNumber
string
required

Belgian enterprise number, formatted 0123.456.789: 10 digits with dots, without the BE prefix. Its check digits are validated, and it must be unique across Codaclean.

Pattern: ^[01]\d{3}\.\d{3}\.\d{3}$
name
string
required

Non-empty.

accountingRef
string
required

Your internal reference for the customer.

address
object
required

All fields are required except street2.

contact
object
required

All fields are required. Mandate signature requests are sent to this contact.

bankAccounts
object[]

Only iban is accepted. BIC and bank name are derived by Codaclean.

payrollProviders
object[]

Only code is accepted. See POST /payroll-providers.

Response

Customer created.

Fields without a value are omitted from the response. Arrays are always present.

id
string
enterpriseNumber
string

Belgian enterprise number, formatted 0123.456.789.

name
string
accountingRef
string
address
object
contact
object

Contact person at the customer. Mandate signature requests are sent to this contact.

isConfidential
boolean

Confidential customers are only visible to users with the Administrator access level.

bankAccounts
object[]

Active bank accounts only.

payrollProviders
object[]

Active payroll providers only.

createdOn
string<date-time>
updatedOn
string<date-time>