Skip to main content
POST
Create ledger account

Authorizations

Authorization
string
header
required

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

Body

application/json
ledger_id
string
required

Identifier of the ledger that owns the account.

code
string
required

Accounting code of the account.

type
enum<string>
required

Accounting type of the account.

Available options:
asset,
contra_asset,
liability,
contra_liability,
equity,
revenue,
contra_revenue,
expense
name
string
required

Display name of the account.

provider_account_id
string | null

Optional account identifier in the connected provider.

Response

201 - application/json
id
string
required

Unique ledger account identifier.

ledger_id
string
required

Owning ledger identifier.

code
string
required

Accounting code of the account.

type
enum<string>
required

Accounting type of the account.

Available options:
asset,
contra_asset,
liability,
contra_liability,
equity,
revenue,
contra_revenue,
expense
is_default
boolean
required

Whether the account is a system default.

name
string
required

Display name of the account.

description
string | null
required

Optional account description.

currency
string
required

ISO 4217 account currency.

provider_account_id
string | null
required

Matching account identifier at the provider.

client_provider_id
string | null
required

Connected provider identifier.

last_refreshed_at
string<date> | null
required

Timestamp of the last provider refresh.

created_at
string<date> | null
required

Timestamp when the account was created.

updated_at
string<date> | null
required

Timestamp when the account was last updated.

balance
string

Lifetime account balance when requested by a list endpoint.

period_balance
string | null

Quarter balance when a year and quarter are supplied.