Skip to main content
POST
Create a Ledger Template

Authorizations

Authorization
string
header
required

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

Path Parameters

coa_template_id
string
required

The ID of the Chart of Accounts Template.

Body

application/json
editable
boolean
required

Whether line entries can be manually added or removed from the ledger.

Example:

false

debit_credit
enum<string>
required

Indicates if the ledger is a credit or debit ledger.

Available options:
debit,
credit
Example:

"debit"

ledger_sub_type
enum<string>
required

Indicates similar characteristics and accounting treatment for a group of ledgers within a type.

Available options:
current_assets,
non-current_assets,
transfers_between_accounts,
uncategorized_assets,
current_liabilities,
non-current_liabilities,
equity,
operating_revenues,
other_income,
cost_of_goods_sold,
operating_expenses,
other_expenses,
retained_earnings
Example:

"current_assets"

ledger_type
enum<string>
required

Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: asset, liability and equity ledgers are displayed on the balance sheet; revenue and expenses are displayed on the income statement.

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

"asset"

name
string
required

The name of the ledger.

Example:

"Pluto Checking 4242"

report_cash_flow
boolean
required

Whether or not this ledger is included in the cash flow report. For ledgers with a financial_account_type, this value is automatically determined and cannot be modified.

Example:

true

sort_code
string
required

Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, 20010 will come before 3050.

Maximum string length: 20
Pattern: ^[0-9]+$
Example:

"1400"

financial_account_type
enum<string> | null

Indicates that the ledger represents a real-world financial account.

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

"bank_account"

parent_id
string | null

If the ledger is a child Ledger, the ID of the parent ledger object.

Example:

null

Response

Successful Response

id
string
required

The unique ID of the object.

Example:

"7JRNsKwy2Lw66caxVU7WGC"

debit_credit
enum<string>
required

Indicates if the ledger is a credit or debit ledger.

Available options:
debit,
credit
Example:

"debit"

editable
boolean
required

Whether line entries can be manually added or removed from the ledger.

Example:

false

financial_account_type
enum<string> | null
required

Indicates that the ledger represents a real-world financial account.

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

"bank_account"

is_required
boolean
required

Indicates that the ledger is a system ledger required for Teal to work. These ledgers can be renamed to fit your needs but cannot be deleted. Their behaviour is identified by required_ledger_purpose; see that field's enum for the full set of purposes (e.g. account_transfers, opening_balances, uncat_inflow, uncat_outflow, retained_earnings, current_year_earnings, accounts_receivable, accounts_payable, and the payroll system ledgers).

Example:

false

name
string
required

The name of the ledger.

Example:

"Pluto Checking 4242"

parent_id
string | null
required

If the ledger is a child Ledger, the ID of the parent ledger object.

Example:

null

report_cash_flow
boolean
required

Whether or not this ledger is included in the cash flow report. For ledgers with a financial_account_type, this value is automatically determined and cannot be modified.

Example:

true

sort_code
string
required

Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, 20010 will come before 3050.

Example:

"1400"

sub_type
enum<string>
required

Indicates similar characteristics and accounting treatment for a group of ledgers within a type.

Available options:
current_assets,
non-current_assets,
transfers_between_accounts,
uncategorized_assets,
current_liabilities,
non-current_liabilities,
equity,
operating_revenues,
other_income,
cost_of_goods_sold,
operating_expenses,
other_expenses,
retained_earnings
Example:

"current_assets"

type
enum<string>
required

Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: asset, liability and equity ledgers are displayed on the balance sheet; revenue and expenses are displayed on the income statement.

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

"asset"

children
any[] | null

If the Ledger has child ledgers, a list of the Ledger objects.

Example:

null