Skip to main content
PATCH
Update a customer

Autorisations

x-api-key
string
header
requis

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

Authorization
string
header
requis

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

Paramètres de chemin

customerId
string
requis

Customer identifier (24-character hexadecimal string), as returned in id.

Corps

application/json

Only the fields sent are updated. enterpriseNumber cannot be changed; bank accounts and payroll providers have their own endpoints.

name
string
accountingRef
string
address
object
contact
object

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

Réponse

The updated customer.

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>