Skip to main content
POST
/
v0
/
instance
Create an Instance
curl --request POST \
  --url https://api.sandbox.teal.dev/v0/instance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entries_start": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "coa_template_id": "CNmWM3X6AcvRdEwZKxq4bL",
  "custom_coa": {
    "ledgers": [
      {
        "name": "<string>",
        "sort_code": "<string>",
        "children": [
          "<unknown>"
        ]
      }
    ],
    "required_ledgers": {
      "uncategorized_inflow": {
        "name": "Uncategorized Cash Inflow",
        "sort_code": "0"
      },
      "uncategorized_outflow": {
        "name": "Uncategorized Cash Outflow",
        "sort_code": "1"
      },
      "transfers_between_accounts": {
        "name": "Transfers Between Accounts",
        "sort_code": "2"
      },
      "opening_balances": {
        "name": "Opening Balance Retained Earnings",
        "sort_code": "3"
      },
      "accounts_receivable": {
        "name": "Accounts Receivable",
        "sort_code": "4"
      },
      "accounts_payable": {
        "name": "Accounts Payable",
        "sort_code": "6"
      },
      "retained_earnings": {
        "name": "Retained Earnings",
        "sort_code": "8020"
      },
      "current_year_earnings": {
        "name": "Current Year Earnings",
        "sort_code": "8030"
      }
    }
  },
  "subscription": "tier0",
  "accounting_basis": "accrual"
}
'
{
  "id": "<string>",
  "entries_start": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "accounting_package": "platformgl",
  "accounting_basis": "accrual"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-teal-agent-id
string<uuid> | null

The agent id

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. The time component is ignored — the value is always stored as start-of-day UTC (00:00:00Z).

Example:

"2024-01-01T00:00:00Z"

​
name
string
required

The name of the business.

Example:

"ACME Goods Inc"

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

​
subscription
enum<string>
default:tier0

The Instance's subscription tier.

Available options:
tier0,
tier1,
tier2,
tier3,
tier4
Example:

"tier3"

​
accounting_basis
enum<string> | null

The accounting method used: cash basis or accrual basis.

Available options:
cash,
accrual
Example:

"accrual"

Response

Successful Response

​
id
string
required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

​
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. The time component is ignored — the value is always stored as start-of-day UTC (00:00:00Z).

Example:

"2024-01-01T00:00:00Z"

​
name
string
required

The name of the business.

Example:

"ACME Goods Inc"

​
subscription
enum<string>
required

The Instance's subscription tier.

Available options:
tier0,
tier1,
tier2,
tier3,
tier4
Example:

"tier3"

​
accounting_package
enum<string>
required

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

Available options:
platformgl
Example:

"platformgl"

​
accounting_basis
enum<string> | null

The accounting method used: cash basis or accrual basis.

Available options:
cash,
accrual
Example:

"accrual"