#! /usr/bin/env node
const fs = require('fs');
const openapi_schema = require("../openapi.json");


// Clean up server urls byt removing trailing /
for (const server of openapi_schema.servers) {
    server.url = server.url.replace(/\/$/,"");
}

// Override openapi.json file with changes
fs.writeFileSync("openapi.json", JSON.stringify(openapi_schema));




#! /usr/bin/env node
const fs = require('fs');
const openapi_schema = require("../openapi.json");

const groups = {};
const navigationTree = []

for (const [uri, subPaths] of Object.entries(openapi_schema.paths)) {
    for (const [method, pathObj] of Object.entries(subPaths)) {
        const title = pathObj.summary;
        const openapi = `${method.toUpperCase()} ${uri}`;
        const description = pathObj.description? pathObj.description.replaceAll("\n", " ") : pathObj.summary;
        const fileName = title.toLowerCase().replaceAll(" ", "-");
        const folder = pathObj.tags[0].toLowerCase().replaceAll(" ", "-");
        const text = `---\ntitle: "${title}"\nopenapi: "${openapi}"\ndescription: "${description}"\n---`;
        const page = `api-reference/${folder}/${fileName}`;
        
        const group = pathObj.tags[0]
        if (!(group in groups)) groups[group] = [];
        groups[group].push(page)
        
        fs.writeFileSync(`${page}.mdx`, text);
    }
}

for (const [group, pages] of Object.entries(groups)) {
    navigationTree.push({group, pages})
}

const sortedNavigationTree = navigationTree.sort((a, b ) => { 
    const aIndex = navigationTree.indexOf(a); 
    const bIndex = navigationTree.indexOf(b); 
    return navigationTree[aIndex].group.toLowerCase().localeCompare(navigationTree[bIndex].group.toLowerCase());
})

console.log("Navigation object suggestion:")
console.log(JSON.stringify(sortedNavigationTree, null, 2));

Delete Payable

TealErrorCode

OAuth2PasswordBearer

TealErrorResponse

Teal

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

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

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

API Reference

Changelog

Guides

Developer Portal

How Teal's auto-categorization pipeline works

Categorization

Crafting rules

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

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

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.

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

Updates multiple existing Journal Entry's details.

Update multiple Journal Entries

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

Returns the opening balance journal entry

Get all ledgers opening balances

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.

Check a Ledger for new transactions

Retrieves the Ledger's current balanced status and the most recent datetime it was balanced.

Retrieve a Ledger's balanced status

Update a Line Entry

Retrieves the category ID or IDs of a Line Entry.

Retrieve a Line Entry's categories

Lists all the Line Entries in a Journal Entry.

List all Line Entries in a Journal Entry

List all Line Entries in a Ledger

Get Ledger Payables

Create Payable

Get Payable

Update Payable

Get Payable Status

Retrieves details about an existing Platform.

Retrieve Platform

Creates a URL for connecting an Instance to a QuickBooks Company file.

Create a QuickBooks Auth link

Get QuickBooks sources

Get Migrate Quickbooks Task

Migrate a QB instance. The migration is asynchronous.

Migrate Quickbooks Instance

Get Ledger Receivables

Create Receivable

Get Receivable

Update Receivable

Delete Receivable

Get Receivable Status

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 Statement

Retrieves the balance sheet for the business. Returns a list of ledger summaries grouped by ledger `type`. Requires a Tier 2 subscription.

Retrieve the Balance Sheet

Retrieves a ledger statement for an existing ledger containing the opening and closing balances with all the line entries within the period.

Retrieve a ledger statement

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 Cash Flow Report

Retrieves a list of the cash flow data across all cash flow ledgers segmented by period.

List cash flow totals by period

Retrieves a list of cash flow data segmented by ledger.

List cash flow totals by ledger

Lists the top expenses for the business within the period.

List top expenses

List net profit by period

Lists gross profit calculations by period.

List gross profit by period

List financial summaries by period

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 General Ledger Report

Retrieve a tag group

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 group

Updates an existing tag group. Unspecified fields will not be updated.

Update a tag group

List all tag groups

Create a tag group

List all tag rules

Creates a new tag rule for an existing instance.

Create a tag rule

Retrieve a tag rule

Delete a tag rule

Updates a tag rule. Unspecified fields will not be updated.

Update a tag rule

Retrieve a tag

Deletes an existing tag for an instance. Tags on existing line entries and transactions will not be deleted.

Delete a tag

Updates an existing tag. Unspecified fields will not be updated.

Update a tag

List all tags

Creates a new tag for an existing instance and tag group.

Create a tag

Removes a tag from a list of transactions.

Remove a tag from a list of transactions

Delete Ledger Transaction Source

Update Ledger Transaction Source

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 a transaction source account to manually write transactions.

API overview

Teal API Endpoints

API Migration

Delete Payable

Authorizations

Headers

Path Parameters

Response