Sign in
VoucherLedger

Voucher ledger summary

Returns a single-line summary of voucher sales, redemptions, and the resulting opening and closing voucher liability balances for the given period at a site. Use this to reconcile the deferred-revenue balance held against Trybe-issued vouchers. For a line-by-line breakdown, see /shop/reports/voucher-ledger-detailed.

get/shop/reports/voucher-ledger-summary

Query parameters

site_idstring uuid required

The site to compute the voucher ledger for.

date_fromstring date required
Example:2026-06-01

Start of the date range covered by the ledger.

date_tostring date required
Example:2026-06-30

End of the date range covered by the ledger.

Response

The summary was successfully generated.

Example response

{
  "revenues": {
    "revenue_centre": "voucher",
    "description": "Trybe Voucher Sales"
  },
  "payments": {
    "revenue_centre": "voucher_redemption",
    "description": "Trybe Voucher Redemptions"
  },
  "meta": {
    "currency": "gbp"
  }
}

Changes