Skip to main content
GET
/
v1
/
ledgers
/
{id}
/
statement
{
  "statement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledger_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "period": {
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z"
  },
  "opening_balance": 123,
  "closing_balance": 123,
  "total_credits": 123,
  "total_debits": 123,
  "entries": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledger_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "type": "credit",
      "description": "<string>",
      "balance": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Ledger UUID

Query Parameters

​
from_date
string<date-time>
required

Statement start date

​
to_date
string<date-time>
required

Statement end date

​
format
enum<string>
default:json

Statement format

Available options:
json,
pdf,
csv

Response

Statement generated successfully

​
statement_id
string<uuid>
​
ledger_id
string<uuid>
​
period
object
​
opening_balance
integer

Opening balance in cents

​
closing_balance
integer

Closing balance in cents

​
total_credits
integer

Total credits in cents

​
total_debits
integer

Total debits in cents

​
entries
object[]