GET
/
v0
/
ledgers
/
{ledger_id}
/
transactions
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/ledgers/{ledger_id}/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "id": "t_9237232",
      "amount": 132629.38,
      "datetime": "2024-03-15T15:28:53Z",
      "description": "Payroll March 15 2024",
      "metadata": {},
      "categorization_method": "similarity",
      "posted_status": "posted",
      "review_status": "reviewed",
      "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
      "journal_entry": {
        "datetime": "2023-02-15T06:42:18Z",
        "description": "Payroll#230215",
        "id": "C4ocnUQze8kDwQ3EczkZXn",
        "line_entry_ids": [
          "XMDsKVuW4Wmi3LTW31Qw6E",
          "NULcvXTkLczde32qs1rqgB"
        ]
      },
      "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
      "ledger": {
        "debit_credit": "debit",
        "editable": false,
        "financial_account_type": "bank_account",
        "id": "7JRNsKwy2Lw66caxVU7WGC",
        "is_required": false,
        "name": "Pluto Checking 4242",
        "report_cash_flow": true,
        "sort_code": "1140",
        "sub_type": "current_assets",
        "type": "asset"
      },
      "line_entry_id": "XMDsKVuW4Wmi3LTW31Qw6E",
      "line_entry": {
        "amount": 31282.28,
        "datetime": "2023-02-15T06:42:18Z",
        "debit_credit": "debit",
        "description": "Payroll#230215",
        "editable": false,
        "id": "XMDsKVuW4Wmi3LTW31Qw6E",
        "journal_entry_description": "Payroll#230215",
        "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
        "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
        "ledger_name": "Pluto Checking 4242",
        "transaction_id": "t_9237232"
      },
      "opposing_line_entry_ids": [
        "NULcvXTkLczde32qs1rqgB"
      ],
      "opposing_line_entries": {
        "amount": 31282.28,
        "datetime": "2023-02-15T06:42:18Z",
        "debit_credit": "debit",
        "description": "Payroll#230215",
        "editable": false,
        "id": "XMDsKVuW4Wmi3LTW31Qw6E",
        "journal_entry_description": "Payroll#230215",
        "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
        "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
        "ledger_name": "Pluto Checking 4242",
        "transaction_id": "t_9237232"
      },
      "tags": [
        {
          "id": "UjL3BQnEaJtecuC7CUeDk",
          "name": "Sprinter - 1ab-c23",
          "tag_group_id": "NCB2xo5S1yQbNgyWskXpwG"
        }
      ],
      "personal": true
    }
  ]
}

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

Path Parameters

ledger_id
string
required

The Ledger ID.

Query Parameters

review_status
enum<string> | null

Only return Transactions with a specific review status.

Available options:
unreviewed,
reviewed
start_date
string | null

Only return Transactions created after the start date (inclusive).

end_date
string | null

Only return Transactions before the end start date (inclusive).

expand
enum<string>[] | null

Comma-separated list of Transaction expand paths.

Available options:
ledger,
line_entry,
journal_entry,
opposing_line_entries,
opposing_line_entries.ledger,
transfer,
transfer.matched_transaction,
transfer.from_journal_entry,
transfer.to_journal_entry
limit
integer | null

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

page_token
string
tag_ids
string

A list of Tag IDs. Only return Transactions with all of the given Tags.

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

A list of Transaction objects