Create a client
OAuth scope: client.write
Create a client that constitutes the addressee of client invoices for a particular organization. See further details below.
Price plans: this endpoint is available for all Qonto price plans
The response contains an array the attributes of the client entered in the request, along with additional fields that are computed by Qonto, including the associated client id.
There is no uniqueness rule. It is strongly advised to search using the GET endpoints for a given client before creating a new client.
<!-- theme: warning -->When creating a client to be used for invoicing purposes, bear in mind the following:
- A client can be created by only specifying a type and a name (depending on the chosen type).
- However, to be able to use that client for invoicing, the following additional fields must also be provided:
- currency
- locale
- address, either as root-level fields (address, city, zip_code, province_code and country_code) or inside the billing_address field object.
Headers
Required only for Sandbox API requests; to get one, please submit the following form: https://getqonto.atlassian.net/servicedesk/customer/portal/5/group/47/create/143.
Request body
Example request
{
"email": "john.doe@qonto.eu",
"country_code": "FR",
"billing_address": {
"street_address": "123 Main Street",
"city": "Paris",
"zip_code": "75009",
"country_code": "FR"
},
"delivery_address": {
"street_address": "123 Main Street",
"city": "Paris",
"zip_code": "75009",
"country_code": "FR"
},
"currency": "EUR",
"locale": "FR"
}Response
The created client
Example response
{
"client": {
"email": "john.doe@qonto.eu",
"billing_address": {
"street_address": "123 Main Street",
"city": "Paris",
"zip_code": "75009",
"country_code": "fr"
},
"delivery_address": {
"street_address": "123 Main Street",
"city": "Paris",
"zip_code": "75009",
"country_code": "fr"
},
"locale": "fr"
}
}