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

Authorizations

Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

consumer_id
string
required

Query Parameters

unposted_allowed
enum<string>
required

An enumeration.

Available options:
true,
false
journal_id
string
required
date_from
string

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

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

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
folder_id
string

Accounting folder ID, this needs to be passed when activating the multiple folders feature.

page
integer
default:
1
Required range: x > 1
size
integer
default:
50
Required range: 1 < x < 100

Response

200 - application/json
items
object[]
required
page
integer
required
Required range: x > 1
size
integer
required
Required range: x > 1
total
integer
required
Required range: x > 0