v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB

Accounting

Bank accounts

Create bank account

Create a new bank account in the accounting system

post/consumers/{consumer_id}/accounting/bank-accounts

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.

Request body

codestring required

A userfriendly code to represent the bank account. This will be used as the code of the journal if we need to create a journal for the bank account.

currencystring required

Currency of the bank account (e.g., EUR, USD).

account_namestring nullable

Name of the bank account. Represents this specific bank account in the accounting system.

account_numberstring nullable

Unique number representing the bank account. At least one of the fields 'account_number' or 'IBAN' must be filled in.

ibanstring nullable

IBAN of the bank account. At least one of the fields 'account_number' or 'IBAN' must be filled in.

bank_namestring required

Name of the bank linked to the bank account.

Response

Successful Response

idstring required

codestring nullable

A userfriendly code to represent the bank account. This will be used as the code of the journal if we need to create a journal for the bank account.

currencystring nullable

Currency of the bank account (e.g., EUR, USD).

account_namestring nullable

Name of the bank account. Represents this specific bank account in the accounting system.

account_numberstring nullable

Unique number representing the bank account.

ibanstring nullable

IBAN of the bank account.

bank_namestring nullable

Name of the bank linked to the bank account.

journal_idstring nullable

Indicates the journal used in the accounting system to represent the bank account. The journal contains all the transactions related to this specific bank account.

ledger_accountstring nullable

Indicates the ledger account used in the accounting system to represent the bank account. The ledger account is used in all the transactions related to this specific bank account. This ledger account is used to track the balance of the bank account.

unallocated_accountstring nullable

Unallocated ledger account used to book entries when the final ledger account / client / supplier / employee is not yet known (specific to bank and cash journals)