Retrieve a client

Authorizations

Authorization

string

header

required

Bearer authorization header: Bearer <token>, where <token> is the access token received from the authorization server at the end of the OAuth 2.0 flow.

Headers

X-Qonto-Staging-Token

string

Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.

Path Parameters

string<uuid>

required

ID of the client

Response

Returns the client identified by the id path parameter.

client

object

required

Option 1
Option 2

Show child attributes

client.id

string<uuid>

client.name

string

Name of the client that needs to pay the client invoice.

Example:

"John Doe"

client.first_name

string

First name of the client that needs to pay the invoice.

Example:

"John"

client.last_name

string

Last name of the client that needs to pay the invoice.

Example:

"Doe"

client.phone_number

string

deprecated

Phone number of the client that needs to pay the invoice. Deprecated, use phone instead.

Example:

"+33123456789"

client.phone

object

Phone country code and number of the client that needs to pay the invoice.

Show child attributes

client.phone.country_code

string

Country code of the client's phone number.

Example:

"+33"

client.phone.number

string

Phone number of the client.

Example:

"123456789"

client.kind

enum<string>

Describes the client type. individual represents a physical person (a consumer) whereas company or freelancer represent a legal entity. Usually a freelancer is a legal entity with the name of a person.

Available options:

company,

individual,

freelancer

client.type

enum<string>

deprecated

Available options:

company,

individual,

freelancer

client.email

string<email>

E-mail address of the client that needs to pay the invoice, which is displayed in the invoice.

Example:

"[email protected]"

client.extra_emails

string<email>[] | null

Additional email addresses for the client. Store additional emails that won't appear in the document but will be used as recipients when sending the document via email.

Maximum array length: 100

Maximum string length: 250

Example:

["[email protected]", "[email protected]"]

client.currency

string

Client's currency.

Example:

"EUR"

client.e_invoicing_address

string

Specifically for French organizations. A unique address in one of the formats:

siren e.g. 987654321
siren_siret e.g. 987654321_98765432100012
siren_siret_routingCode e.g. 987654321_98765432100012_00001
siren_suffix e.g. 987654321_00002

Note the address should also exist in the Annuaire to be accepted.

Example:

"987654321"

client.vat_number

string

Value Added Tax number of the client (a legal entity) that needs to pay the invoice.

client.tax_identification_number

string

Tax Identification Number of the client (a physical person) that needs to pay the invoice. It corresponds to the SIREN/SIRET for French companies.

client.address

string

Address of the client that needs to pay the invoice.

client.city

string

City of the client that needs to pay the invoice.

client.zip_code

string

Zip code of the client that needs to pay the invoice.

client.province_code

string

Only for italian organizations. Represents the province code of the client.

client.country_code

string

Country code of the client that needs to pay the invoice.

client.billing_address

object

Billing address of the client that needs to pay the invoice. Stores the same data as the root-level fields address fields (address, city, zip_code, province_code, country_code).

Show child attributes

client.billing_address.street_address

string

represent the street address section of the billing address of the client. (eg street, number, floor, door, etc)

Maximum string length: 250

Example:

"123 Main Street"

client.billing_address.city

string

City on the billing address of the client that needs to pay the invoice

Maximum string length: 50

Example:

"Paris"

client.billing_address.zip_code

string

Zip code on the billing address of the client that needs to pay the invoice

Maximum string length: 20

Example:

"75009"

client.billing_address.province_code

string

Province code of the client's billing address

Maximum string length: 2

client.billing_address.country_code

string

Country code on the billing address of the client that needs to pay the invoice

Maximum string length: 2

Example:

"fr"

client.delivery_address

object

Delivery address of the client that needs to pay the invoice. Stores the same data as the root-level fields address fields (address, city, zip_code, province_code, country_code).

Show child attributes

client.delivery_address.street_address

string

represent the street address section of the delivery address of the client. (eg street, number, floor, door, etc)

Maximum string length: 250

Example:

"123 Main Street"

client.delivery_address.city

string

City on the delivery address of the client that needs to pay the invoice

Maximum string length: 50

Example:

"Paris"

client.delivery_address.zip_code

string

Zip code on the delivery address of the client that needs to pay the invoice

Maximum string length: 20

Example:

"75009"

client.delivery_address.province_code

string

Province code of the client's delivery address that needs to pay the invoice

Maximum string length: 2

client.delivery_address.country_code

string

Country code on the delivery address of the client that needs to pay the invoice

Maximum string length: 2

Example:

"fr"

client.recipient_code

string

Only for italian clients. Represents the client’s recipient code for receiving an the e-invoice in his SdI portal.

client.created_at

string

Date the client was created. Note that this is a machine date.

client.locale

string

Language of the documents created on Qonto (invoices, quotes, credit notes) for this particular client. Note, although we accept locales of format fr-FR we ignore the region part, treating this as fr.

Example:

"fr"

Business API

Onboarding API

Retrieve a client

Authorizations

Headers

Path Parameters

Response