Skip to main content
POST
/
v0
/
source-accounts
Create a Transaction Source Account
curl --request POST \
  --url https://api.sandbox.teal.dev/v0/source-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'teal-instance-id: <teal-instance-id>' \
  --data '
{
  "name": "<string>",
  "ledger_id": "<string>",
  "ledger": {
    "opening_balance": 123
  },
  "invert_transaction_amounts": false
}
'
{
  "id": "<string>",
  "name": "<string>",
  "ledger_id": "<string>",
  "invert_transaction_amounts": false,
  "enable_balance_polling": true
}

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

​
modified-by
string | null

An optional identifier for audit logging.

Body

application/json
​
name
string
required
deprecated

Deprecated. The source account's name now mirrors the linked ledger's name; provide the ledger name when creating the ledger instead.

​
business_personal
enum<string>
required

Whether the account is a business or personal account.

Available options:
business,
personal
​
ledger_id
string | null

The ledger where transactions will be posted. The ledger must have a financial account type. Exactly one of ledger_id or ledger must be provided.

​
ledger
CreateSourceAccountLedger · object

Details for a new ledger to create for this source account. Exactly one of ledger_id or ledger must be provided.

​
invert_transaction_amounts
boolean | null
default:false

If true transaction amounts are inverted during manual import only.

Response

Successful Response

​
id
string
required
Example:

"KdE7Q37LeQhFQCfEejfibT"

​
name
string
required
deprecated

Deprecated. Returns the linked ledger's name; read it from the ledger directly.

​
debit_credit
enum<string>
required

Whether the account is a debit or credit account.

Available options:
debit,
credit
​
ledger_id
string
required

The ledger ID where transactions will be posted.

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