GET
/
v0
/
ledgers
/
{ledger_id}
/
transactions
/
{transaction_id}
/
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>'
{
  "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

transaction_id
string
required

The ID of the transaction.

ledger_id
string
required

The ID of the ledger that contains the transaction.

Response

200 - application/json
categories
object[]
required

List of categories for the transaction

journal_entry_id
string | null
required

The Journal Entry ID for a posted transaction.

ledger
object
required

The ledger tied to the transaction

transaction
object
required

The transaction object