Skip to main content
PUT
/
v0
/
source-accounts
/
{source_account_id}
Update a Transaction Source Account
curl --request PUT \
  --url https://api.sandbox.teal.dev/v0/source-accounts/{source_account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'teal-instance-id: <teal-instance-id>' \
  --data '
{
  "name": "<string>",
  "invert_transaction_amounts": true,
  "enable_balance_polling": true
}
'
{
  "id": "<string>",
  "name": "<string>",
  "debit_credit": "debit",
  "ledger_id": "<string>",
  "draw_ledger_id": "<string>",
  "contribution_ledger_id": "<string>",
  "type": "plaid",
  "business_personal": "business",
  "invert_transaction_amounts": false,
  "enable_balance_polling": true
}

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

source_account_id
string
required

The Source Account ID

Body

application/json
name
string | null

The name of the source account

invert_transaction_amounts
boolean | null

If true transaction amounts are inverted during manual import only.

enable_balance_polling
boolean | null

If true balance polling will be enabled for the source account. If false balance polling will be disabled. Only applicable to Plaid source accounts.

Response

Successful Response

id
string
required
Example:

"KdE7Q37LeQhFQCfEejfibT"

name
string
required

The name of the source account

debit_credit
enum<string>
required

Whether the account is a debit or credit account.

Available options:
debit,
credit
ledger_id
string | null
required

The ledger ID where transactions will be posted. Personal accounts will have no ledger ID.

draw_ledger_id
string | null
required

The ledger ID where personal transactions will be posted if they draw from the business. Business accounts will have no draw ledger ID.

contribution_ledger_id
string | null
required

The ledger ID where personal transactions will be posted if they contribute to the business. Business accounts will have no contribution ledger ID.

type
enum<string>
required

The type of the transaction source.

Available options:
plaid,
manual
business_personal
enum<string>
required

Whether the account is a business or personal account.

Available options:
business,
personal
invert_transaction_amounts
boolean
default:false

If true transaction amounts are inverted during manual import only.

enable_balance_polling
boolean | null

Indicates if source account will poll external sources for balances. Only applicable to plaid linked accounts.