Sign in

v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
Accounting
Journal entries

Create a financial entry

Create a new financial entry (Bank or Cash operation)

post/consumers/{consumer_id}/accounting/financial-entries

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.

financial_counterpart_accountstring nullable

Number of ledger account representing bank account in accounting. Required in cases where the connector does not allow direct linking of the ledger account representing the bank account and the journal representing the bank account, making it necessary to specify it here.

force_currency_exchangeboolean nullable

Boolean flag indicating whether to force the use of the provided currency exchange rate instead of the rate used by the accounting software.

ignore_accounting_idboolean

If set to true, Chift will not wait for the entry to be processed to return, use this when you do not need the ID in the return value.Note that this might also change the output of the call.

Request body

datestring date required

Accounting date of the financial entry (format: YYYY-MM-DD). This is the date when the financial entry is recorded in the accounting system.

journal_idstring required

Id of the journal instance in the accounting system in which the financial entry is recorded.

currencystring required

Indicates the currency of the operation (e.g., EUR, USD).

currency_exchange_ratenumber nullable

Indicates the exchange rate at the date of the operation. Must be filled in when creating the operation in another currency from the folder's default currency.

referencestring nullable

Optional reference field that can be used for lettering by storing an external or contextual identifier related to the entry . For example, it can be used to store a reference number, such as the invoice number associated with the payment.

numberstring nullable

Unique 'number' of the financial entry in the accounting software. This is an internal number or identifier assigned to the financial entry. It is recommended to use this number for idempotency to prevent duplicate entries. Refer to the idempotency documentation in the Developer Guides for more details.

pdfstring nullable

Base 64 string representing the PDF attached to the sale/purchase entry.

pdf_namestring nullable

A name for the PDF file to be created for accounting software that support it.

Response

Successful Response

datestring date required

Accounting date of the financial entry (format: YYYY-MM-DD). This is the date when the financial entry is recorded in the accounting system.

journal_idstring required

Id of the journal instance in the accounting system in which the financial entry is recorded.

currencystring required

Indicates the currency of the operation (e.g., EUR, USD).

currency_exchange_ratenumber nullable

Indicates the exchange rate at the date of the operation. Must be filled in when creating the operation in another currency from the folder's default currency.

referencestring nullable

Optional reference field that can be used for lettering by storing an external or contextual identifier related to the entry . For example, it can be used to store a reference number, such as the invoice number associated with the payment.

idstring required

Unique id of the financial entry instance in the accounting system.

numberstring required

Unique 'number' of the financial entry in the accounting software. This is an internal number or identifier assigned to the financial entry. It is recommended to use this number for idempotency to prevent duplicate entries. Refer to the idempotency documentation in the Developer Guides for more details.