Create Journal Entry

Create a new Journal Entry in the accounting system

consumer_idstring uuid required

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.

force_currency_exchange'true' | 'false'

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 invoice 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

referencestring nullable

Optional reference field used to store an external or contextual identifier related to the entry. For example, it can be used to store a reference number, the invoice number issued by the suppllier or any other relevant information.

due_datestring date nullable

If the journal entry relates to an invoice, this is the due date for payment or settlement (format: YYYY-MM-DD).

journal_idstring required

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

numberstring required

Unique 'number' of the journal entry in the accounting software. This is an internal number or ID assigned to the journal entry, not necessarily the label or number visible on an invoice. 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.

currencystring required

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

currency_exchange_ratenumber nullable

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

datestring date required

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

pdfstring nullable

Base 64 string representing the PDF attached to the item.

pdf_namestring nullable

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

postedboolean nullable

Indicates if the journal entry has been posted (finalized) in the accounting system. If not provided, it defaults to True.

start_datestring date nullable

Start date of the period covered by the journal entry (format: YYYY-MM-DD). This field should be used when the entry relates to prepaid income or expenses (accruals and deferrals), indicating when the covered period begins.

end_datestring date nullable

End date of the period covered by the journal entry (format: YYYY-MM-DD). This field should be used when the entry relates to prepaid income or expenses (accruals and deferrals), indicating when the covered period ends.

Response

Successful Response

referencestring nullable

Optional reference field used to store an external or contextual identifier related to the entry. For example, it can be used to store a reference number, the invoice number issued by the suppllier or any other relevant information.

due_datestring date nullable

If the journal entry relates to an invoice, this is the due date for payment or settlement (format: YYYY-MM-DD).

journal_idstring required

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

namestring nullable

journal_namestring nullable

Name of the journal in which the journal entry is recorded.

datestring date nullable

Accounting date of the journal entry. It is automatically set to '1970-01-01' if the value is not available/empty in the accounting system.

postedboolean nullable

Indicates if the journal entry has been posted (finalized) in the accounting system.

idstring required

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

v1

Create Journal Entry

Path parameters

Query parameters

Request body

Response