GET
/
v0
/
ledgers
/
{ledger_id}
/
transactions
/
{transaction_id}
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/ledgers/{ledger_id}/transactions/{transaction_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "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.

transaction_id
string
required

The Transaction ID.

Query Parameters

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

Response

200 - application/json
id
string
required

The unique ID of the object. This is used as an idempotency key to prevent duplicates. This is manually set as part of the create transactions request. If the transaction is created via a data integration, Plaid for example, it will be set to the transaction_id to enforce idempotency with the data source.

amount
number
required

The value of the transaction in decimal dollar cents.

datetime
string
required

The UTC datetime that the Transaction was created. This will never be before an Instance's entries_start date. When importing transactions, transactions whose datetime is before the Instance’s entries_start date will be skipped. Other transactions will be processed as normal.

description
string
required

An arbitrary string on the object, useful for displaying information to the user.

metadata
object | null

Arbitrary structured information about the transaction. This could be location of the transaction to display to the user or vendor information to use as part of a Platform or Instance categorization rule. Teal does not use metadata for any accounting purposes.

categorization_method
enum<string> | null

How the Transaction was assigned its category.

See the categorization guide for more details.

Available options:
ai,
rules,
similarity,
transfer_between_accounts,
uncategorized,
user
posted_status
enum<string>
required

Indicates if the corresponding journal entry and line entries for the transaction have been have been created. deleted indicates that the transaction is posted but the corresponding journal entry and line entries have been deleted.

Available options:
not_posted,
posted,
deleted
review_status
enum<string>
required

Indicates if the transaction has been reviewed. See the reviewing transactions for steps on how to use this.

Available options:
unreviewed,
reviewed
journal_entry_id
string | null

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

journal_entry
object | null

The transaction's Journal Entry. Included in expanded responses.

ledger_id
string | null

The ID of the financial account ledger associated with the Transaction.

ledger
object | null

The transaction's ledger. Included in expanded responses.

line_entry_id
string | null

The ID of the financial account ledger associated with the Transaction.

line_entry
object | null

The transaction's Line Entry. Included in expanded responses.

opposing_line_entry_ids
string[] | null

A list of IDs of all the Line Entries objects in the journal entry with the opposite credit_debit status. For example if the Transaction's line entry is a debit this opposing line entries will be credit line entries.

opposing_line_entries
object[] | null

The transaction's opposing Line Entry. Included in expanded responses.

tags
object[] | null

A list of all the Tags associated with the Transaction, if any. Note that Tags are not transitive and the tags on a Transaction can be different than those on its line entry or entires.

personal
boolean
required

Whether the transaction is a non-business personal transaction.