v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
Accounting
Journal entries

Get one journal entry

Returns a single journal entry by ID.

get/consumers/{consumer_id}/accounting/journal/entries/{journal_entry_id}

Path parameters

consumer_idstring uuid required
journal_entry_idstring 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.

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.