Retrieve a Chart of Accounts Template

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

coa_template_id

string

required

The ID of the Chart of Accounts Template

Query Parameters

expand

enum<string>[] | null

Comma-separated list of expandable paths.

Available options:

ledgers

Response

Successful Response

string

required

The unique ID of the object.

name

string

required

An arbitrary string on the object, useful for identifying the Chart of Accounts template.

ledger_ids

string[]

required

A list of IDs of the Ledger Template objects associated with the Chart of Accounts Template

ledgers

LedgerTemplate · object[] | null

Expandable. A list of the Ledger Templates associated with the Chart of Accounts Template.

Show child attributes

ledgers.id

string

required

The unique ID of the object.

ledgers.debit_credit

enum<string>

required

Indicates if the ledger is a credit or debit ledger.

Available options:

debit,

credit

ledgers.editable

boolean

required

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

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

Example:

"bank_account"

ledgers.is_required

boolean

required

Indicates that the ledger is one of the four system ledgers required for Teal to work. In the default chart of accounts, these are named one of: Transfers Between Accounts, Opening Balance Retained Earnings, Uncategorized Cash Inflow, Uncategorized Cash Outflow. You can update the names of these to fit your needs.

ledgers.name

string

required

The name of the ledger.

ledgers.parent_id

string | null

required

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

Example:

null

ledgers.report_cash_flow

boolean

required

Whether Teal includes this ledger in the cash flow report.

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

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

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

ledgers.children

any[] | null

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

Example:

null

Example:

null

API overview

Teal API Endpoints

API Migration

Retrieve a Chart of Accounts Template

Authorizations

Path Parameters

Query Parameters

Response