Skip to main content
​
name
string
required

The name of the ledger

Maximum string length: 255
Example:

"Checking x5678"

​
type
enum<string>
required

The ledger type

Available options:
asset,
liability,
equity,
revenue,
expense
Example:

"asset"

​
subtype
enum<string>
required

The ledger subtype

Available options:
current_asset,
fixed_asset,
other_asset,
uncategorized_asset,
current_liability,
long_term_liability,
operating_revenue,
other_inflow,
cost_of_goods_sold,
operating_expense,
other_outflow,
contribution,
distribution,
common_stock,
preferred_stock,
additional_capital,
opening_balance,
retained_earnings,
memo
Example:

"current_asset"

​
debit_credit
enum<string>
required

Indicates if the ledger is a debit or credit ledger

Available options:
debit,
credit
Example:

"debit"

​
report_cash_flow
boolean
required

Whether the ledger is included in the cash flow report

​
id
string<ldg_string>
required

The ID of the Ledger

Example:

"ldg_WQMDNUHpBThYSNh4AprDBo"

​
business_id
string<biz_string>
required

The ID of the Business that is associated with the Ledger

Example:

"biz_Pk2fNFDd8wj7EFeLWJywc7"

​
description
string | null

Optional description or definition of the ledger

Maximum string length: 100
Example:

"Business checking account"

​
financial_account_type
enum<string> | null

Used for ledgers that are connected to real-world financial accounts

Available options:
bank_account,
credit_card,
prepaid_card,
payments,
payroll,
loan,
accounts_receivable,
accounts_payable
Example:

"bank_account"

​
sort_code
string | null

Used for grouping and sorting ledgers in reports

Example:

"1010"

​
parent_id
string<ldg_string> | null

It indicates if this is a child ledger of another ledger in the chart of accounts.

Example:

"ldg_KtY7p9fsM4pB58SYNar7cv"