POST
/
v0
/
platform
/
instances
curl --request POST \
  --url https://api.sandbox.teal.dev/v0/platform/instances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "coa_template_id": "CNmWM3X6AcvRdEwZKxq4bL",
  "entries_start": "2024-01-01T00:00:00Z",
  "name": "ACME Goods Inc",
  "subscription": "tier3",
  "parent_id": "Kv7sp6Y1gAH2vfNxAWemRy"
}'
{
  "id": "RKtPbubK5NcbBsUmU1ktSP",
  "entries_start": "2024-01-01T00:00:00Z",
  "name": "ACME Goods Inc",
  "subscription": "tier3",
  "accounting_package": "platformgl",
  "parent_id": "Kv7sp6Y1gAH2vfNxAWemRy",
  "child_ids": "['A5SswbYm7eZM2ec5q7Hm2t']",
  "parent": "<any>",
  "children": [
    {}
  ]
}

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 Instance expand paths.

Available options:
parent,
children

Body

application/json
​
coa_template_id
string
required

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

Example:

"CNmWM3X6AcvRdEwZKxq4bL"

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

Example:

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

​
name
string
required

The name of the business.

Example:

"ACME Goods Inc"

​
subscription
enum<string>

The Instance's subscription tier.

Available options:
tier0,
tier1,
tier2,
tier3,
tier4,
tier5
​
parent_id
string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

Response

201
application/json
Successful Response
​
id
string
required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

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

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,
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
​
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
object[] | null

The Instance's children. Included in expanded responses.