Sign in

v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
Accounting
Journals

Create journal

Create a journal in the accounting system

post/consumers/{consumer_id}/accounting/journal

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

Short code or identifier of the journal (e.g., 'BNK', 'INV').

namestring required

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

journal_type'customer_invoice' | 'customer_refund' | 'supplier_invoice' | 'supplier_refund' | 'bank' | 'cash' | 'miscellaneous_operation' required
counterpart_accountstring nullable

When journal is of type bank or cash, this is account number of the counterpart account used for the journal.

Response

Successful Response

idstring required
codestring nullable
namestring required
journal_type'customer_invoice' | 'customer_refund' | 'supplier_invoice' | 'supplier_refund' | 'financial_operation' | 'miscellaneous_operation' | 'unknown' required
counterpart_accountstring nullable

When journal is of type bank or cash, this is account number of the counterpart account used for the journal.

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)

ibanstring nullable

When the journal is of type bank, IBAN of the bank account linked to the journal

currencystring nullable

Currency of the journal (e.g., EUR). If empty, the journal follows the currency of the accounting folder.

other_currencies_allowedboolean nullable

Indicates if the journal allows other currencies. If it doesn't allow other currencies an exchange rate must be provided for Chift to convert the amounts to the journal currency. This only applicable if the journal currency is the same as the accounting folder currency.

blockedboolean nullable

Indicates if the journal is blocked for creating entries.