Create an Instance

Authorizations

Authorization

string

header

required

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

Headers

x-teal-agent-id

string<uuid> | null

The agent id

Query Parameters

expand

enum<string>[] | null

Comma-separated list of Instance expand paths.

Available options:

parent,

children

Body

application/json

entries_start

string<date-time>

required

The datetime in UTC time from which the API will sync an Instance's accounting data. Transactions or journal entries cannot be entered before this date.

name

string

required

The name of the business.

coa_template_id

string | null

The ID of the Chart of Accounts Template used to pre-populate the Instance's ledgers.

Example:

"CNmWM3X6AcvRdEwZKxq4bL"

custom_coa

InstanceCreateCustomCoa · object

A custom COA definition to be used for the created instance.

Show child attributes

custom_coa.ledgers

CustomCoaLedger · object[]

required

Show child attributes

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

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

Required if financial_account_type is not specified.

Maximum string length: 20

custom_coa.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,

retained_earnings

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

custom_coa.ledgers.children

any[] | null

The child ledgers

custom_coa.required_ledgers

CustomRequiredLedgers · object

Show child attributes

custom_coa.required_ledgers.uncategorized_inflow

CustomRequiredLedger · object

The ledger to be used for uncategorized income

Show child attributes

custom_coa.required_ledgers.uncategorized_inflow.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.

Required if financial_account_type is not specified.

Maximum string length: 20

custom_coa.required_ledgers.uncategorized_inflow.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.

custom_coa.required_ledgers.uncategorized_outflow

CustomRequiredLedger · object

The ledger to be used for uncategorized outflow

Show child attributes

custom_coa.required_ledgers.uncategorized_outflow.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.

Required if financial_account_type is not specified.

Maximum string length: 20

custom_coa.required_ledgers.uncategorized_outflow.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.

custom_coa.required_ledgers.transfers_between_accounts

CustomRequiredLedger · object

The ledger to be used for transfers between accounts

Show child attributes

custom_coa.required_ledgers.transfers_between_accounts.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.

Required if financial_account_type is not specified.

Maximum string length: 20

custom_coa.required_ledgers.transfers_between_accounts.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.

custom_coa.required_ledgers.opening_balances

CustomRequiredLedger · object

The ledger to be used for opening balance retained earnings

Show child attributes

custom_coa.required_ledgers.opening_balances.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.

Required if financial_account_type is not specified.

Maximum string length: 20

custom_coa.required_ledgers.opening_balances.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.

subscription

enum<string>

default:tier0

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

accounting_basis

enum<string> | null

The accounting method used: cash basis or accrual basis.

Available options:

cash,

accrual

Example:

"accrual"

parent_id

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

Response

Successful Response

id

string

required

The unique ID of the object.

entries_start

string<date-time>

required

The datetime in UTC time from which the API will sync an Instance's accounting data. Transactions or journal entries cannot be entered before this date.

name

string

required

The name of the business.

subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

accounting_package

enum<string>

required

The type of accounting package the Instance uses as the source of truth for their books.

Available options:

platformgl,

quickbooks

accounting_basis

enum<string> | null

The accounting method used: cash basis or accrual basis.

Available options:

cash,

accrual

Example:

"accrual"

parent_id

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

parent

any | null

The Instance's parent. Included in expanded responses.

children

any[] | null

The Instance's children. Included in expanded responses.

API overview

Teal API Endpoints

API Migration

Create an Instance

Authorizations

Headers

Query Parameters

Body

Response