Sign in

v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
Accounting
Ledger accounts

Create ledger account

Create a new ledger account in the chart of accounts

post/consumers/{consumer_id}/accounting/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

namestring required

Name or label of the ledger account as it appears in the accounting system.

numberstring required

The account number in the chart of accounts. Must be unique within the accounting folder. In some countries (e.g., France, Belgium, Spain), the number structure is constrained by local accounting rules and must follow official charts of accounts (e.g., Plan Comptable Général).

type'bank' | 'cash' | 'other_financial' | 'receivable' | 'payable' | 'income' | 'expense' | 'other_expense' | 'vat' | 'other'

Response

Successful Response

numberstring required

The account number in the chart of accounts. Must be unique within the accounting folder. In some countries (e.g., France, Belgium, Spain), the number structure is constrained by local accounting rules and must follow official charts of accounts (e.g., Plan Comptable Général).

namestring required

Name or label of the account as it appears in the accounting system. This is typically used for internal referencing and identification of the account.

activeboolean nullable

Flag indicating whether the account is active. If True, the account is active and can be used in transactions. If False, the account is inactive and cannot be used for transactions.

type'bank' | 'cash' | 'other_financial' | 'receivable' | 'payable' | 'income' | 'expense' | 'other_expense' | 'vat' | 'other'
scheme_idsstring[] nullable

List of scheme classification IDs linked to this ledger account. A scheme (e.g., RGS, SBR) provides a standardized classification structure for organizing accounts for reporting purposes. Multiple scheme codes can be associated with a single account.

accounting_categorystring nullable

Category of the ledger account in the accounting system. This is the category of the account as defined in the accounting system.