POST
/
consumers
/
{consumer_id}
/
accounting
/
clients

Authorizations

Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

consumer_id
string
required

Query Parameters

force_merge
string

Indicate the ID of the corresponding supplier in the accounting system. Accounting systems using 1 entity to handle clients/customers and suppliers will merge the existing supplier with the new client/customer (if the parameter is filled in with the ID of an existing supplier).

folder_id
string

Accounting folder ID, this needs to be passed when activating the multiple folders feature.

Body

application/json
addresses
object[]
required
name
string
required
Minimum length: 1
account_number
string
active
boolean
default:
true
bank_account
string

Bank account number of the client.

company_id
string

Only used when the client is an individual (is_company=false). Indicates the id of the company linked to the client.

currency
string

Indicates the currency of the client (e.g. EUR).

email
string
external_reference
string
first_name
string

Only used when the client is an individual (is_company=false). Indicates the first name of the client.

function
string

Only used when the client is an individual (is_company=false). Indicates the function of the client.

iban
string

IBAN Account number of the client.

internal_notes
string
is_company
boolean
default:
true

Indicates if the client is an individual or a company.

language
string

Format: ISO 639-1 codes.

last_name
string

Only used when the client is an individual (is_company=false). Indicates the last name of the client.

mobile
string
phone
string
vat
string
website
string

Response

200 - application/json
account_number
string
active
boolean
default:
true
addresses
object[]
bank_account
string

Bank account number of the client.

company_id
string

Only used when the client is an individual (is_company=false). Indicates the id of the company linked to the client.

company_number
string
currency
string

Indicates the currency of the client (e.g. EUR).

email
string
external_reference
string
first_name
string

Only used when the client is an individual (is_company=false). Indicates the first name of the client.

function
string

Only used when the client is an individual (is_company=false). Indicates the function of the client.

iban
string

IBAN Account number of the client.

id
string
internal_notes
string
is_company
boolean
default:
true

Indicates if the client is an individual or a company.

language
string

Format: ISO 639-1 codes.

last_name
string

Only used when the client is an individual (is_company=false). Indicates the last name of the client.

mobile
string
name
string
phone
string
vat
string
website
string