Teal API Endpoints
- Categorization
- Chart of Accounts Templates
- Instances
- Journal Entries
- Ledgers
- Line Entries
- Payables
- Platform
- Quickbooks
- Receivables
- Reports
- Tags
- Transaction Sources
- Transactions
- Transfers
API Migration
- Migration Guides
- Deprecated Endpoints
Create an Instance
Creates a new Instance based on the given parameters.
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": {},
"children": [
{}
]
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
Comma-separated list of Instance expand paths.
parent
, children
Body
The ID of the Chart of Accounts Template used to pre-populate the Instance's ledgers.
"CNmWM3X6AcvRdEwZKxq4bL"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
Response
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's parent. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's parent. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's children. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's parent. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's children. Included in expanded responses.
The Instance's children. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's parent. Included in expanded responses.
The Instance's children. Included in expanded responses.
The Instance's children. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's parent. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's children. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's parent. Included in expanded responses.
The Instance's children. Included in expanded responses.
The Instance's children. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's parent. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's children. Included in expanded responses.
The Instance's children. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's parent. Included in expanded responses.
The Instance's children. Included in expanded responses.
The Instance's children. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's parent. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's children. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's parent. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's children. Included in expanded responses.
The Instance's children. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's parent. Included in expanded responses.
The Instance's children. Included in expanded responses.
The Instance's children. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's parent. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's children. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's parent. Included in expanded responses.
The Instance's children. Included in expanded responses.
The Instance's children. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's parent. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's children. Included in expanded responses.
The Instance's children. Included in expanded responses.
The unique ID of the object.
"RKtPbubK5NcbBsUmU1ktSP"
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.
"2024-01-01T00:00:00Z"
The name of the business.
"ACME Goods Inc"
The Instance's subscription tier.
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
platformgl
, quickbooks
The ID of the Instance's parent.
"Kv7sp6Y1gAH2vfNxAWemRy"
The IDs of the Instance's children.
"['A5SswbYm7eZM2ec5q7Hm2t']"
The Instance's parent. Included in expanded responses.
The Instance's children. Included in expanded responses.
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": {},
"children": [
{}
]
}