Reports

Get the deposit ledger report

Returns the deposit-ledger report — a tabular summary of voucher and credit deposit positions across the site/date range. The response is shaped for display rather than programmatic consumption; consider GET /shop/reports/deposit-ledger-v2/list for a structured per-payable breakdown.

Pass Accept: text/csv to receive the same report as a CSV download instead of a JSON TableReport.

get/shop/reports/deposit-ledger

Query parameters

dateFromstring date
Example:2000-01-01

A date string to retrieve results from

dateTostring date
Example:2000-01-01

A date string to retrieve results to

site_idstring uuid
Example:5dcb47800000000000000010

Scope the deposit-ledger report to a single Site. Omit to include every site the caller has reporting access to. Useful when the report is being run on behalf of a multi-site brand.

Response

The deposit ledger report was successfully retrieved.

Changes