Skip to main content
GET
/
v0
/
ledgers
/
opening-balances
Get all ledgers opening balances
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/ledgers/opening-balances \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "id": "<string>",
      "description": "<string>",
      "datetime": "2023-11-07T05:31:56Z",
      "creation_date": "2023-11-07T05:31:56Z",
      "is_opening_balance": true,
      "creation_source": "manual",
      "line_entry_ids": [
        "XMDsKVuW4Wmi3LTW31Qw6E",
        "NULcvXTkLczde32qs1rqgB"
      ],
      "linked_entity": null,
      "line_entries": [
        {
          "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",
          "tags": [],
          "transaction_id": "txn_UjL3BQnEaJtecuC7CUeDk"
        },
        {
          "amount": 31282.28,
          "datetime": "2023-02-15T06:42:18Z",
          "debit_credit": "credit",
          "description": "Payroll#230215",
          "editable": false,
          "id": "NULcvXTkLczde32qs1rqgB",
          "journal_entry_description": "Payroll#230215",
          "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
          "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
          "ledger_name": "Payroll Expense",
          "tags": []
        }
      ],
      "accrual_source": {
        "id": "<string>",
        "instance_id": "<string>",
        "reference_number": "<string>",
        "type": "invoice",
        "status": "paid",
        "effective_date": "2023-12-25",
        "gross_amount": 123,
        "amount_paid": 123,
        "amount_adjusted": 123,
        "amount_outstanding": 123,
        "external_id": "<string>",
        "external_party_id": "<string>",
        "due_date": "2023-12-25",
        "notes": "<string>",
        "lines": [
          {
            "id": "<string>",
            "accrual_source_id": "<string>",
            "account_id": "<string>",
            "line_number": 123,
            "description": "<string>",
            "amount": 123,
            "external_id": "<string>"
          }
        ]
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your auth token.

Headers

​
teal-instance-id
string
required

The Teal instance ID

Query Parameters

​
limit
integer
default:50

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

Required range: x >= 1
​
page_token
string | null

Opaque page token

Response

Successful Response

​
next_page_token
string | null
required

The token to use to request the next page

Example:

"ikal0NEVfMhF8dJf4yQ6KQZmGD"

​
prev_page_token
string | null
required

The token to use to request the previous page

Example:

"vuA7JeKI5c6FLnPt5JfRcZcJxW"

​
records
ExpandableJournalEntry · object[]
required

List of journal entries

Example:
[
  {
    "creation_date": "2023-02-15T06:42:18Z",
    "creation_source": "manual",
    "datetime": "2023-02-15T06:42:18Z",
    "description": "Payroll#230215",
    "id": "C4ocnUQze8kDwQ3EczkZXn",
    "is_opening_balance": false,
    "line_entry_ids": [
      "XMDsKVuW4Wmi3LTW31Qw6E",
      "NULcvXTkLczde32qs1rqgB"
    ]
  }
]