GET
/
v0
/
journal-entries
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/journal-entries \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "datetime": "2023-02-15T06:42:18Z",
      "description": "Payroll#230215",
      "id": "C4ocnUQze8kDwQ3EczkZXn",
      "line_entry_ids": [
        "XMDsKVuW4Wmi3LTW31Qw6E",
        "NULcvXTkLczde32qs1rqgB"
      ]
    }
  ]
}

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

teal-instance-id
string
required

The 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.

expand
enum<string>[] | null

Comma-separated list of expandable paths.

Available options:
line_entries,
line_entries.transaction,
line_entries.ledger
limit
integer | null

The number of records to return. Max limit is 1000.

page_token
string

Response

200 - application/json
next_page_token
string | null
required

The token to use to request the next page

prev_page_token
string | null
required

The token to use to request the previous page

records
object[]
required

List of journal entries