GET
/
v0
/
transactions
/
tasks
/
{task_id}
Retrieve a Transaction Processing Task
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/transactions/tasks/{task_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "id": "UjL3BQnEaJtecuC7CUeDk",
  "status": "pending",
  "created_datetime": "2024-01-01T00:00:00Z",
  "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

​
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

​
task_id
string
required

The Transaction Processing Task ID.

Response

Successful Response

​
id
string
required
Examples:

"UjL3BQnEaJtecuC7CUeDk"

​
status
enum<string>
required

Indicates the status of the task.

Available options:
pending,
failed,
complete
​
created_datetime
string<date-time>
required

Indicates the datetime in UTC when the task was created.

Examples:

"2024-01-01T00:00:00Z"

​
updated_datetime
string<date-time> | null
required

Indicates the datetime in UTC when the task was last updated.

Examples:

"2024-01-01T00:00:00Z"

​
error
object | null
required

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.

Examples:

null

​
source_account_id
string
required

The source account containing the transactions

​
task_type
enum<string>
required

Type of transaction processing task

Available options:
import_transactions,
recategorization,
delete_date_range,
set_business_flag,
process_aged_unposted,
retry_unposted,
legacy
​
ledger_id
string | null
required

The ID of the ledger that the transactions are being created for.

Examples:

"7JRNsKwy2Lw66caxVU7WGC"

​
created_transaction_ids
string[] | null

The IDs of Transactions successfully processed by this task.

​
removed_transaction_ids
string[] | null

The IDs of Transactions that were removed by this task.

​
modified_transaction_ids
string[] | null

The IDs of Transactions that were modified by this task.

​
skipped_transaction_ids
string[] | null

The IDs of Transactions that were skipped by this task.