v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB

Accounting

Clients

Create client

Create a new client

post/consumers/{consumer_id}/accounting/clients

Path parameters

consumer_idstring uuid required

Query parameters

folder_idstring nullable

Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled.

force_mergestring nullable

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).

Request body

external_referencestring nullable

External identifier used to link the client in the accounting system with the corresponding client reference in your own system.

first_namestring nullable

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

last_namestring nullable

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

namestring required

Full name or legal name of the client (individual or company). This is the name that will be displayed in the accounting software.

functionstring nullable

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

is_companyboolean nullable

Indicates if the client is an individual or a company.

company_idstring nullable

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

phonestring nullable

Phone number of the client.

mobilestring nullable

Mobile phone number of the client.

emailstring nullable

Email address of the client.

languagestring nullable

Language of the client. Format: ISO 639-1 codes.

internal_notesstring nullable

Internal notes about the client.

websitestring nullable

Website of the client.

vatstring nullable

VAT number of the client, used for tax compliance and invoicing. This value is unique per company and can be used as a reliable identifier to match clients between systems.

company_numberstring nullable

National identification number of the company.

ibanstring nullable

IBAN account number of the client.

bank_accountstring nullable

Bank account number of the client.

currencystring nullable

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

activeboolean nullable

Indicates if the client is active.

account_numberstring nullable

Number of ledger account assigned to the client in the accounting system as it will appear in the official accounting export file (FEC, SIE, iXBRL, etc.). This is typically the ledger account used for posting receivables. In some systems, each customer has a dedicated account; in others, a shared control account is used and customer balances are tracked in a subledger.

Response

Successful Response

external_referencestring nullable

External identifier used to link the client in the accounting system with the corresponding client reference in your own system.

first_namestring nullable

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

last_namestring nullable

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

namestring nullable

Full name or legal name of the client (individual or company). This is the name displayed in the accounting software.

functionstring nullable

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

is_companyboolean nullable

Indicates if the client is an individual or a company.

company_idstring nullable

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

phonestring nullable

Phone number of the client.

mobilestring nullable

Mobile phone number of the client.

emailstring nullable

Email address of the client.

languagestring nullable

Language of the client. Format: ISO 639-1 codes.

internal_notesstring nullable

Internal notes about the client.

websitestring nullable

Website of the client.

vatstring nullable

VAT number of the client.

company_numberstring nullable

National identification number of the company.

ibanstring nullable

IBAN account number of the client. DEPRECATED see bank_accounts

bank_accountstring nullable

Bank account number of the client. DEPRECATED see bank_accounts

currencystring nullable

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

activeboolean nullable

Indicates if the client is active.

account_numberstring nullable

Ledger account number assigned to the customer in the accounting system as it will appear in the official accounting export file (FEC, SIE, iXBRL, etc.).

idstring nullable

Id of the client in the accounting software. This is the unique identifier used to reference the client in the system.

last_updated_onstring date-time nullable

The last time the client has been updated.

third_party_accountstring nullable

Third party account number/code representing the client in the accounting software.