v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB

Accounting

Journal entries

Get journal entries

Returns a list of journal entries. Each item will include the analytic account linked to default analytic plan. Optionally, you can retrieve journal entries linked to a specific client/supplier using the partner_id parameter. When retrieving entries linked to a specific client/supplier, some journal items of an entry (e.g. a miscellaneous operation) could be excluding resulting in an unbalanced journal entry.

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

Path parameters

consumer_idstring uuid required

Query parameters

pageinteger

Page number

sizeinteger

Page size

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.

unposted_allowed'true' | 'false' required

journal_idstring nullable

Journal ID used to filter journal entries to only retrieve entries for a specific journal. This is an optional filter parameter.

date_fromstring date nullable

Accounting date from which the journal entries will be retrieved (this date will be included in the response). This parameter is mandatory if the 'updated_after' parameter is not provided.

date_tostring date nullable

Accounting date until which the journal entries will be retrieved (this date will be included in the response). This parameter is mandatory if the 'updated_after' parameter is not provided.

updated_afterstring date-time nullable

When provided only journal entries modified or created after this datetime will be retrieved (this datetime will NOT be included in the response). E.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC, UTC is the only format that is supported on all connectors.

partner_idstring nullable

Response

Successful Response

totalinteger required

pageinteger required

sizeinteger required