List Transaction Processing Tasks

curl --request GET \
  --url https://api.sandbox.teal.dev/v0/transactions/tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'

{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "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

transactions

tasks

List Transaction Processing Tasks

curl --request GET \
  --url https://api.sandbox.teal.dev/v0/transactions/tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'

{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "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

Authorization

string

header

required

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

Headers

teal-instance-id

string

required

The Teal instance ID

Query Parameters

source_account_id

string | null

The source account id

status

enum<string> | null

The Transaction Processing Task status

Available options:

pending,

failed,

complete

sort

enum<string>[] | null

A comma separated list of sort orders for the results.

Available options:

created_datetime,

-created_datetime

limit

integer

default:50

The number of records to return. Max limit is 1000.

Required range: x >= 1

page_token

string | null

Opaque page token

Response

Successful Response

next_page_token

string | null

required

The token to use to request the next page

Example:

"ikal0NEVfMhF8dJf4yQ6KQZmGD"

prev_page_token

string | null

required

The token to use to request the previous page

Example:

"vuA7JeKI5c6FLnPt5JfRcZcJxW"

records

TxnProcessingTask · object[]

required

A list of Transaction Processing Tasks

Show child attributes

records.id

string

required

records.status

enum<string>

required

Indicates the status of the task.

Available options:

pending,

failed,

complete

records.created_datetime

string<date-time>

required

Indicates the datetime in UTC when the task was created.

records.updated_datetime

string<date-time> | null

required

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

Example:

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

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

PlaidError
GeneralError

Show child attributes

records.error.error_type

string

required

The Plaid error type.

records.error.error_code

string

required

The Plaid error code.

records.error.error_message

string

required

The Plaid error message.

records.error.display_message

string | null

A display message supplied by Plaid.

Example:

"Something went wrong."

records.error.request_id

string | null

The Plaid request identifier.

Example:

"KipL51BWnPIpOmi"

records.error.causes

any[] | null

records.error.status

integer | null

The status code returned from Plaid.

Example:

500

records.error.documentation_url

string | null

A url to Plaid's documentation about the error.

Example:

"https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error"

records.error.suggested_action

string | null

Plaid's suggested action to resolve the error.

Example:

null

records.source_account_id

string

required

The source account containing the transactions

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

records.ledger_id

string | null

required

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

Example:

"7JRNsKwy2Lw66caxVU7WGC"

records.created_transaction_ids

string[] | null

The IDs of Transactions successfully processed by this task.

records.removed_transaction_ids

string[] | null

The IDs of Transactions that were removed by this task.

records.modified_transaction_ids

string[] | null

The IDs of Transactions that were modified by this task.

records.skipped_transaction_ids

string[] | null

The IDs of Transactions that were skipped by this task.

List a Source Account's Transactions Retrieve a Transaction Processing Task

⌘I

API overview

Teal API Endpoints

API Migration

List Transaction Processing Tasks

Authorizations

Headers

Query Parameters

Response