Teal API Endpoints
API Migration
curl --request GET \
--url https://api.sandbox.teal.dev/v0/sources/plaid/links/status \
--header 'Authorization: Bearer <token>'{
"next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
"prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
"records": [
{
"token_handle": {
"id": "<string>",
"type": "plaid",
"date": "2023-11-07T05:31:56Z",
"enabled": 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",
"parent": "<unknown>"
},
"instance": {
"id": "<string>",
"entries_start": "2023-11-07T05:31:56Z",
"name": "<string>",
"subscription": "tier0",
"accounting_package": "platformgl",
"parent_id": "Kv7sp6Y1gAH2vfNxAWemRy",
"child_ids": "['A5SswbYm7eZM2ec5q7Hm2t']",
"parent": "<unknown>",
"children": [
"<unknown>"
]
},
"txn_processing_task": {
"id": "<string>",
"status": "pending",
"created_datetime": "2023-11-07T05:31:56Z",
"updated_datetime": "2024-01-01T00:00:00Z",
"error": null,
"source_account_id": "<string>",
"task_type": "import_transactions",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"created_transaction_ids": [
"<string>"
],
"removed_transaction_ids": [
"<string>"
],
"modified_transaction_ids": [
"<string>"
],
"skipped_transaction_ids": [
"<string>"
]
}
}
]
}Get Plaid Link Statuses
Returns the status of all Plaid connected financial account ledgers on the platform.
curl --request GET \
--url https://api.sandbox.teal.dev/v0/sources/plaid/links/status \
--header 'Authorization: Bearer <token>'{
"next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
"prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
"records": [
{
"token_handle": {
"id": "<string>",
"type": "plaid",
"date": "2023-11-07T05:31:56Z",
"enabled": 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",
"parent": "<unknown>"
},
"instance": {
"id": "<string>",
"entries_start": "2023-11-07T05:31:56Z",
"name": "<string>",
"subscription": "tier0",
"accounting_package": "platformgl",
"parent_id": "Kv7sp6Y1gAH2vfNxAWemRy",
"child_ids": "['A5SswbYm7eZM2ec5q7Hm2t']",
"parent": "<unknown>",
"children": [
"<unknown>"
]
},
"txn_processing_task": {
"id": "<string>",
"status": "pending",
"created_datetime": "2023-11-07T05:31:56Z",
"updated_datetime": "2024-01-01T00:00:00Z",
"error": null,
"source_account_id": "<string>",
"task_type": "import_transactions",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"created_transaction_ids": [
"<string>"
],
"removed_transaction_ids": [
"<string>"
],
"modified_transaction_ids": [
"<string>"
],
"skipped_transaction_ids": [
"<string>"
]
}
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
The Instance ID
The number of records to return. Max limit is 1000.
1 <= x < 1001Response
Successful Response
The token to use to request the next page
"ikal0NEVfMhF8dJf4yQ6KQZmGD"
The token to use to request the previous page
"vuA7JeKI5c6FLnPt5JfRcZcJxW"
List of source account statuses
Show child attributes
Show child attributes
Show child attributes
Show child attributes
plaid, unit, quickbooks, manual The date the token was last updated.
If the transaction source is active
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.
Show child attributes
Show child attributes
The unique ID of the object.
The datetime in UTC time from which the API will sync an Instance's accounting data. Transactions or journal entries cannot be entered before this date.
The name of the business.
The Instance's subscription tier.
tier0, tier1, tier2, tier3, tier4, tier5 The type of accounting package the Instance uses as the source of truth for their books.
platformgl, quickbooks The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's parent. Included in expanded responses.
The Instance's children. Included in expanded responses.
Show child attributes
Show child attributes
Indicates the status of the task.
pending, failed, complete Indicates the datetime in UTC when the task was created.
Indicates the datetime in UTC when the task was last updated.
"2024-01-01T00:00:00Z"
The Error object if any errors were encountered in the processing. If the processing task was created by a Plaid import, the Plaid errors will be passed through there. See Plaid's documentation for more information on their error messages.
- PlaidError
- GeneralError
Show child attributes
Show child attributes
The Plaid error type.
The Plaid error code.
The Plaid error message.
A display message supplied by Plaid.
"Something went wrong."
The Plaid request identifier.
"KipL51BWnPIpOmi"
The status code returned from Plaid.
500
A url to Plaid's documentation about the error.
"https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error"
Plaid's suggested action to resolve the error.
null
The source account containing the transactions
Type of transaction processing task
import_transactions, recategorization, delete_date_range, set_business_flag, process_aged_unposted, retry_unposted, legacy The ID of the ledger that the transactions are being created for.
"7JRNsKwy2Lw66caxVU7WGC"
The IDs of Transactions successfully processed by this task.
The IDs of Transactions that were removed by this task.
The IDs of Transactions that were modified by this task.
The IDs of Transactions that were skipped by this task.