POST
/
v0
/
sources
/
plaid

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

teal-instance-id
string
required

The Teal instance ID

Body

application/json
p_token
string
required

The permanent Plaid processor token

calculate_opening_balance
boolean | null
default: false

If true the opening balance will be calculated automatically

start_date
string | null

The start date of transactions to sync. Only transactions after this date will be imported. If not provided, transactions will be imported up to the instance's entries start date

ledger_id
string | null

The ledger where transactions are automatically posted for business accounts. If not provided, a ledger will be automatically created for business accounts.

draw_ledger_id
string | null

The ledger where business transaction in personal accounts will be posted if they draw from the business. Only provide this parameter for personal accounts.

contribution_ledger_id
string | null

The ledger where business transactions in personal accounts will be posted if they contribute to the business. Only provide this parameter for personal accounts.

sync_pending_transactions
boolean
default: true

True If pending transactions should be synced. False if they should be ignored.

Response

201 - application/json
id
string
required
status
enum<string>
required

Indicates the status of the task.

Available options:
pending,
failed,
complete
created_datetime
string
required

Indicates the datetime in UTC when the task was created.

updated_datetime
string | null
required

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

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.

source_account_id
string
required

The source account containing the transactions

ledger_id
string | null
required

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

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.

Link Unit AccountGet Plaid Link Statuses