API Reference

Changelog

Teal

Guides

Developer Portal

Returns the opening balance journal entry

Get all ledgers opening balances

CategorizerType

DebitCredit

The value of the line entry in decimal dollar cents.

Amount

The datetime the Line Entry was created in UTC time.

Datetime

Indicates if the amount is a credit or 
        debit.

An arbitrary string on the object, useful for 
        displaying to the user or for categorization.

Description

Indicates if the Line Entry can be manually added or 
        removed from a Ledger, as dictated by the `editable` property on the Ledger.

Editable

The unique ID of the object. Can be null in some cases for 
        Instances using QuickBooks as their accounting package.

Expandable. The associated Journal Entry object.

An arbitrary string on the object, 
        useful for displaying to users.

Journal Entry Description

The ID of the associated Journal Entry. Can be 
        null in some cases for Instances using QuickBooks as their 
        accounting package.

Journal Entry Id

Expandable. The associated Ledger object.

Pluto Checking 4242

The ID of the Line Entry's Ledger. Can be null in some 
        cases for Instances using QuickBooks as their accounting package.

Ledger Id

Ledger Name

Expandable. The associated Transaction object, 
        if one exists.

The ID of the associated Transaction, 
        if one exists.

Transaction Id

ExpandableDetailedLineEntry

FinancialAccountType

The datetime the Journal Entry was created in UTC 
        time.

An arbitrary string on the object, useful for 
        displaying to the user.

A list of files attached to the Journal Entry. Only
        available to Instances using Platform GL as their accounting package.

Files

The ids of the Line Entries detailing the Journal
        Entry's movement of value. Only `null` if the Instance is using QuickBooks as
        their accounting package.

Line Entry Ids

The entity that is linked with this journal entry. Journal entries with linked entities may not be modified or deleted directly.

JournalEntry

JournalEntryEntity

JournalEntryEntityType

The name of the file uploaded to the Journal Entry.
        If no value is provided or `null` is specified, defaults to the name 
        of the file.

File Name

JournalEntryFile

Indicates if the ledger is a credit or 
        debit ledger.


Required if `financial_account_type` is not specified.

Whether line entries can be manually added or removed
        from the Ledger. Set to `false` if you control the source of truth for 
        the Ledger and want to restrict user changes, for example, if the Ledger is 
        for a bank account or a payments account you control (i.e. you are a neobank
        or using a Banking as a Service platform).

If specified, indicates that the ledger
        represents a real-world financial account.


If provided when creating a new
        Ledger object, you do not need to provide `debit_credit`, `type`, `sub_type`, or
        `report_cash_flow` values as we will provide default values.

Indicates that the ledger is one of the four system
        ledgers required for teal to work. In the default chart of accounts, these 
        are named one of: `Transfers Between Accounts`, `Opening Balance Retained 
        Earnings`, `Uncategorized Cash Inflow`, `Uncategorized Cash Outflow`. You 
        can update the names of these to fit your needs.

Is Required

The name of the ledger. Teal does not enforce any other
        conventions or patterns on naming schemes; however, we recommend you use
        concise, descriptive names, especially for financial account ledgers.

Name

Expandable. If the ledger is a child ledger, the parent
        Ledger object.

If the Ledger is a child Ledger, the ID of the 
        parent Ledger object.

Parent Id

Whether Teal includes this ledger in the cash
        flow report.


Required if `financial_account_type` is not specified.

Report Cash Flow

Determines the display order in reports, ordered digit
        by digit, starting from the leftmost position. For example, `20010` will come
        before `3050`.


Teal does not enforce any other conventions or patterns on
        sort codes. However, it is recommended to adopt a common convention such as
        starting all ledgers of the same type with the same number (assets start with
        1, liabilities start with 2, etc.). The default CoA templates provided by Teal
        follow best practices for sort code numbering.

Sort Code

Indicates similar characteristics and accounting
        treatment for a group of ledgers within a `type`.


Required if 
        `financial_account_type` is not specified.

Indicates the purpose and location of the funds and
        value recorded in the Ledger and which report it is included in: `asset`,
        `liability` and `equity` ledgers are displayed on the balance sheet;
        `revenue` and `expenses` are displayed on the income statement.



        Required if `financial_account_type` is not specified.

Ledger

LedgerSubType

LedgerType

PostedStatus

ReviewStatus

The value of the transaction in decimal dollar cents.

How the Transaction was assigned its 
        category.

See the [categorization guide](https://docs.teal.dev/guides/platform/categorization/pipeline) 
        for more details.

The UTC datetime that the Transaction was created. This
        will never be before an Instance's `entries_start` date. When importing 
        transactions, transactions whose datetime is before the Instance’s 
        `entries_start` date will be skipped. Other transactions will be processed 
        as normal.

An arbitrary string on the object, useful for
        displaying information to the user.

The unique ID of the object. This is used as an idempotency 
        key to prevent duplicates. This is manually set as part of the create 
        transactions request. If the transaction is created via a data integration, 
        Plaid for example, it will be set to the `transaction_id` to enforce 
        idempotency with the data source.

Journal Entry

The ID of the Journal Entry that the 
        Transaction's Line Entry is associated with.

Expandable. The Ledger object of the financial 
        account associated with the Transaction.

The ID of the financial account ledger associated 
        with the Transaction.

Line Entry

Line Entry Id

Expandable. A list of the Line Entry objects
        with the opposite `debit_credit` status.

Opposing Line Entries

A list of IDs of all the Line Entries 
        objects in the journal entry with the opposite `debit_credit` status. For
        example if the Transaction's line entry is a debit this opposing line entries
        will be credit line entries.

Opposing Line Entry Ids

Whether the transaction is a non-business personal transaction.

Personal

Indicates if the corresponding journal entry and 
        line entries for the transaction have been have been created. `deleted` 
        indicates that the transaction is `posted` but the corresponding journal entry
        and line entries have been deleted.

Indicates if the transaction has been reviewed. 
        See the [reviewing transactions](https://docs.teal.dev/guides/transactions/reviewing_transactions) 
        for steps on how to use this.

The ID of the transaction source account
        where the transaction is stored.

Source Account Id

Transaction

OAuth2PasswordBearer

ExpandableJournalEntry

TealErrorResponse

Explore our guides, API reference, and changelog

Overview

Follow these steps to begin using the Teal API.

Initial setup

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

Quickstart

Accounting infrastructure for SMB Neobanks and Vertical SaaS.

Use Cases

A glossary of accounting terms and Teal specific definitions

Core concepts

Chart of accounts

How Teal's auto-categorization pipeline works

Categorization

Crafting rules

Invoices and Bills

How to migrate data from QuickBooks into Teal.

QuickBooks migration

Managing ledgers

How to set opening balances to ensure accurate balance sheets.

Opening balances

Use our data integrations so that Teal can do the work of fetching and reconciling transactions from a 3rd party data source.

Integrations

Import via API

Handling business expenses in personal accounts.

Personal accounts

Build a banking feed style transactions page enriched with accounting data

Enriching Transactions

Reviewing transactions

Reports introduction

Cash flow report

View a company's revenues, expenses, and profits over time

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

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

Authentication

Pagination

Expanding responses

Instances

Rate Limits

Lists all the Platform categorization rules.

List all Platform rules

Creates a new Platform categorization rule.

Create a Platform rule

Delete a Platform rule

Lists all the Instance categorization rules.

List all Instance rules

Creates a new Instance categorization rule.

Create an Instance rule

Delete an Instance rule

Create a Chart of Accounts Template

Lists all Chart of Accounts Templates for the Platform.

List all Chart of Accounts Templates

Retrieves details of an existing Chart of Accounts Template.

Retrieve a Chart of Accounts Template

Deletes a Chart of Accounts Template. Instances already using the Chart of Accounts Template will not be affected.

Delete a Chart of Accounts Template

Clones a Chart of Accounts Template and all its Ledger Templates.

Clone a Chart of Accounts Template

Creates a new Ledger Template within a Chart of Accounts Template.

Create a Ledger Template

Update a Ledger Template

Delete a Ledger Template

Retrieves the details of an existing Instance.

Retrieve an Instance

Deletes an Instance in the sandbox environment. To deactivate an Instance in a production environment, use the [Update Subscription](https://docs.teal.dev/api-reference/update-an-instance's-subscription) endpoint.

Delete an Instance

Updates the `start_date` or `name` of an Instance. `accounting_package` is not editable by design.

Update an Instance

Updates an Instance's `subscription`. Set to `tier0` to deactivate the Instance.

Update an Instance's subscription

Creates a new Instance based on the given parameters.

Create an Instance

Lists all Instances belonging to a Platform.

List all Instances

Assign a Bookkeeping Provider

Retrieves information about an existing Journal Entry.

Retrieve a Journal Entry

Updates an existing Journal Entry's details or Line Entries. When updating Line Entries in the Journal Entry, debit and credit amounts must equal.

Update a Journal Entry

Delete a Journal Entry

List all the Journal Entries an Instance.

List all Journal Entries

Creates a new Journal Entry object. The debit and credit amounts of the Line Entries must match.

Create a Journal Entry

Uploads a file and associates it with a Journal Entry.

Create a Journal Entry File

Deletes an existing file associated with a Journal Entry.

Delete a Journal Entry File

Retrieves an existing file associated with a Journal Entry.

Retrieve a Journal Entry File

List all Ledgers

Create a Ledger

Update a Ledger

Deletes a Ledger. Ledgers with line entries cannot be deleted.

Delete a Ledger

Sets the opening balance for a Ledger on the entries start date for the Instance, or updates opening balance if the Ledger already has one. Returns a journal entry.

Set a Ledger's opening balance

Triggers a request for new transactions from a Ledger's data source, if it has one. Success or error messages will be sent via the `transactions.source` webhooks.

API overview

Teal API Endpoints

API Migration

Get all ledgers opening balances

Authorizations

Headers

Response