Skip to main content
GET
Get journal entries (Multiple Analytic Plans)

Path Parameters

consumer_id
string<uuid>
required

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
size
integer
default:50

Page size

Required range: 1 <= x <= 100
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.

unposted_allowed
enum<string>
required
Available options:
true,
false
journal_id
string | null

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

date_from
string<date> | null

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_to
string<date> | null

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_after
string<date-time> | null

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_id
string | null

Response

Successful Response

items
JournalEntryMultiAnalyticPlan · object[]
required
total
integer
required
Required range: x >= 0
page
integer
required
Required range: x >= 1
size
integer
required
Required range: x >= 1