Overview

Instances represent a single business in Teal; you can also think of them as a “set of books” for your users.

Use the Create Instance endpoint and set their subscription_tier, gl_backend, entries_start, and coa_template_id.

Remember to store the association between an instance in Teal and their associated entity in your product.

Instance anatomy

Accounting package

An accounting package (the gl_backend parameter) is required for every Instance as it defines the source of truth for a set of books and what features a customer has access to. There are two accounting package options:

  • platform_gl: Our build-your-own solution allows you to build your own bespoke accounting software to fit your users unique needs. A chart of accounts template is required for all platform_gl instances.
  • quickbooks: Integrate a customer’s existing QuickBooks account. Please note that not all features are available for Instances using QuickBooks as their accounting package.

We plan on integrating with more popular accounting packages soon. If you have a specific accounting package you’d like an integration for, please reach out to us.

Subscription tier

Subscription tiers unlock reporting and advanced features for your users. By default, Instances have a tier 0 subscription and can be upgraded to higher tiers using the Update Subscription endpoint.

NameLevelFeatures
InactiveTier 0
BasicTier 1Basic reports, line entry categories
AdvancedTier 2Balance sheet
PremiumTier 3Filter reports using tags

Contact us for Instance tier pricing levels. Instances in Sandbox environments are always free.

Start date

The entries_start parameter is the start date from which the API will sync an instance’s accounting data. Transactions or journal entries cannot be entered before the start date, but you will be able to read reports.

You will generally set a start date that is the beginning of the financial year that your instances will begin tracking their books on your platform, or the start date of their business, whichever is sooner.

You can use the Opening Balances endpoint to set their balance sheet properly so that it is accurate on the start date. (PlatformGL only).

Chart of accounts (PlatformGL only)

A chart of accounts template (the coa_template_id parameter) is required for all new PlatformGL instances to generate their ledgers. You can view and manage your templates in the Developer Portal or using the Chart of Account Template endpoints.

Next steps