Skip to main content
GET
/
v0
/
platform-gl
/
coa-templates
/
{coa_template_id}
Retrieve a Chart of Accounts Template
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/platform-gl/coa-templates/{coa_template_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "accounting_basis": "cash",
  "ledger_ids": [
    "<string>"
  ],
  "ledgers": null
}

Authorizations

​
Authorization
string
header
required

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

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

​
id
string
required

The unique ID of the object.

Example:

"PpvsmFEv14yGDyT6iV6kXw"

​
name
string
required

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

Example:

"Coffee Shop Sole Prop"

​
accounting_basis
enum<string>
required

The accounting basis for this Chart of Accounts template.

Available options:
cash,
accrual
Example:

"accrual"

​
ledger_ids
string[]
required

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

Example:
[
  "7JRNsKwy2Lw66caxVU7WGC",
  "HLn8oy2eqMUCwjp1Cwdgco"
]
​
ledgers
LedgerTemplate · object[] | null

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

Example:

null