GET
/
v0
/
source-accounts
/
{source_account_id}
/
transactions
/
{transaction_id}
Retrieve a Transaction
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/source-accounts/{source_account_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": null,
  "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"
    ]
  },
  "source_account_id": "<string>",
  "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
  "ledger": {
    "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"
  },
  "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": null,
  "personal": false,
  "transfer_id": "CiUq74HpwS4KVz2WhLzAHS",
  "transfer": {
    "from_journal_entry_id": "DcHePKd9HabmEYJZQzHTMW",
    "id": "CiUq74HpwS4KVz2WhLzAHS",
    "matched_transaction": {
      "amount": 31282.28,
      "datetime": "2023-02-15T06:42:18Z",
      "description": "Payroll#230215",
      "id": "txn_UjL3BQnEaJtecuC7CUeDk",
      "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
      "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
      "line_entry_id": "XMDsKVuW4Wmi3LTW31Qw6E",
      "personal": false,
      "posted_status": "posted",
      "review_status": "reviewed",
      "source_account_id": "L7RR1Yz85FJoASPvPLs441"
    },
    "matched_transaction_id": "aiLXjeYEJymAmg2TzkZ9x",
    "to_journal_entry_id": "EXiLQL1auA89xtVk9yWdpd"
  }
}

Authorizations

​
Authorization
string
header
required

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

​
source_account_id
string
required

The Source Account ID.

​
transaction_id
string
required

The Transaction ID.

Query Parameters

​
expand
enum<string>[] | null

Comma-separated list of Transaction expand paths.

Response

Successful Response

​
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.

Examples:

"t_9237232"

​
amount
number
required

The value of the transaction in decimal dollar cents.

Examples:

132629.38

​
datetime
string<date-time>
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.

Examples:

"2024-03-15T15:28:53Z"

​
description
string
required

An arbitrary string on the object, useful for displaying information to the user. Descriptions over 512 characters will be truncated.

Examples:

"Payroll March 15 2024"

​
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
​
source_account_id
string
required

The ID of the transaction source account where the transaction is stored.

​
personal
boolean
required

Whether the transaction is a non-business personal transaction.

Examples:

false

​
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.

Examples:

null

​
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
Examples:

"similarity"

​
journal_entry_id
string | null

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

Examples:

"C4ocnUQze8kDwQ3EczkZXn"

​
journal_entry
object | null

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

Examples:
{
  "datetime": "2023-02-15T06:42:18Z",
  "description": "Payroll#230215",
  "id": "C4ocnUQze8kDwQ3EczkZXn",
  "line_entry_ids": [
    "XMDsKVuW4Wmi3LTW31Qw6E",
    "NULcvXTkLczde32qs1rqgB"
  ]
}
​
ledger_id
string | null

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

Examples:

"7JRNsKwy2Lw66caxVU7WGC"

​
ledger
object | null

The transaction's ledger. Included in expanded responses.

Examples:
{
  "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"
}
​
line_entry_id
string | null

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

Examples:

"XMDsKVuW4Wmi3LTW31Qw6E"

​
line_entry
object | null

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

Examples:
{
  "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
string[] | null

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

Examples:
["NULcvXTkLczde32qs1rqgB"]
​
opposing_line_entries
ExpandableDetailedLineEntry · object[] | null

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

Examples:
[
  {
    "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
Tag · 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.

Examples:

null

​
transfer_id
string | null

The ID of the Transfer

Examples:

"CiUq74HpwS4KVz2WhLzAHS"

​
transfer
object | null

The transaction's ledger. Included in expanded responses.

Examples:
{
  "from_journal_entry_id": "DcHePKd9HabmEYJZQzHTMW",
  "id": "CiUq74HpwS4KVz2WhLzAHS",
  "matched_transaction": {
    "amount": 31282.28,
    "datetime": "2023-02-15T06:42:18Z",
    "description": "Payroll#230215",
    "id": "txn_UjL3BQnEaJtecuC7CUeDk",
    "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
    "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
    "line_entry_id": "XMDsKVuW4Wmi3LTW31Qw6E",
    "personal": false,
    "posted_status": "posted",
    "review_status": "reviewed",
    "source_account_id": "L7RR1Yz85FJoASPvPLs441"
  },
  "matched_transaction_id": "aiLXjeYEJymAmg2TzkZ9x",
  "to_journal_entry_id": "EXiLQL1auA89xtVk9yWdpd"
}