POST
/
consumers
/
{consumer_id}
/
accounting
/
clients
curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/accounting/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "external_reference": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "name": "<string>",
  "function": "<string>",
  "is_company": true,
  "company_id": "<string>",
  "phone": "<string>",
  "mobile": "<string>",
  "email": "<string>",
  "language": "<string>",
  "internal_notes": "<string>",
  "website": "<string>",
  "vat": "<string>",
  "iban": "<string>",
  "bank_account": "<string>",
  "currency": "<string>",
  "active": true,
  "addresses": [
    {
      "address_type": "main",
      "name": "<string>",
      "number": "<string>",
      "box": "<string>",
      "phone": "<string>",
      "mobile": "<string>",
      "email": "<string>",
      "street": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    }
  ],
  "account_number": "<string>"
}'
{
  "external_reference": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "name": "<string>",
  "function": "<string>",
  "is_company": true,
  "company_id": "<string>",
  "phone": "<string>",
  "mobile": "<string>",
  "email": "<string>",
  "language": "<string>",
  "internal_notes": "<string>",
  "website": "<string>",
  "vat": "<string>",
  "iban": "<string>",
  "bank_account": "<string>",
  "currency": "<string>",
  "active": true,
  "addresses": [],
  "account_number": "<string>",
  "company_number": "<string>",
  "id": "<string>",
  "last_updated_on": "2023-11-07T05:31:56Z"
}

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

​
folder_id
string
​
force_merge
string

Body

application/json
​
name
string
required
Minimum length: 1
​
addresses
object[]
required
​
external_reference
string
​
first_name
string

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

​
last_name
string

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

​
function
string

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

​
is_company
boolean
default:true

Indicates if the client is an individual or a company.

​
company_id
string

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

​
phone
string
​
mobile
string
​
email
string
​
language
string

Format: ISO 639-1 codes.

​
internal_notes
string
​
website
string
​
vat
string
​
iban
string

IBAN Account number of the client.

​
bank_account
string

Bank account number of the client.

​
currency
string

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

​
active
boolean
default:true
​
account_number
string

Response

200
application/json
Successful Response
​
external_reference
string
​
first_name
string

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

​
last_name
string

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

​
name
string
​
function
string

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

​
is_company
boolean
default:true

Indicates if the client is an individual or a company.

​
company_id
string

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

​
phone
string
​
mobile
string
​
email
string
​
language
string

Format: ISO 639-1 codes.

​
internal_notes
string
​
website
string
​
vat
string
​
iban
string

IBAN Account number of the client.

​
bank_account
string

Bank account number of the client.

​
currency
string

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

​
active
boolean
default:true
​
addresses
object[]
​
account_number
string
​
company_number
string
​
id
string
​
last_updated_on
string

The last time the client has been updated.