Teal API Endpoints
API Migration
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": "<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": {
"datetime": "2023-02-15T06:42:18Z",
"description": "Payroll#230215",
"id": "C4ocnUQze8kDwQ3EczkZXn",
"line_entry_ids": [
"XMDsKVuW4Wmi3LTW31Qw6E",
"NULcvXTkLczde32qs1rqgB"
]
},
"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,
"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"
}
}Retrieve a Transaction from a Ledger
Returns a single Transaction via the ledger ID. Deprecated, use source account endpoints.
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": "<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": {
"datetime": "2023-02-15T06:42:18Z",
"description": "Payroll#230215",
"id": "C4ocnUQze8kDwQ3EczkZXn",
"line_entry_ids": [
"XMDsKVuW4Wmi3LTW31Qw6E",
"NULcvXTkLczde32qs1rqgB"
]
},
"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,
"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
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
The Teal instance ID
Path Parameters
The Ledger ID.
The Transaction ID.
Query Parameters
Comma-separated list of Transaction expand paths.
ledger, line_entry, journal_entry, opposing_line_entries, opposing_line_entries.ledger, transfer, transfer.matched_transaction, transfer.matched_transaction.ledger, transfer.from_journal_entry, transfer.to_journal_entry Response
Successful Response
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.
The value of the transaction in decimal dollar cents.
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.
An arbitrary string on the object, useful for displaying information to the user. Descriptions over 512 characters will be truncated.
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.
not_posted, posted, deleted Indicates if the transaction has been reviewed. See the reviewing transactions for steps on how to use this.
unreviewed, reviewed The ID of the transaction source account where the transaction is stored.
Whether the transaction is a non-business personal transaction.
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.
Show child attributes
Show child attributes
null
How the Transaction was assigned its category.
See the categorization guide for more details.
ai, rules, similarity, transfer_between_accounts, uncategorized, user "similarity"
The ID of the Journal Entry that the Transaction's Line Entry is associated with.
"C4ocnUQze8kDwQ3EczkZXn"
The transaction's Journal Entry. Included in expanded responses.
Show child attributes
Show child attributes
The unique ID of the object.
An arbitrary string on the object, useful for displaying to the user.
The datetime the Journal Entry was created in UTC time.
A list of files attached to the Journal Entry.
null
The ids of the Line Entries detailing the Journal
Entry's movement of value. Only null if the Instance is using QuickBooks as
their accounting package.
[
"XMDsKVuW4Wmi3LTW31Qw6E",
"NULcvXTkLczde32qs1rqgB"
]The entity that is linked with this journal entry. Journal entries with linked entities may not be modified or deleted directly.
{
"datetime": "2023-02-15T06:42:18Z",
"description": "Payroll#230215",
"id": "C4ocnUQze8kDwQ3EczkZXn",
"line_entry_ids": [
"XMDsKVuW4Wmi3LTW31Qw6E",
"NULcvXTkLczde32qs1rqgB"
]
}The ID of the financial account ledger associated with the Transaction.
"7JRNsKwy2Lw66caxVU7WGC"
The transaction's ledger. Included in expanded responses.
Show child attributes
Show child attributes
The unique ID of the object.
The name of the ledger.
Indicates if the ledger is a credit or debit ledger.
debit, credit Whether line entries can be manually added or removed from the ledger.
Indicates that the ledger is one of the four system ledgers required for Teal to work. In the default chart of accounts, these are named one of: Transfers Between Accounts, Opening Balance Retained Earnings, Uncategorized Cash Inflow, Uncategorized Cash Outflow. You can update the names of these to fit your needs.
If the ledger is a child Ledger, the ID of the parent ledger object.
null
Whether Teal includes this ledger in the cash flow report.
Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, 20010 will come before 3050.
Indicates similar characteristics and accounting treatment for a group of ledgers within a type.
current_assets, non-current_assets, transfers_between_accounts, uncategorized_assets, current_liabilities, non-current_liabilities, equity, operating_revenues, other_income, cost_of_goods_sold, operating_expenses, other_expenses Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: asset, liability and equity ledgers are displayed on the balance sheet; revenue and expenses are displayed on the income statement.
asset, liability, equity, revenue, expense The datetime when the ledger was created.
Indicates that the ledger represents a real-world financial account.
bank_account, credit_card, payments, payroll, loan, prepaid_card, accounts_receivable, accounts_payable "bank_account"
Expandable. If the ledger is a child ledger, the parent ledger object.
{
"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"
}The ID of the financial account ledger associated with the Transaction.
"XMDsKVuW4Wmi3LTW31Qw6E"
The transaction's Line Entry. Included in expanded responses.
Show child attributes
Show child attributes
The value of the line entry in decimal dollar cents.
Indicates if the amount is a credit or debit.
debit, credit The ID of the Line Entry's Ledger. Can be null in some cases for Instances using QuickBooks as their accounting package.
The unique ID of the object. Can be null in some cases for Instances using QuickBooks as their accounting package.
"XMDsKVuW4Wmi3LTW31Qw6E"
The datetime the Line Entry was created in UTC time.
Indicates if the Line Entry can be manually added or removed from a Ledger, as dictated by the editable property on the Ledger.
The ID of the associated Journal Entry. Can be null in some cases for Instances using QuickBooks as their accounting package.
"C4ocnUQze8kDwQ3EczkZXn"
An arbitrary string on the object, useful for displaying to users.
The name of the Line Entry's Ledger.
An arbitrary string on the object, useful for displaying to the user or for categorization.
"Payroll#230215"
If the Line Entry is identified as a transfer between accounts, the ID of the Line Entry in the opposing Ledger. Related guide: Auto-categorization
The ID of the associated Transaction, if one exists.
Expandable. The associated Journal Entry object.
Expandable. The associated Ledger object.
Expandable. IDs of the ledgers on the other side(s) of the line entry with opposite debit/credit.
A list of all the Tags associated with the Line Entry, if any.
Expandable. The associated Transaction object, if one exists.
{
"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"
}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.
["NULcvXTkLczde32qs1rqgB"]The transaction's opposing Line Entry. Included in expanded responses.
Show child attributes
Show child attributes
The value of the line entry in decimal dollar cents.
Indicates if the amount is a credit or debit.
debit, credit The ID of the Line Entry's Ledger. Can be null in some cases for Instances using QuickBooks as their accounting package.
The unique ID of the object. Can be null in some cases for Instances using QuickBooks as their accounting package.
"XMDsKVuW4Wmi3LTW31Qw6E"
The datetime the Line Entry was created in UTC time.
Indicates if the Line Entry can be manually added or removed from a Ledger, as dictated by the editable property on the Ledger.
The ID of the associated Journal Entry. Can be null in some cases for Instances using QuickBooks as their accounting package.
"C4ocnUQze8kDwQ3EczkZXn"
An arbitrary string on the object, useful for displaying to users.
The name of the Line Entry's Ledger.
An arbitrary string on the object, useful for displaying to the user or for categorization.
"Payroll#230215"
If the Line Entry is identified as a transfer between accounts, the ID of the Line Entry in the opposing Ledger. Related guide: Auto-categorization
The ID of the associated Transaction, if one exists.
Expandable. The associated Journal Entry object.
Show child attributes
Show child attributes
The unique ID of the object.
An arbitrary string on the object, useful for displaying to the user.
The datetime the Journal Entry was created in UTC time.
A list of files attached to the Journal Entry.
Show child attributes
Show child attributes
The unique ID of the object.
The name of the file uploaded to the Journal Entry.
If no value is provided or null is specified, defaults to the name
of the file.
"invoice.pdf"
null
The ids of the Line Entries detailing the Journal
Entry's movement of value. Only null if the Instance is using QuickBooks as
their accounting package.
[
"XMDsKVuW4Wmi3LTW31Qw6E",
"NULcvXTkLczde32qs1rqgB"
]The entity that is linked with this journal entry. Journal entries with linked entities may not be modified or deleted directly.
{
"datetime": "2023-02-15T06:42:18Z",
"description": "Payroll#230215",
"id": "C4ocnUQze8kDwQ3EczkZXn",
"line_entry_ids": [
"XMDsKVuW4Wmi3LTW31Qw6E",
"NULcvXTkLczde32qs1rqgB"
]
}Expandable. The associated Ledger object.
Show child attributes
Show child attributes
The unique ID of the object.
The name of the ledger.
Indicates if the ledger is a credit or debit ledger.
debit, credit Whether line entries can be manually added or removed from the ledger.
Indicates that the ledger is one of the four system ledgers required for Teal to work. In the default chart of accounts, these are named one of: Transfers Between Accounts, Opening Balance Retained Earnings, Uncategorized Cash Inflow, Uncategorized Cash Outflow. You can update the names of these to fit your needs.
If the ledger is a child Ledger, the ID of the parent ledger object.
null
Whether Teal includes this ledger in the cash flow report.
Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, 20010 will come before 3050.
Indicates similar characteristics and accounting treatment for a group of ledgers within a type.
current_assets, non-current_assets, transfers_between_accounts, uncategorized_assets, current_liabilities, non-current_liabilities, equity, operating_revenues, other_income, cost_of_goods_sold, operating_expenses, other_expenses Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: asset, liability and equity ledgers are displayed on the balance sheet; revenue and expenses are displayed on the income statement.
asset, liability, equity, revenue, expense The datetime when the ledger was created.
Indicates that the ledger represents a real-world financial account.
bank_account, credit_card, payments, payroll, loan, prepaid_card, accounts_receivable, accounts_payable "bank_account"
Expandable. If the ledger is a child ledger, the parent ledger object.
{
"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": "2240",
"sub_type": "current_assets",
"type": "asset"
}Expandable. IDs of the ledgers on the other side(s) of the line entry with opposite debit/credit.
A list of all the Tags associated with the Line Entry, if any.
Expandable. The associated Transaction object, if one exists.
Show child attributes
Show child attributes
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.
The value of the transaction in decimal dollar cents.
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.
An arbitrary string on the object, useful for displaying information to the user. Descriptions over 512 characters will be truncated.
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.
not_posted, posted, deleted Indicates if the transaction has been reviewed. See the reviewing transactions for steps on how to use this.
unreviewed, reviewed The ID of the transaction source account where the transaction is stored.
Whether the transaction is a non-business personal transaction.
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.
Show child attributes
Show child attributes
null
How the Transaction was assigned its category.
See the categorization guide for more details.
ai, rules, similarity, transfer_between_accounts, uncategorized, user "similarity"
The ID of the Journal Entry that the Transaction's Line Entry is associated with.
"C4ocnUQze8kDwQ3EczkZXn"
Expandable. The associated Journal Entry object.
The ID of the financial account ledger associated with the Transaction.
"7JRNsKwy2Lw66caxVU7WGC"
Expandable. The Ledger object of the financial account associated with the Transaction.
The ID of the financial account ledger associated with the Transaction.
"XMDsKVuW4Wmi3LTW31Qw6E"
Expandable. The associated Line Entry.
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.
["NULcvXTkLczde32qs1rqgB"]Expandable. A list of the Line Entry objects
with the opposite debit_credit status.
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.
Show child attributes
Show child attributes
null
{
"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"
}[
{
"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"
}
]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.
null
The ID of the Transfer
"CiUq74HpwS4KVz2WhLzAHS"
The transaction's ledger. Included in expanded responses.
Show child attributes
Show child attributes
The ID of the Journal Entry on the 'from' side of the Transfer
The ID of the Journal Entry on the 'to' side of the Transfer
The Transfer's 'from' Journal Entry. Included in expanded responses.
Show child attributes
Show child attributes
The unique ID of the object.
An arbitrary string on the object, useful for displaying to the user.
The datetime the Journal Entry was created in UTC time.
A list of files attached to the Journal Entry.
Show child attributes
Show child attributes
null
The ids of the Line Entries detailing the Journal
Entry's movement of value. Only null if the Instance is using QuickBooks as
their accounting package.
[
"XMDsKVuW4Wmi3LTW31Qw6E",
"NULcvXTkLczde32qs1rqgB"
]The entity that is linked with this journal entry. Journal entries with linked entities may not be modified or deleted directly.
List of Line Entries. platformGL instances only. Included in expanded responses.
Show child attributes
Show child attributes
The value of the line entry in decimal dollar cents.
Indicates if the amount is a credit or debit.
debit, credit The ID of the Line Entry's Ledger. Can be null in some cases for Instances using QuickBooks as their accounting package.
The unique ID of the object. Can be null in some cases for Instances using QuickBooks as their accounting package.
"XMDsKVuW4Wmi3LTW31Qw6E"
The datetime the Line Entry was created in UTC time.
Indicates if the Line Entry can be manually added or removed from a Ledger, as dictated by the editable property on the Ledger.
The ID of the associated Journal Entry. Can be null in some cases for Instances using QuickBooks as their accounting package.
"C4ocnUQze8kDwQ3EczkZXn"
An arbitrary string on the object, useful for displaying to users.
The name of the Line Entry's Ledger.
An arbitrary string on the object, useful for displaying to the user or for categorization.
"Payroll#230215"
If the Line Entry is identified as a transfer between accounts, the ID of the Line Entry in the opposing Ledger. Related guide: Auto-categorization
The ID of the associated Transaction, if one exists.
Expandable. The associated Journal Entry object.
Show child attributes
Show child attributes
The unique ID of the object.
An arbitrary string on the object, useful for displaying to the user.
The datetime the Journal Entry was created in UTC time.
A list of files attached to the Journal Entry.
Show child attributes
Show child attributes
The unique ID of the object.
The name of the file uploaded to the Journal Entry.
If no value is provided or null is specified, defaults to the name
of the file.
"invoice.pdf"
null
The ids of the Line Entries detailing the Journal
Entry's movement of value. Only null if the Instance is using QuickBooks as
their accounting package.
[
"XMDsKVuW4Wmi3LTW31Qw6E",
"NULcvXTkLczde32qs1rqgB"
]The entity that is linked with this journal entry. Journal entries with linked entities may not be modified or deleted directly.
{
"datetime": "2023-02-15T06:42:18Z",
"description": "Payroll#230215",
"id": "C4ocnUQze8kDwQ3EczkZXn",
"line_entry_ids": [
"XMDsKVuW4Wmi3LTW31Qw6E",
"NULcvXTkLczde32qs1rqgB"
]
}Expandable. The associated Ledger object.
Show child attributes
Show child attributes
The unique ID of the object.
The name of the ledger.
Indicates if the ledger is a credit or debit ledger.
debit, credit Whether line entries can be manually added or removed from the ledger.
Indicates that the ledger is one of the four system ledgers required for Teal to work. In the default chart of accounts, these are named one of: Transfers Between Accounts, Opening Balance Retained Earnings, Uncategorized Cash Inflow, Uncategorized Cash Outflow. You can update the names of these to fit your needs.
If the ledger is a child Ledger, the ID of the parent ledger object.
null
Whether Teal includes this ledger in the cash flow report.
Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, 20010 will come before 3050.
Indicates similar characteristics and accounting treatment for a group of ledgers within a type.
current_assets, non-current_assets, transfers_between_accounts, uncategorized_assets, current_liabilities, non-current_liabilities, equity, operating_revenues, other_income, cost_of_goods_sold, operating_expenses, other_expenses Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: asset, liability and equity ledgers are displayed on the balance sheet; revenue and expenses are displayed on the income statement.
asset, liability, equity, revenue, expense The datetime when the ledger was created.
Indicates that the ledger represents a real-world financial account.
bank_account, credit_card, payments, payroll, loan, prepaid_card, accounts_receivable, accounts_payable "bank_account"
Expandable. If the ledger is a child ledger, the parent ledger object.
{
"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": "2240",
"sub_type": "current_assets",
"type": "asset"
}Expandable. IDs of the ledgers on the other side(s) of the line entry with opposite debit/credit.
A list of all the Tags associated with the Line Entry, if any.
Show child attributes
Show child attributes
The unique ID of the object.
An arbitrary string, useful for identifying the tag to the user.
The ID of the tag group.
Expandable. The associated Transaction object, if one exists.
Show child attributes
Show child attributes
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.
The value of the transaction in decimal dollar cents.
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.
An arbitrary string on the object, useful for displaying information to the user. Descriptions over 512 characters will be truncated.
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.
not_posted, posted, deleted Indicates if the transaction has been reviewed. See the reviewing transactions for steps on how to use this.
unreviewed, reviewed The ID of the transaction source account where the transaction is stored.
Whether the transaction is a non-business personal transaction.
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.
Show child attributes
Show child attributes
null
How the Transaction was assigned its category.
See the categorization guide for more details.
ai, rules, similarity, transfer_between_accounts, uncategorized, user "similarity"
The ID of the Journal Entry that the Transaction's Line Entry is associated with.
"C4ocnUQze8kDwQ3EczkZXn"
Expandable. The associated Journal Entry object.
The ID of the financial account ledger associated with the Transaction.
"7JRNsKwy2Lw66caxVU7WGC"
Expandable. The Ledger object of the financial account associated with the Transaction.
The ID of the financial account ledger associated with the Transaction.
"XMDsKVuW4Wmi3LTW31Qw6E"
Expandable. The associated Line Entry.
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.
["NULcvXTkLczde32qs1rqgB"]Expandable. A list of the Line Entry objects
with the opposite debit_credit status.
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.
Show child attributes
Show child attributes
The unique ID of the object.
An arbitrary string, useful for identifying the tag to the user.
The ID of the tag group.
null
{
"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"
}[
{
"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",
"tags": [],
"transaction_id": "txn_UjL3BQnEaJtecuC7CUeDk"
},
{
"amount": 31282.28,
"datetime": "2023-02-15T06:42:18Z",
"debit_credit": "credit",
"description": "Payroll#230215",
"editable": false,
"id": "NULcvXTkLczde32qs1rqgB",
"journal_entry_description": "Payroll#230215",
"journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
"ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
"ledger_name": "Payroll Expense",
"tags": []
}
]The Transfer's 'to' Journal Entry. Included in expanded responses.
Show child attributes
Show child attributes
The unique ID of the object.
An arbitrary string on the object, useful for displaying to the user.
The datetime the Journal Entry was created in UTC time.
A list of files attached to the Journal Entry.
Show child attributes
Show child attributes
null
The ids of the Line Entries detailing the Journal
Entry's movement of value. Only null if the Instance is using QuickBooks as
their accounting package.
[
"XMDsKVuW4Wmi3LTW31Qw6E",
"NULcvXTkLczde32qs1rqgB"
]The entity that is linked with this journal entry. Journal entries with linked entities may not be modified or deleted directly.
List of Line Entries. platformGL instances only. Included in expanded responses.
Show child attributes
Show child attributes
The value of the line entry in decimal dollar cents.
Indicates if the amount is a credit or debit.
debit, credit The ID of the Line Entry's Ledger. Can be null in some cases for Instances using QuickBooks as their accounting package.
The unique ID of the object. Can be null in some cases for Instances using QuickBooks as their accounting package.
"XMDsKVuW4Wmi3LTW31Qw6E"
The datetime the Line Entry was created in UTC time.
Indicates if the Line Entry can be manually added or removed from a Ledger, as dictated by the editable property on the Ledger.
The ID of the associated Journal Entry. Can be null in some cases for Instances using QuickBooks as their accounting package.
"C4ocnUQze8kDwQ3EczkZXn"
An arbitrary string on the object, useful for displaying to users.
The name of the Line Entry's Ledger.
An arbitrary string on the object, useful for displaying to the user or for categorization.
"Payroll#230215"
If the Line Entry is identified as a transfer between accounts, the ID of the Line Entry in the opposing Ledger. Related guide: Auto-categorization
The ID of the associated Transaction, if one exists.
Expandable. The associated Journal Entry object.
Show child attributes
Show child attributes
The unique ID of the object.
An arbitrary string on the object, useful for displaying to the user.
The datetime the Journal Entry was created in UTC time.
A list of files attached to the Journal Entry.
Show child attributes
Show child attributes
The unique ID of the object.
The name of the file uploaded to the Journal Entry.
If no value is provided or null is specified, defaults to the name
of the file.
"invoice.pdf"
null
The ids of the Line Entries detailing the Journal
Entry's movement of value. Only null if the Instance is using QuickBooks as
their accounting package.
[
"XMDsKVuW4Wmi3LTW31Qw6E",
"NULcvXTkLczde32qs1rqgB"
]The entity that is linked with this journal entry. Journal entries with linked entities may not be modified or deleted directly.
{
"datetime": "2023-02-15T06:42:18Z",
"description": "Payroll#230215",
"id": "C4ocnUQze8kDwQ3EczkZXn",
"line_entry_ids": [
"XMDsKVuW4Wmi3LTW31Qw6E",
"NULcvXTkLczde32qs1rqgB"
]
}Expandable. The associated Ledger object.
Show child attributes
Show child attributes
The unique ID of the object.
The name of the ledger.
Indicates if the ledger is a credit or debit ledger.
debit, credit Whether line entries can be manually added or removed from the ledger.
Indicates that the ledger is one of the four system ledgers required for Teal to work. In the default chart of accounts, these are named one of: Transfers Between Accounts, Opening Balance Retained Earnings, Uncategorized Cash Inflow, Uncategorized Cash Outflow. You can update the names of these to fit your needs.
If the ledger is a child Ledger, the ID of the parent ledger object.
null
Whether Teal includes this ledger in the cash flow report.
Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, 20010 will come before 3050.
Indicates similar characteristics and accounting treatment for a group of ledgers within a type.
current_assets, non-current_assets, transfers_between_accounts, uncategorized_assets, current_liabilities, non-current_liabilities, equity, operating_revenues, other_income, cost_of_goods_sold, operating_expenses, other_expenses Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: asset, liability and equity ledgers are displayed on the balance sheet; revenue and expenses are displayed on the income statement.
asset, liability, equity, revenue, expense The datetime when the ledger was created.
Indicates that the ledger represents a real-world financial account.
bank_account, credit_card, payments, payroll, loan, prepaid_card, accounts_receivable, accounts_payable "bank_account"
Expandable. If the ledger is a child ledger, the parent ledger object.
{
"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": "2240",
"sub_type": "current_assets",
"type": "asset"
}Expandable. IDs of the ledgers on the other side(s) of the line entry with opposite debit/credit.
A list of all the Tags associated with the Line Entry, if any.
Show child attributes
Show child attributes
The unique ID of the object.
An arbitrary string, useful for identifying the tag to the user.
The ID of the tag group.
Expandable. The associated Transaction object, if one exists.
Show child attributes
Show child attributes
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.
The value of the transaction in decimal dollar cents.
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.
An arbitrary string on the object, useful for displaying information to the user. Descriptions over 512 characters will be truncated.
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.
not_posted, posted, deleted Indicates if the transaction has been reviewed. See the reviewing transactions for steps on how to use this.
unreviewed, reviewed The ID of the transaction source account where the transaction is stored.
Whether the transaction is a non-business personal transaction.
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.
Show child attributes
Show child attributes
null
How the Transaction was assigned its category.
See the categorization guide for more details.
ai, rules, similarity, transfer_between_accounts, uncategorized, user "similarity"
The ID of the Journal Entry that the Transaction's Line Entry is associated with.
"C4ocnUQze8kDwQ3EczkZXn"
Expandable. The associated Journal Entry object.
The ID of the financial account ledger associated with the Transaction.
"7JRNsKwy2Lw66caxVU7WGC"
Expandable. The Ledger object of the financial account associated with the Transaction.
The ID of the financial account ledger associated with the Transaction.
"XMDsKVuW4Wmi3LTW31Qw6E"
Expandable. The associated Line Entry.
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.
["NULcvXTkLczde32qs1rqgB"]Expandable. A list of the Line Entry objects
with the opposite debit_credit status.
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.
Show child attributes
Show child attributes
The unique ID of the object.
An arbitrary string, useful for identifying the tag to the user.
The ID of the tag group.
null
{
"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"
}[
{
"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",
"tags": [],
"transaction_id": "txn_UjL3BQnEaJtecuC7CUeDk"
},
{
"amount": 31282.28,
"datetime": "2023-02-15T06:42:18Z",
"debit_credit": "credit",
"description": "Payroll#230215",
"editable": false,
"id": "NULcvXTkLczde32qs1rqgB",
"journal_entry_description": "Payroll#230215",
"journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
"ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
"ledger_name": "Payroll Expense",
"tags": []
}
]The Transfer's 'from' Transaction. Included in expanded responses.
Show child attributes
Show child attributes
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.
The value of the transaction in decimal dollar cents.
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.
An arbitrary string on the object, useful for displaying information to the user. Descriptions over 512 characters will be truncated.
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.
not_posted, posted, deleted Indicates if the transaction has been reviewed. See the reviewing transactions for steps on how to use this.
unreviewed, reviewed The ID of the transaction source account where the transaction is stored.
Whether the transaction is a non-business personal transaction.
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.
Show child attributes
Show child attributes
null
How the Transaction was assigned its category.
See the categorization guide for more details.
ai, rules, similarity, transfer_between_accounts, uncategorized, user "similarity"
The ID of the Journal Entry that the Transaction's Line Entry is associated with.
"C4ocnUQze8kDwQ3EczkZXn"
Expandable. The associated Journal Entry object.
The ID of the financial account ledger associated with the Transaction.
"7JRNsKwy2Lw66caxVU7WGC"
The transaction's ledger. Included in expanded responses.
Show child attributes
Show child attributes
The unique ID of the object.
The name of the ledger.
Indicates if the ledger is a credit or debit ledger.
debit, credit Whether line entries can be manually added or removed from the ledger.
Indicates that the ledger is one of the four system ledgers required for Teal to work. In the default chart of accounts, these are named one of: Transfers Between Accounts, Opening Balance Retained Earnings, Uncategorized Cash Inflow, Uncategorized Cash Outflow. You can update the names of these to fit your needs.
If the ledger is a child Ledger, the ID of the parent ledger object.
null
Whether Teal includes this ledger in the cash flow report.
Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, 20010 will come before 3050.
Indicates similar characteristics and accounting treatment for a group of ledgers within a type.
current_assets, non-current_assets, transfers_between_accounts, uncategorized_assets, current_liabilities, non-current_liabilities, equity, operating_revenues, other_income, cost_of_goods_sold, operating_expenses, other_expenses Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: asset, liability and equity ledgers are displayed on the balance sheet; revenue and expenses are displayed on the income statement.
asset, liability, equity, revenue, expense The datetime when the ledger was created.
Indicates that the ledger represents a real-world financial account.
bank_account, credit_card, payments, payroll, loan, prepaid_card, accounts_receivable, accounts_payable "bank_account"
Expandable. If the ledger is a child ledger, the parent ledger object.
The ID of the financial account ledger associated with the Transaction.
"XMDsKVuW4Wmi3LTW31Qw6E"
Expandable. The associated Line Entry.
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.
["NULcvXTkLczde32qs1rqgB"]Expandable. A list of the Line Entry objects
with the opposite debit_credit status.
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.
Show child attributes
Show child attributes
null
{
"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"
}