Journal Entries
List all Journal Entries
List all the Journal Entries an Instance.
GET
/
v0
/
journal-entries
Authorizations
Authorization
string
headerrequiredThe access token received from the authorization server in the OAuth 2.0 flow.
Headers
teal-instance-id
string
requiredThe Teal instance ID
Query Parameters
start_date
string | null
Only return Journal Entries after the start date (inclusive).
Must be in YYYY-MM-DD
format.
end_date
string | null
Only return Journal Entries before the end date (inclusive).
Must be in YYYY-MM-DD
format.
ledger_id
string | null
Only return Journal Entries where at least one Line Entry belongs to the specified Ledger.
sort
enum<string>[] | null
A comma separated list of sort orders for the results.
Available options:
description
, -description
, datetime
, -datetime
expand
enum<string>[] | null
Comma-separated list of expandable paths.
Available options:
line_entries
, line_entries.transaction
, line_entries.ledger
limit
integer | null
default: 50The number of records to return. Max limit is 100.
page_token
string
Response
200 - application/json
next_page_token
string | null
requiredThe token to use to request the next page
prev_page_token
string | null
requiredThe token to use to request the previous page
records
object[]
requiredList of journal entries