Skip to main content
GET
Retrieve the Ledger Statement Report

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

business_id
string<biz_string>
required

The ID of the Business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

ledger_id
string<ldg_string>
required

The ID of the Ledger

Example:

"ldg_WQMDNUHpBThYSNh4AprDBo"

Query Parameters

basis
enum<string>
default:modified_cash

Accrual or cash basis. Defaults to ReportBasis.MODIFIED_CASH.

Available options:
accrual,
modified_cash
start_datetime
string<date-time>
required

The start date (inclusive) in ISO-8601 format.

Example:

"2025-01-01T00:00:00Z"

end_datetime
string<date-time>
required

The end date (inclusive) in ISO-8601 format.

Example:

"2026-01-01T00:00:00Z"

page_token
string | null

The page token to for the next or previous page

page_size
integer
default:100
Required range: 1 <= x <= 100

Response

Successful Response

data
LedgerStatementDetails · object
required