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 '{
  "accounting_package": "platformgl",
  "coa_template_id": "CNmWM3X6AcvRdEwZKxq4bL",
  "entries_start": "2024-01-01T00:00:00Z",
  "name": "ACME Goods Inc",
  "subscription": "tier3"
}'
{
  "id": "RKtPbubK5NcbBsUmU1ktSP",
  "entries_start": "2024-01-01T00:00:00Z",
  "name": "ACME Goods Inc",
  "subscription": "tier3",
  "accounting_package": "platformgl"
}

Authorizations

Authorization
string
headerrequired

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

Body

application/json
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
coa_template_id
string | null

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

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.

name
string
required

The name of the business.

subscription
enum<string>

The Instance's subscription tier.

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

Response

201 - application/json
id
string
required

The unique ID of the object.

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.

name
string
required

The name of the business.

subscription
enum<string>
required

The Instance's subscription tier.

Available options:
tier0,
tier1,
tier2,
tier3,
tier4
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
Update an Instance's subscriptionList all Instances