POST
/
api
/
accounts

Headers

Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Body

application/json
name
string
required

Account name

Required string length: 3 - 255
Example:

"Cash Account"

accountType
string
required

Type of account

Required string length: 3 - 255
Example:

"asset"

code
string

Account code

Required string length: 3 - 6
Example:

"CA001"

currencyCode
string

Currency code for the account

Example:

"USD"

description
string

Account description

Maximum length: 65535
Example:

"Main cash account for daily operations"

parentAccountId
number

ID of the parent account

Example:

1

active
boolean
default:true

Whether the account is active

Example:

true

plaidAccountId
string

Plaid account ID for syncing

Example:

"plaid_account_123456"

plaidItemId
string

Plaid item ID for syncing

Example:

"plaid_item_123456"

Response

200

The account has been successfully created.