GET
/
v0
/
reports
/
ledger-statement
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/reports/ledger-statement \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "ledger_statement": {
    "amount": 17080.11,
    "closing_balance": 31253.29,
    "debit_credit": "debit",
    "end_date": "2024-03-31",
    "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
    "lines": [
      {
        "amount": 31282.28,
        "datetime": "2023-02-15T06:42:18Z",
        "debit_credit": "debit",
        "description": "Payroll#230215",
        "editable": false,
        "id": "XMDsKVuW4Wmi3LTW31Qw6E",
        "journal_entry_description": "Payroll#230215",
        "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
        "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
        "ledger_name": "Pluto Checking 4242",
        "transaction_id": "txn_MtcXSgvy"
      }
    ],
    "name": "Pluto Checking 4242",
    "opening_balance": 14173.18,
    "start_date": "2024-01-01",
    "sub_type": "current_assets",
    "type": "asset"
  }
}

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

ledger_id
string
required

The ledger ID

start_date
string
required

Only include data after the start date (inclusive).

end_date
string
required

Only include data before the end date (inclusive).

limit
integer | null

The number of records to return. Max limit is 1000.

page_token
string
tag_ids
string

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

Response

200 - application/json
next_page_token
string | null
required

The token to use to request the next page

prev_page_token
string | null
required

The token to use to request the previous page

ledger_statement
object
required

The Ledger Statement object.