Skip to main content
POST
Create journal
Learn more:
  • What is a journal? ↗
  • What is a folder? ↗

Path Parameters

consumer_id
string<uuid>
required

Query Parameters

folder_id
string | null

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

Body

application/json
code
string
required

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

Minimum string length: 2
Example:

"BNK"

name
string
required

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

Minimum string length: 1
Example:

"Bank journal"

journal_type
enum<string>
required

Type of journal.

Available options:
customer_invoice,
customer_refund,
supplier_invoice,
supplier_refund,
bank,
cash,
miscellaneous_operation
counterpart_account
string | null

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

Example:

"<accounting-account-number>"

Response

Successful Response

id
string
required
Example:

"<this-journal-id>"

name
string
required
Example:

"Bank journal"

journal_type
enum<string>
required

Category of the journal. In retrieved data the values are customer_invoice, customer_refund, supplier_invoice, supplier_refund, financial_operation, miscellaneous_operation, or unknown. 'bank' and 'cash' exist only in the creation model; a journal representing a bank or cash account is retrieved as financial_operation (typically with an iban), so filter on financial_operation, not 'bank'/'cash', to find treasury journals.

Available options:
customer_invoice,
customer_refund,
supplier_invoice,
supplier_refund,
financial_operation,
miscellaneous_operation,
unknown
code
string | null
Example:

"BNK"

counterpart_account
string | null

Account number of the counterpart account used for the journal, for a treasury journal representing a bank or cash account (retrieved as journal_type financial_operation; bank/cash in the creation model).

Example:

"<accounting-account-number>"

unallocated_account
string | null

Unallocated ledger account used to book entries when the final ledger account / client / supplier / employee is not yet known (specific to treasury journals, retrieved as journal_type financial_operation; bank/cash in the creation model).

Example:

"<accounting-account-number>"

next_document_numbers
NextDocumentNumber · object[] | null

The next document numbers to use when the accounting tool enforces its own numbering sequence on creation (one sequence per journal, per book year, per folder).

iban
string | null

IBAN of the bank account linked to the journal, for a treasury journal representing a bank account (retrieved as journal_type financial_operation).

Example:

"BE00000000000000"

currency
string | null

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

Example:

"EUR"

other_currencies_allowed
boolean | null
default:true

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.

blocked
boolean | null
default:false

Indicates if the journal is blocked for creating entries.