GET
/
v0
/
reports
/
general-ledger
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/reports/general-ledger \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "start_date": "2024-01-01",
  "end_date": [
    "2024-03-31"
  ],
  "records": [
    {
      "amount": 17080.11,
      "children": [],
      "closing_balance": 31253.29,
      "debit_credit": "debit",
      "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,
      "sub_type": "current_assets",
      "total_amount": 17080.11,
      "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

start_date
string
required

Only include data after the start date (inclusive).

end_date
string
required

Only include data before the end date (inclusive).

Response

200 - application/json
start_date
string
required

The start date of the report (inclusive). Must be in YYYY-MM-DD format.

end_date
string
required

The end date of the report (inclusive). Must be in YYYY-MM-DD format.

records
object[]
required

A list of all Ledger Statement objects.