Skip to main content
GET
/
v0
/
ledgers
/
{ledger_id}
/
transactions
/
{transaction_id}
/
categories
Retrieve a Ledger Transaction's categories
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/ledgers/{ledger_id}/transactions/{transaction_id}/categories \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "transaction": {
    "id": "<string>",
    "amount": 123,
    "datetime": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "posted_status": "not_posted",
    "review_status": "unreviewed",
    "source_account_id": "<string>",
    "personal": true,
    "metadata": null,
    "categorization_method": "similarity",
    "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
    "journal_entry": "<unknown>",
    "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
    "ledger": "<unknown>",
    "line_entry_id": "XMDsKVuW4Wmi3LTW31Qw6E",
    "line_entry": "<unknown>",
    "opposing_line_entry_ids": [
      "NULcvXTkLczde32qs1rqgB"
    ],
    "opposing_line_entries": "<unknown>",
    "tags": null
  },
  "categories": [
    {
      "ledger_id": "<string>",
      "ledger_name": "<string>",
      "editable": true
    }
  ],
  "ledger": {
    "id": "<string>",
    "name": "<string>",
    "debit_credit": "debit",
    "editable": true,
    "is_required": true,
    "parent_id": null,
    "report_cash_flow": true,
    "sort_code": "<string>",
    "sub_type": "current_assets",
    "type": "asset",
    "created_at": "2023-11-07T05:31:56Z",
    "financial_account_type": "bank_account",
    "required_ledger_purpose": "account_transfers",
    "parent": "<unknown>"
  },
  "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
teal-instance-id
string
required

The Teal instance ID

Path Parameters

​
transaction_id
string
required

The Transaction ID.

​
ledger_id
string
required

The Ledger ID.

Response

Successful Response

​
transaction
Transaction · object
required

The Transaction object.

Example:
{
  "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",
  "source_account_id": "L7RR1Yz85FJoASPvPLs441"
}
​
categories
Category · object[]
required

A list of the categories of the Transaction.

Example:
[
  {
    "editable": true,
    "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
    "ledger_name": "Payroll Expense"
  }
]
​
ledger
Ledger · object
required

The Ledger object of the financial account associated with the Transaction.

Example:
{
  "created_at": "2024-01-01T00:00:00",
  "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
string | null

The ID of the Journal Entry that the Transaction's Line Entry is associated with.

Example:

"C4ocnUQze8kDwQ3EczkZXn"