v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB

Accounting

Suppliers

Create supplier

Create a new supplier

post/consumers/{consumer_id}/accounting/suppliers

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 client/customer in the accounting system. Accounting systems using 1 entity to handle clients/customers and suppliers will merge the existing client/customer with the new supplier (if the parameter is filled in with the ID of an existing client/customer).

Request body

external_referencestring nullable

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

first_namestring nullable

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

last_namestring nullable

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

namestring required

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

functionstring nullable

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

is_companyboolean nullable

Indicates if the supplier is an individual or a company.

company_idstring nullable

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

phonestring nullable

Phone number of the supplier.

mobilestring nullable

Mobile phone number of the supplier.

emailstring nullable

Email address of the supplier.

languagestring nullable

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

internal_notesstring nullable

Internal notes about the supplier.

websitestring nullable

Website of the supplier.

vatstring nullable

VAT number of the supplier.

company_numberstring nullable

National identification number of the company.

ibanstring nullable

IBAN account number of the supplier.

bank_accountstring nullable

Bank account number of the supplier.

currencystring nullable

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

activeboolean nullable

Indicates if the supplier is active.

account_numberstring nullable

Number of ledger account assigned to the supplier 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 payables. In some systems, each supplier has a dedicated account; in others, a shared control account is used and supplier balances are tracked in a subledger.

Response

Successful Response

external_referencestring nullable

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

first_namestring nullable

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

last_namestring nullable

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

namestring nullable

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

functionstring nullable

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

is_companyboolean nullable

Indicates if the supplier is an individual or a company.

company_idstring nullable

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

phonestring nullable

Phone number of the supplier.

mobilestring nullable

Mobile phone number of the supplier.

emailstring nullable

Email address of the supplier.

languagestring nullable

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

internal_notesstring nullable

Internal notes about the supplier.

websitestring nullable

Website of the supplier.

vatstring nullable

VAT number of the supplier.

company_numberstring nullable

National identification number of the company.

ibanstring nullable

IBAN account number of the supplier. DEPRECATED see bank_accounts

bank_accountstring nullable

Bank account number of the supplier. DEPRECATED see bank_accounts

currencystring nullable

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

activeboolean nullable

Indicates if the supplier is active.

account_numberstring nullable

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

idstring nullable

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

last_updated_onstring date-time nullable

The last time the supplier has been updated.

third_party_accountstring nullable

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