Instances
Create Instance
Create an instance on a platform.
POST
/
v0
/
platform
/
instances
Authorization
Body
curl --request POST \
--url https://api.sandbox.teal.dev/v0/platform/instances \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"accounting_package": "platformgl",
"coa_template_id": "CNmWM3X6AcvRdEwZKxq4bL",
"entries_start": "2023-11-07T05:31:56Z",
"name": "City Center Veterinarian",
"subscription": "tier1"
}'
{
"entries_start": "2022-01-01T00:00:00Z",
"id": "RKtPbubK5NcbBsUmU1ktSP",
"name": "City Center Veterinarian",
"subscription": "tier1"
}
Authorizations
Authorization
string
headerrequiredThe access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
accounting_package
enum<string>
requiredThe accounting package for this instance
Available options:
platformgl
, quickbooks
coa_template_id
string | null
entries_start
string | null
The datetime when journal entries may start
name
string
requiredsubscription
enum<string>
The subscription level for this instance
Available options:
tier0
, tier1
, tier2
Response
201 - application/json
entries_start
string | null
requiredThe earliest possible datetime for the instance's journal entries
id
string
requiredname
string
requiredsubscription
enum<string>
requiredAvailable options:
tier0
, tier1
, tier2
curl --request POST \
--url https://api.sandbox.teal.dev/v0/platform/instances \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"accounting_package": "platformgl",
"coa_template_id": "CNmWM3X6AcvRdEwZKxq4bL",
"entries_start": "2023-11-07T05:31:56Z",
"name": "City Center Veterinarian",
"subscription": "tier1"
}'
{
"entries_start": "2022-01-01T00:00:00Z",
"id": "RKtPbubK5NcbBsUmU1ktSP",
"name": "City Center Veterinarian",
"subscription": "tier1"
}