List Ledger Entries

Returns a list of ledger entries.
By default, entries from fiscal periods that are closed or frozen are excluded.
However, if a 'date' filter is provided, it will return all entries within the specified date range, even if they fall within a closed or frozen fiscal period.

ℹ️

This endpoint requires one of the following scopes: ledger

Log in to see full request history
Query Params
integer

Items are paginated, this is the current page which will be returned. The page index is starting at 1.

integer
1 to 100

Items are paginated. By default, you get 20 items per page. You can specify another number of items per page.

string

You can choose to filter items on specific fields.
Available fields and values:

  • updated_at, created_at, date: lt, lteq, gt, gteq, eq, not_eq
  • journal_id: lt, lteq, gt, gteq, eq, not_eq, in, not_in
string

You can choose to sort items on specific attributes
Sort field may be prefixed with - for descending order.
Example : updated_at will sort by ascending order, -updated_at will sort by descending order.
Available fields : updated_at, created_at, date

Responses

Response body
object
integer
required

The total number of pages available

integer
required

The current page returned

integer
required

The total number of items available

integer
required

The number of items per page

items
array of objects
required
items*
object
integer
required

ID of the ledger entry

date-time
required

Created at

date-time
required

Last update

string | null
required

Label that describes the ledger entry

date
required

Date of the ledger entry (ISO 8601)

integer
required

The journal ID where the ledger entry was created

string | null
required

Attachment's filename

Language
Credentials
OAuth2