List all Chart of Accounts Templates

GET

platform-gl

coa-templates

curl --request GET \
  --url https://api.sandbox.teal.dev/v0/platform-gl/coa-templates \
  --header 'Authorization: Bearer <token>'

{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "id": "PpvsmFEv14yGDyT6iV6kXw",
      "name": "Coffee Shop Sole Prop",
      "ledgers": null,
      "ledger_ids": [
        "7JRNsKwy2Lw66caxVU7WGC",
        "HLn8oy2eqMUCwjp1Cwdgco"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Query Parameters

expand

enum<string>[] | null

Comma-separated list of expandable paths.

Available options:

ledgers

limit

integer | null

default:

The number of records to return. Max limit is 100.

Required range: 1 <= x < 101

page_token

string | null

Response

200

application/json

Successful Response

next_page_token

string | null

required

The token to use to request the next page

Example:

"ikal0NEVfMhF8dJf4yQ6KQZmGD"

prev_page_token

string | null

required

The token to use to request the previous page

Example:

"vuA7JeKI5c6FLnPt5JfRcZcJxW"

records

object[]

required

List of CoA templates

records.id

string

required

The unique ID of the object.

Example:

"PpvsmFEv14yGDyT6iV6kXw"

records.name

string

required

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

Example:

"Coffee Shop Sole Prop"

records.ledger_ids

string[]

required

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

Example:

[
  "7JRNsKwy2Lw66caxVU7WGC",
  "HLn8oy2eqMUCwjp1Cwdgco"
]

records.ledgers

object[] | null

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

records.ledgers.id

string

required

The unique ID of the object.

Example:

"7JRNsKwy2Lw66caxVU7WGC"

records.ledgers.debit_credit

enum<string>

required

Indicates if the ledger is a credit or debit ledger.

Required if financial_account_type is not specified.

Available options:

debit,

credit

Example:

"debit"

records.ledgers.editable

boolean

required

Whether line entries can be manually added or removed from the Ledger. Set to false if you control the source of truth for the Ledger and want to restrict user changes, for example, if the Ledger is for a bank account or a payments account you control (i.e. you are a neobank or using a Banking as a Service platform).

Example:

false

records.ledgers.financial_account_type

enum<string> | null

required

If specified, indicates that the ledger represents a real-world financial account.

If provided when creating a new Ledger object, you do not need to provide debit_credit, type, sub_type, or report_cash_flow values as we will provide default values.

Available options:

bank_account,

credit_card,

payments,

payroll,

loan,

prepaid_card,

accounts_receivable,

accounts_payable

Example:

"bank_account"

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

Example:

false

records.ledgers.name

string

required

The name of the ledger. Teal does not enforce any other conventions or patterns on naming schemes; however, we recommend you use concise, descriptive names, especially for financial account ledgers.

Example:

"Pluto Checking 4242"

records.ledgers.parent_id

string | null

required

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

Example:

null

records.ledgers.report_cash_flow

boolean

required

Whether Teal includes this ledger in the cash flow report.

Required if financial_account_type is not specified.

Example:

true

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

Teal does not enforce any other conventions or patterns on sort codes. However, it is recommended to adopt a common convention such as starting all ledgers of the same type with the same number (assets start with 1, liabilities start with 2, etc.). The default CoA templates provided by Teal follow best practices for sort code numbering.

Example:

"1400"

records.ledgers.sub_type

enum<string>

required

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

Required if financial_account_type is not specified.

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

Example:

"current_assets"

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

    Required if `financial_account_type` is not specified.

Available options:

asset,

liability,

equity,

revenue,

expense

Example:

"asset"

records.ledgers.children

object[] | null

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

records.ledgers.children.id

string

required

The unique ID of the object.

Example:

"7JRNsKwy2Lw66caxVU7WGC"

records.ledgers.children.debit_credit

enum<string>

required

Indicates if the ledger is a credit or debit ledger.

Required if financial_account_type is not specified.

Available options:

debit,

credit

Example:

"debit"

records.ledgers.children.editable

boolean

required

Example:

false

records.ledgers.children.financial_account_type

enum<string> | null

required

If specified, indicates that the ledger represents a real-world financial account.

If provided when creating a new Ledger object, you do not need to provide debit_credit, type, sub_type, or report_cash_flow values as we will provide default values.

Available options:

bank_account,

credit_card,

payments,

payroll,

loan,

prepaid_card,

accounts_receivable,

accounts_payable

Example:

"bank_account"

records.ledgers.children.is_required

boolean

required

Example:

false

records.ledgers.children.name

string

required

The name of the ledger. Teal does not enforce any other conventions or patterns on naming schemes; however, we recommend you use concise, descriptive names, especially for financial account ledgers.

Example:

"Pluto Checking 4242"

records.ledgers.children.parent_id

string | null

required

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

Example:

null

records.ledgers.children.report_cash_flow

boolean

required

Whether Teal includes this ledger in the cash flow report.

Required if financial_account_type is not specified.

Example:

true

records.ledgers.children.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"

records.ledgers.children.sub_type

enum<string>

required

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

Required if financial_account_type is not specified.

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

Example:

"current_assets"

records.ledgers.children.type

enum<string>

required

    Required if `financial_account_type` is not specified.

Available options:

asset,

liability,

equity,

revenue,

expense

Example:

"asset"

records.ledgers.children.children

object[] | null

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

records.ledgers.children.children.id

string

required

The unique ID of the object.

Example:

"7JRNsKwy2Lw66caxVU7WGC"

records.ledgers.children.children.debit_credit

enum<string>

required

Indicates if the ledger is a credit or debit ledger.

Required if financial_account_type is not specified.

Available options:

debit,

credit

Example:

"debit"

records.ledgers.children.children.editable

boolean

required

Example:

false

records.ledgers.children.children.financial_account_type

enum<string> | null

required

If specified, indicates that the ledger represents a real-world financial account.

If provided when creating a new Ledger object, you do not need to provide debit_credit, type, sub_type, or report_cash_flow values as we will provide default values.

Available options:

bank_account,

credit_card,

payments,

payroll,

loan,

prepaid_card,

accounts_receivable,

accounts_payable

Example:

"bank_account"

records.ledgers.children.children.is_required

boolean

required

Example:

false

records.ledgers.children.children.name

string

required

The name of the ledger. Teal does not enforce any other conventions or patterns on naming schemes; however, we recommend you use concise, descriptive names, especially for financial account ledgers.

Example:

"Pluto Checking 4242"

records.ledgers.children.children.parent_id

string | null

required

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

Example:

null

records.ledgers.children.children.report_cash_flow

boolean

required

Whether Teal includes this ledger in the cash flow report.

Required if financial_account_type is not specified.

Example:

true

records.ledgers.children.children.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"

records.ledgers.children.children.sub_type

enum<string>

required

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

Required if financial_account_type is not specified.

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

Example:

"current_assets"

records.ledgers.children.children.type

enum<string>

required

    Required if `financial_account_type` is not specified.

Available options:

asset,

liability,

equity,

revenue,

expense

Example:

"asset"

records.ledgers.children.children.children

object[] | null

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

Example:

null

Example:

null

Example:

null

Example:

null

Create a Chart of Accounts Template Retrieve a Chart of Accounts Template

curl --request GET \
  --url https://api.sandbox.teal.dev/v0/platform-gl/coa-templates \
  --header 'Authorization: Bearer <token>'

{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "id": "PpvsmFEv14yGDyT6iV6kXw",
      "name": "Coffee Shop Sole Prop",
      "ledgers": null,
      "ledger_ids": [
        "7JRNsKwy2Lw66caxVU7WGC",
        "HLn8oy2eqMUCwjp1Cwdgco"
      ]
    }
  ]
}

API overview

Teal API Endpoints

API Migration

List all Chart of Accounts Templates

Authorizations

Query Parameters

Response