# Teal ## Docs - [Authentication](https://docs.teal.dev/api-reference/api-design/authentication.md) - [Expanding responses](https://docs.teal.dev/api-reference/api-design/expanding_responses.md) - [Instances](https://docs.teal.dev/api-reference/api-design/instances.md) - [Pagination](https://docs.teal.dev/api-reference/api-design/pagination.md) - [Rate Limits](https://docs.teal.dev/api-reference/api-design/rate_limits.md): Learn about the API rate limits - [Create a Platform rule](https://docs.teal.dev/api-reference/categorization/create-a-platform-rule.md): Creates a new Platform categorization rule. - [Create an Instance rule](https://docs.teal.dev/api-reference/categorization/create-an-instance-rule.md): Creates a new Instance categorization rule. - [Delete a Platform rule](https://docs.teal.dev/api-reference/categorization/delete-a-platform-rule.md): Deletes a categorization rule. - [Delete an Instance rule](https://docs.teal.dev/api-reference/categorization/delete-an-instance-rule.md): Deletes an instance categorization rule. - [List all Instance rules](https://docs.teal.dev/api-reference/categorization/list-all-instance-rules.md): Lists all the Instance categorization rules. - [List all Platform rules](https://docs.teal.dev/api-reference/categorization/list-all-platform-rules.md): Lists all the Platform categorization rules. - [Clone a Chart of Accounts Template](https://docs.teal.dev/api-reference/chart-of-accounts-templates/clone-a-chart-of-accounts-template.md): Clones a Chart of Accounts Template and all its Ledger Templates. - [Create a Chart of Accounts Template](https://docs.teal.dev/api-reference/chart-of-accounts-templates/create-a-chart-of-accounts-template.md): Creates a Chart of Accounts Template. - [Create a Ledger Template](https://docs.teal.dev/api-reference/chart-of-accounts-templates/create-a-ledger-template.md): Creates a new Ledger Template within a Chart of Accounts Template. - [Delete a Chart of Accounts Template](https://docs.teal.dev/api-reference/chart-of-accounts-templates/delete-a-chart-of-accounts-template.md): Deletes a Chart of Accounts Template. Instances already using the Chart of Accounts Template will not be affected. - [Delete a Ledger Template](https://docs.teal.dev/api-reference/chart-of-accounts-templates/delete-a-ledger-template.md): Deletes an existing Ledger Template. - [List all Chart of Accounts Templates](https://docs.teal.dev/api-reference/chart-of-accounts-templates/list-all-chart-of-accounts-templates.md): Lists all Chart of Accounts Templates for the Platform. - [Retrieve a Chart of Accounts Template](https://docs.teal.dev/api-reference/chart-of-accounts-templates/retrieve-a-chart-of-accounts-template.md): Retrieves details of an existing Chart of Accounts Template. - [Update a Ledger Template](https://docs.teal.dev/api-reference/chart-of-accounts-templates/update-a-ledger-template.md): Updates an existing Ledger Template. - [Create an Instance](https://docs.teal.dev/api-reference/instances/create-an-instance.md): Creates a new Instance based on the given parameters. - [Retrieve the current Instance](https://docs.teal.dev/api-reference/instances/retrieve-the-current-instance.md): Retrieves the details of the Instance identified by the teal-instance-id header. - [Update the current Instance](https://docs.teal.dev/api-reference/instances/update-the-current-instance.md): Updates the `entries_start`, `name`, or `accounting_basis` of the Instance identified by the teal-instance-id header. - [Create a Journal Entry](https://docs.teal.dev/api-reference/journal-entries/create-a-journal-entry.md): Creates a new Journal Entry object. The debit and credit amounts of the Line Entries must match. - [Create multiple Journal Entries](https://docs.teal.dev/api-reference/journal-entries/create-multiple-journal-entries.md): Creates multiple new Journal Entries. - [Delete a Journal Entry](https://docs.teal.dev/api-reference/journal-entries/delete-a-journal-entry.md): Deletes an existing Journal Entry. - [Delete multiple Journal Entries](https://docs.teal.dev/api-reference/journal-entries/delete-multiple-journal-entries.md): Delete multiple Journal Entries. - [List all Journal Entries](https://docs.teal.dev/api-reference/journal-entries/list-all-journal-entries.md): List all the Journal Entries an Instance. - [Retrieve a Journal Entry](https://docs.teal.dev/api-reference/journal-entries/retrieve-a-journal-entry.md): Retrieves information about an existing Journal Entry. - [Update a Journal Entry](https://docs.teal.dev/api-reference/journal-entries/update-a-journal-entry.md): 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 multiple Journal Entries](https://docs.teal.dev/api-reference/journal-entries/update-multiple-journal-entries.md): Updates multiple existing Journal Entry's details. - [Create a Ledger](https://docs.teal.dev/api-reference/ledgers/create-a-ledger.md): Creates a Ledger. - [Delete a Ledger](https://docs.teal.dev/api-reference/ledgers/delete-a-ledger.md): Deletes a Ledger and optionally its associated journal entries. By default, ledgers with line entries cannot be deleted. Set delete_journal_entries=true to delete the ledger along with: - All journal entries that have line entries on this ledger - All line entries in those journal entries - All rec… - [Delete multiple ledgers in bulk](https://docs.teal.dev/api-reference/ledgers/delete-multiple-ledgers-in-bulk.md): Deletes multiple Ledgers in bulk and optionally their associated journal entries. By default, ledgers with line entries cannot be deleted. Set delete_journal_entries=true to delete each ledger along with: - All journal entries that have line entries on that ledger - All line entries in those journa… - [Get a Ledger](https://docs.teal.dev/api-reference/ledgers/get-a-ledger.md): Get a Ledger. - [Get all ledgers opening balances](https://docs.teal.dev/api-reference/ledgers/get-all-ledgers-opening-balances.md): Returns the opening balance journal entries as a paginated list. - [List all Ledgers](https://docs.teal.dev/api-reference/ledgers/list-all-ledgers.md): Lists all of an Instance's Ledgers. - [Set a Ledger's opening balance](https://docs.teal.dev/api-reference/ledgers/set-a-ledger's-opening-balance.md): 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. - [Update a Ledger](https://docs.teal.dev/api-reference/ledgers/update-a-ledger.md): Updates a Ledger. - [List all Line Entries in a Journal Entry](https://docs.teal.dev/api-reference/line-entries/list-all-line-entries-in-a-journal-entry.md): Lists all the Line Entries in a Journal Entry. - [List all Line Entries in a Ledger](https://docs.teal.dev/api-reference/line-entries/list-all-line-entries-in-a-ledger.md): Lists all Line Entries in a Ledger. - [Transaction Source Account](https://docs.teal.dev/api-reference/migrations/transaction-source-accounts.md): This is a migration guide to switch from ledger transaction endpoints to transaction source account endpoints. - [Create an Instance](https://docs.teal.dev/api-reference/platform/create-an-instance.md): Creates a new Instance based on the given parameters. - [Delete an Instance](https://docs.teal.dev/api-reference/platform/delete-an-instance.md): 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/instances/update-an-instance's-subscription) endpoint. - [List all Instances](https://docs.teal.dev/api-reference/platform/list-all-instances.md): Lists all Instances belonging to a Platform. - [Retrieve an Instance](https://docs.teal.dev/api-reference/platform/retrieve-an-instance.md): Retrieves the details of an existing Instance. - [Retrieve Platform](https://docs.teal.dev/api-reference/platform/retrieve-platform.md): Retrieves details about an existing Platform. - [Update an Instance](https://docs.teal.dev/api-reference/platform/update-an-instance.md): Updates the `entries_start`, `name`, or `accounting_basis` of an Instance. - [Update an Instance's subscription](https://docs.teal.dev/api-reference/platform/update-an-instance's-subscription.md): Updates an Instance's `subscription`. Set to `tier0` to deactivate the Instance. - [Bulk update reconciliation journal entry status](https://docs.teal.dev/api-reference/reconciliation/bulk-update-reconciliation-journal-entry-status.md): Bulk update reconciliation journal entry status. - [Create a Reconciliation](https://docs.teal.dev/api-reference/reconciliation/create-a-reconciliation.md): Creates a new Reconciliation based on the given parameters. - [Delete a Reconciliation and all later reconciliations on the same ledger](https://docs.teal.dev/api-reference/reconciliation/delete-a-reconciliation-and-all-later-reconciliations-on-the-same-ledger.md): Delete a Reconciliation and all later reconciliations on the same ledger. - [Fetch a Reconciliation](https://docs.teal.dev/api-reference/reconciliation/fetch-a-reconciliation.md): Get a reconciliation. - [Fetch Journal Entries for a given reconciliation](https://docs.teal.dev/api-reference/reconciliation/fetch-journal-entries-for-a-given-reconciliation.md): Fetch Journal Entries for reconciliation. - [Fetch Journal Entries for the next reconciliation in a given ledger](https://docs.teal.dev/api-reference/reconciliation/fetch-journal-entries-for-the-next-reconciliation-in-a-given-ledger.md): Fetch Journal Entries for the next reconciliation in a given ledger. - [Get the last completed reconciliation for each ledger](https://docs.teal.dev/api-reference/reconciliation/get-the-last-completed-reconciliation-for-each-ledger.md): Get the last completed reconciliation for each ledger. - [List Reconciliations](https://docs.teal.dev/api-reference/reconciliation/list-reconciliations.md): List an instance's reconciliations. - [Update a Reconciliation](https://docs.teal.dev/api-reference/reconciliation/update-a-reconciliation.md): Update a reconciliation. - [List cash flow totals by period](https://docs.teal.dev/api-reference/reports/list-cash-flow-totals-by-period.md): Retrieves a list of the cash flow data across all cash flow ledgers segmented by period. - [List financial summaries by period](https://docs.teal.dev/api-reference/reports/list-financial-summaries-by-period.md): Lists financial summaries by period. - [List gross profit by period](https://docs.teal.dev/api-reference/reports/list-gross-profit-by-period.md): Lists gross profit calculations by period. - [List net profit by period](https://docs.teal.dev/api-reference/reports/list-net-profit-by-period.md): Lists net profit calculations by period. - [List top expenses](https://docs.teal.dev/api-reference/reports/list-top-expenses.md): Lists the top expenses for the business within the period. - [Retrieve a ledger statement](https://docs.teal.dev/api-reference/reports/retrieve-a-ledger-statement.md): Retrieves a ledger statement for an existing ledger containing the opening and closing balances with all the line entries within the period. - [Retrieve multiple cash flow reports for a given range](https://docs.teal.dev/api-reference/reports/retrieve-multiple-cash-flow-reports-for-a-given-range.md): Retrieves the cash flow report for each period within the range. - [Retrieve the Balance Sheet](https://docs.teal.dev/api-reference/reports/retrieve-the-balance-sheet.md): Retrieves the balance sheet for the business. Returns a list of ledger summaries grouped by ledger `type`. Note: Ledgers with zero balances will be returned if they have underlying transaction activity (transactions that net to zero). Use the `include_empty` parameter to control whether completely… - [Retrieve the balance sheets for a given range](https://docs.teal.dev/api-reference/reports/retrieve-the-balance-sheets-for-a-given-range.md): Retrieves the balance sheets for all periods in the range. Requires a Tier 2 subscription. - [Retrieve the Cash Flow Report](https://docs.teal.dev/api-reference/reports/retrieve-the-cash-flow-report.md): Retrieves the cash flow report for the business. Returns an object with all ledgers whose balanced changed during the period and the starting and ending balances for each cash flow ledger. - [Retrieve the General Ledger Report](https://docs.teal.dev/api-reference/reports/retrieve-the-general-ledger-report.md): Retrieves a list of ledger statements for all ledgers and sub-ledgers in the chart of accounts within the period. Instances with a large chart of accounts or many transactions may encounter slower processing times. - [Retrieve the Income Statement](https://docs.teal.dev/api-reference/reports/retrieve-the-income-statement.md): Retrieves the income statement for the business. Returns a list of ledger summaries grouped by ledger `sub_type` and profit calculations. Related guide: [Income statement](https://docs.teal.dev/guides/reports/income_statement) - [Retrieve the income statements periods for a given range](https://docs.teal.dev/api-reference/reports/retrieve-the-income-statements-periods-for-a-given-range.md): Retrieves an income statement for all periods in a given range. - [Create a tag](https://docs.teal.dev/api-reference/tags/create-a-tag.md): Creates a new tag for an existing instance and tag group. - [Create a tag group](https://docs.teal.dev/api-reference/tags/create-a-tag-group.md): Creates a tag group for the platform. - [Create a tag rule](https://docs.teal.dev/api-reference/tags/create-a-tag-rule.md): Creates a new tag rule for an existing instance. - [Delete a tag](https://docs.teal.dev/api-reference/tags/delete-a-tag.md): Deletes an existing tag for an instance. Associated line entry tags, transaction tags, and tag rules will also be deleted. - [Delete a tag group](https://docs.teal.dev/api-reference/tags/delete-a-tag-group.md): Deletes an existing tag group from the platform. This will also remove all tags this tag group from all line entries and transactions. - [Delete a tag rule](https://docs.teal.dev/api-reference/tags/delete-a-tag-rule.md): Deletes an existing tag rule. - [List all tag groups](https://docs.teal.dev/api-reference/tags/list-all-tag-groups.md): List all tag groups. - [List all tag rules](https://docs.teal.dev/api-reference/tags/list-all-tag-rules.md): Lists all tag rules. - [List all tags](https://docs.teal.dev/api-reference/tags/list-all-tags.md): List of tags belonging to an instance. - [Retrieve a tag](https://docs.teal.dev/api-reference/tags/retrieve-a-tag.md): Retrieves an existing tag. - [Update a tag group](https://docs.teal.dev/api-reference/tags/update-a-tag-group.md): Updates an existing tag group. Unspecified fields will not be updated. - [Create a Transaction Source Account](https://docs.teal.dev/api-reference/transaction-sources/create-a-transaction-source-account.md): Create a transaction source account to manually write transactions. - [Delete a Transaction Source Account](https://docs.teal.dev/api-reference/transaction-sources/delete-a-transaction-source-account.md): Delete a transaction source account. Accounts that contain transactions may not be deleted. - [Delete Ledger Transaction Source](https://docs.teal.dev/api-reference/transaction-sources/delete-ledger-transaction-source.md): Delete Ledger Transaction Source - [Get Plaid Link Statuses](https://docs.teal.dev/api-reference/transaction-sources/get-plaid-link-statuses.md): Returns the status of all Plaid connected financial account ledgers on the platform. - [Get Transaction Source Accounts](https://docs.teal.dev/api-reference/transaction-sources/get-transaction-source-accounts.md): Gets all the transaction source accounts for an instance. - [Link Plaid Account](https://docs.teal.dev/api-reference/transaction-sources/link-plaid-account.md): Link an external financial account via a Plaid processor token to a new or existing manual source account. - [Update a Transaction Source Account](https://docs.teal.dev/api-reference/transaction-sources/update-a-transaction-source-account.md): Update a transaction source account. - [Update Ledger Transaction Source](https://docs.teal.dev/api-reference/transaction-sources/update-ledger-transaction-source.md): Update an existing Plaid source account with a new Plaid processor token. - [Bulk Update Multiple Transactions](https://docs.teal.dev/api-reference/transactions/bulk-update-multiple-transactions.md): Update multiple transactions. The maximum number of transactions that can be updated at once is 100. - [Create Transactions](https://docs.teal.dev/api-reference/transactions/create-transactions.md): Creates Transactions into a Transaction Source Account. Returns a Transaction Processing Task. - [Delete a Transaction](https://docs.teal.dev/api-reference/transactions/delete-a-transaction.md): Deletes an existing Transaction. - [Delete all Transactions in a Source Account](https://docs.teal.dev/api-reference/transactions/delete-all-transactions-in-a-source-account.md): Deletes all Transactions in a Transaction Source Account. - [List a Source Account's Transactions](https://docs.teal.dev/api-reference/transactions/list-a-source-account's-transactions.md): Returns a list of Transactions in a Transaction Source Account. - [List Transaction Processing Tasks](https://docs.teal.dev/api-reference/transactions/list-transaction-processing-tasks.md): List Transaction Processing Tasks. - [Retrieve a Transaction](https://docs.teal.dev/api-reference/transactions/retrieve-a-transaction.md): Returns a single Transaction. - [Retrieve a Transaction Processing Task](https://docs.teal.dev/api-reference/transactions/retrieve-a-transaction-processing-task.md): Retrieves an existing Transaction Processing Task. - [Update a Transaction](https://docs.teal.dev/api-reference/transactions/update-a-transaction.md): Updates a specific Transaction. Any parameters not specified will not be changed. - [Managing ledgers](https://docs.teal.dev/guides/instances/create_ledger.md) - [Opening balances](https://docs.teal.dev/guides/instances/opening_balances.md): How to set opening balances to ensure accurate balance sheets. - [Overview](https://docs.teal.dev/guides/instances/overview.md) - [Excel exports](https://docs.teal.dev/guides/interfaces/excel_export.md): How and why to generate Excel exports from your Teal data - [Journal Entry Interface](https://docs.teal.dev/guides/interfaces/journal_entry.md): Customers need to be able to manually create and edit journal entries. - [Use Cases](https://docs.teal.dev/guides/introduction/about_teal.md): Accounting infrastructure for SMB Neobanks and Vertical SaaS. - [Core concepts](https://docs.teal.dev/guides/introduction/core_concepts.md): A glossary of accounting terms and Teal specific definitions - [Initial setup](https://docs.teal.dev/guides/introduction/initial_setup.md): Follow these steps to begin using the Teal API. - [Overview](https://docs.teal.dev/guides/introduction/overview.md): Explore our guides, API reference, and changelog - [Quickstart](https://docs.teal.dev/guides/introduction/quickstart_guide.md): See Teal in action by building a real cash flow report. - [Invoices and Bills](https://docs.teal.dev/guides/platform/ar_ap.md): How to sync Invoices and Bills to Teal - [Categorization](https://docs.teal.dev/guides/platform/categorization/pipeline.md): How Teal's auto-categorization pipeline works - [Crafting rules](https://docs.teal.dev/guides/platform/categorization/rules.md): How to craft categorization rules - [Tags](https://docs.teal.dev/guides/platform/categorization/tags_config.md): How to segment reports using Tags - [Chart of accounts](https://docs.teal.dev/guides/platform/chart_of_accounts_config.md) - [Overview](https://docs.teal.dev/guides/platform/your_platform.md) - [Balance sheet](https://docs.teal.dev/guides/reports/balance_sheet.md): How to build a balance sheet using Teal. - [Cash flow report](https://docs.teal.dev/guides/reports/cash_flow_report.md) - [Enriching non-Teal reports](https://docs.teal.dev/guides/reports/enriching.md): Fetching Teal data to add to your non-Teal reports - [General ledger report](https://docs.teal.dev/guides/reports/general_ledger.md): How to build a general ledger report using Teal. - [Income statement](https://docs.teal.dev/guides/reports/income_statement.md): View a company's revenues, expenses, and profits over time - [Ledger statement](https://docs.teal.dev/guides/reports/ledger_statement.md): How to build a ledger statement using Teal. - [Reports introduction](https://docs.teal.dev/guides/reports/reports_introduction.md): Build reports for your users - [Integrations](https://docs.teal.dev/guides/transactions/data_integrations.md): Use our data integrations so that Teal can do the work of fetching and reconciling transactions from a 3rd party data source. - [Reviewing transactions](https://docs.teal.dev/guides/transactions/reviewing_transactions.md): Build a transaction review workflow - [Import via API](https://docs.teal.dev/guides/transactions/submitting.md): Create transactions using the API - [Enriching Transactions](https://docs.teal.dev/guides/transactions/transactions.md): Build a banking feed style transactions page enriched with accounting data ## OpenAPI Specs - [openapi](https://docs.teal.dev/openapi.json) ## Optional - [Changelog](https://teal.dev/changelog)