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": "<string>",
  "prev_page_token": "<string>",
  "records": [
    {
      "categories": [
        {
          "editable": true,
          "ledger_id": "WhvrC7XAES1fDrpWWgmPtg",
          "ledger_name": "Credit Card 3821"
        }
      ],
      "journal_entry_id": "WhvrC7XAES1fDrpWWgmPtg",
      "ledger": {
        "debit_credit": "debit",
        "editable": true,
        "financial_account_type": "bank_account",
        "id": "7JRNsKwy2Lw66caxVU7WGC",
        "is_required": true,
        "name": "Accounts Receivable",
        "parent": "<any>",
        "parent_id": "HLn8oy2eqMUCwjp1Cwdgco",
        "report_cash_flow": true,
        "sort_code": "2003",
        "sub_type": "current_assets",
        "type": "asset"
      },
      "transaction": {
        "amount": 100,
        "categorization_method": "<string>",
        "datetime": "2022-01-01T00:00:00Z",
        "description": "Shell Gas Bar 4124",
        "id": "t_9237232",
        "journal_entry": null,
        "journal_entry_id": "<string>",
        "ledger": null,
        "ledger_id": "<string>",
        "line_entry": null,
        "line_entry_id": "<string>",
        "metadata": {
          "location": "TX, USA",
          "vendor_type": "Gas station"
        },
        "opposing_line_entries": null,
        "opposing_line_entry_ids": [
          "<string>"
        ],
        "posted_status": "posted",
        "review_status": "reviewed",
        "tags": [
          {
            "id": "UjL3BQnEaJtecuC7CUeDk",
            "name": "Semi-trailer Truck",
            "tag_group_id": "NCB2xo5S1yQbNgyWskXpwG"
          }
        ]
      }
    }
  ]
}

Authorizations

Authorization
string
headerrequired

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

Headers

teal-instance-id
string
required

Path Parameters

ledger_id
string
required

The ID for the ledger that contains the transactions.

Query Parameters

review_status
enum<string> | null

The review status of the transaction.

Available options:
unreviewed,
reviewed
start_date
string | null

The start date of the transactions, inclusive

end_date
string | null

The end date of the transactions, inclusive

limit
integer | null

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

page_token
string
tag_ids
string

Comma-separated list of tag ids for filtering. Requires Tier 3 subscription

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 transactions