Skip to main content
GET
Get ledger statement

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[]