Skip to main content
GET
Retrieve a Transaction Processing Task

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your auth token.

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
Example:

"UjL3BQnEaJtecuC7CUeDk"

status
enum<string>
required

Status of the transaction processing task

Available options:
pending,
posted,
complete,
failed
Example:

"pending"

created_datetime
string<date-time>
required

Indicates the datetime in UTC when the task was created.

Example:

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

updated_datetime
string<date-time> | null
required

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

Example:

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

error
PlaidError · object
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.

Example:

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.

Example:

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

failed_transaction_ids
string[] | null

The IDs of Transactions that failed to process in this task.