GET
/
v0
/
ledgers
/
{ledger_id}
/
transactions
/
categories
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/ledgers/{ledger_id}/transactions/categories \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "transaction": {
        "amount": 132629.38,
        "categorization_method": "similarity",
        "datetime": "2024-03-15T15:28:53Z",
        "description": "Payroll March 15 2024",
        "id": "t_9237232",
        "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
        "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
        "line_entry_id": "XMDsKVuW4Wmi3LTW31Qw6E",
        "opposing_line_entry_ids": [
          "NULcvXTkLczde32qs1rqgB"
        ],
        "personal": false,
        "posted_status": "posted",
        "review_status": "unreviewed"
      },
      "categories": [
        {
          "editable": true,
          "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
          "ledger_name": "Payroll Expense"
        }
      ],
      "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"
      },
      "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn"
    }
  ]
}

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

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

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 categorized Transaction objects