Skip to main content
GET
/
v1
/
ledgers
Get all ledgers
curl --request GET \
  --url https://api.example.com/v1/ledgers \
  --header 'Authorization: Bearer <token>'
{
  "ledgers": [
    {
      "ledger": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "code": "<string>",
        "description": "<string>",
        "type": "asset",
        "currency_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "currency_code": "<string>",
        "balance_current": 123,
        "balance_available": 123,
        "overdraft_enabled": true,
        "overdraft_limit": 123,
        "last_activity_date": "2023-11-07T05:31:56Z",
        "opening_date": "2023-11-07T05:31:56Z",
        "closing_date": "2023-11-07T05:31:56Z",
        "parent_ledger_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "child_ledger_ids": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "modified_at": "2023-11-07T05:31:56Z",
        "modified_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "active": true,
        "metadata": {}
      }
    }
  ],
  "total_count": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
type
enum<string>

Filter by ledger type

Available options:
asset,
liability,
equity,
income,
expense
​
currency_code
string

Filter by currency code

Required string length: 3
​
active
boolean

Filter by active status

Response

Successfully retrieved ledgers

​
ledgers
object[]
​
total_count
integer

Total number of ledgers