Teal

API Reference

Developer Portal

Overview

Teal lets you build accounting features for your small business customers to use.

What is Teal?

Follow these steps to begin using the Teal API.

Initial setup

See Teal in action by building a real cash flow report for a test user.

Quick start

Authentication

Pagination

Instances

Adding an instance

An overview of core accounting concepts and how they are modeled in PlatformGL.

Core Concepts

Charts of accounts

Set up authorization so that your customers can sync their QuickBooks accounting package

Authorization

Coming soon

Mapping ledgers

Creating transactions

Setting up metatags for advanced reporting.

Attaching metatags

How to set opening balances to ensure accurate balance sheets.

Setting opening balances

Data integrations

How Teal's auto-categorization pipeline works

Auto-categorization

Generating charts and reports for your end users

How to build a cash flow report using Teal.

Cash flow report

How to build an income statement using Teal.

Income statement

Balance sheet

How to build a ledger statement using Teal.

Ledger statement

How to build a general ledger report using Teal.

General ledger report

Fetching Teal data to add to your non-Teal reports

Enriching non-Teal reports

How to build UI for reports that delight your users.

Reports interfaces

Reviewing transactions

Customers need to be able to manually create and edit journal entries.

Journal Entry Interface

How and why to generate Excel exports from your Teal data

Excel exports

Follow [these steps](/getting_started/setup) to begin using the Teal API.

Get detailed information about an instance.

Get Instance Details

Delete Instance

Updates an instance's subscription level.

Update Subscription

Create Instance

Get Instances

Get Journal Entry

Update journal entry details or line entries. When updating line entries in the journal entry, debit and credit amounts must equal.

Update Journal Entry

Delete Journal Entry

Get all journal entries for the instance.

Get Journal Entries

Create Journal Entry

Get Platform

Update Line Entry

Gets the category for a line entry. Requires Tier 1 subscription.

Get Line Entry Categories

Gets all the line entries in a journal entry.

Get Journal Entry Line Entries

Return the line entries in the specified ledger for the period.

Get Ledger Line Entries

Link Unit Account

Link an external financial account via Plaid.

Link Plaid Account

Returns the status of all Plaid connected financial account ledgers on the platform.

Get Plaid Link Statuses

Create CoA Template

Gets all Chart of Accounts templates for the platform.

Get CoA Templates

Get a detailed Chart of Account template.

Get CoA Template

Delete CoA Template

Clone a Chart of Accounts template with all its ledgers templates.

Clone CoA Template

Create a ledger template in a Chart of Accounts template.

Create Ledger Template

Update a ledger template in a Chart of Accounts template.

Update CoA Ledger Template

Delete a ledger template in a Chart of Accounts template.

Delete Ledger Template

Get all the categorization rules for the platform.

Get Rules

Create Rule

Delete Rule

Get Ledgers

Create Ledger

Update Ledger

Delete Ledger

Sets the opening balance for a ledger. The ledger must not have any line entries.

Set Ledger Opening Balance

Get an income statement containing an array of ledger summaries for the instance. Requires Tier 1 subscription.

Get Income Statement

Get a balance sheet containing an array of ledger summaries for the instance. Requires Tier 2 subscription.

Get Balance Sheet

Get a ledger statement for the instance, containing the opening/closing balances with line entries for the period.

Get Ledger Statement

Get the cash flow report for an instance within for a period. Requires Tier 1 subscription.

Get Cash Flow Report

Get cash flow data between start date and end date partitioned by period. Requires Tier 1 subscription.

Get Cash Flow Totals by Period

Get cash flow data between start date and end date partitioned by ledger. Requires Tier 1 subscription.

Get Cash Flow Totals by Ledger

Get top expenses withing a given date range.

Get Top Expenses

Get net profit by period withing a given date range.

Get Net Profit by Period

Get gross profit by period withing a given date range.

Get Gross Profit by Period

Get financial summaries by period withing a given date range.

Get Financial Summaries by Period

Creates transactions into a ledger. Returns transaction processing task.

Create Transactions

Get Transactions

Checks the status of processing transactions.

Get Transaction Processing Status

Delete a transaction and associated journal entry.

Delete Transaction

Update Transaction Status

Get Categorized Transactions

Get Transaction Categories

Recategorize Transaction

Generate the authentication link for connecting a QuickBooks account.

Generate QuickBooks Auth Link

Create a QuickBooks account mapping and return the associated Ledger

Getting started

Accounting packages

Working with transactions

Generating charts & reports

Building complex interfaces

Overview