GET
/
v0
/
reports
/
balance-sheet
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/reports/balance-sheet \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "records": [
    {
      "amount": 0,
      "children": [
        {
          "amount": 0,
          "children": [
            {
              "amount": 95582.71,
              "debit_credit": "debit",
              "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
              "name": "Pluto Checking 4242",
              "sort_code": "1011",
              "sub_type": "current_assets",
              "total_amount": 95582.71,
              "type": "asset"
            }
          ],
          "name": "Current Assets",
          "total_amount": 95582.71
        }
      ],
      "name": "Asset",
      "total_amount": 95582.71
    },
    {
      "amount": 0,
      "children": [
        {
          "amount": 0,
          "children": [
            {
              "amount": 8067,
              "debit_credit": "credit",
              "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
              "name": "Pluto Credit Card 2424",
              "sort_code": "2010",
              "sub_type": "current_liabilities",
              "total_amount": 8067,
              "type": "liability"
            }
          ],
          "name": "Current Liabilities",
          "total_amount": 8067
        }
      ],
      "name": "Liability",
      "total_amount": 8067
    },
    {
      "amount": 0,
      "children": [
        {
          "amount": 0,
          "children": [
            {
              "amount": 87515.71,
              "debit_credit": "credit",
              "ledger_id": "WhvrC7XAES1fDrpWWgmPtg",
              "name": "Opening Balance Retained Earnings",
              "sort_code": "8010",
              "sub_type": "equity",
              "total_amount": 87515.71,
              "type": "equity"
            }
          ],
          "name": "Equity",
          "total_amount": 87515.71
        }
      ],
      "name": "Equity",
      "total_amount": 87515.71
    }
  ]
}

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

teal-instance-id
string
required

The Teal instance ID

Query Parameters

end_date
string
required

The balance sheet as of the end date (inclusive). The start date for a balance sheet is always the entries_start date of the Instance.

tag_ids
string

Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription

Response

200 - application/json
records
object[]
required

A list of Records that represents either a ledger or a groups of ledgers.

Records that are groups of ledgers are grouped by balance sheet type: asset, liability, and equity, in that order, and then by sub_type. Within each sub_type group, Ledger objects are ordered by sort_code.