Sign in
VoucherLedger

Voucher ledger detailed

Returns a chronological line-by-line ledger of voucher sales, redemptions, and refunds in the requested period at a site. Each entry is annotated with the order, basket item, payment, voucher code, and (where relevant) refund it relates to so it can be linked back to the underlying records.

For a single-line aggregate of the same period, see /shop/reports/voucher-ledger-summary.

get/shop/reports/voucher-ledger-detailed

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 ledger was successfully generated.

datestring date-time required
type'revenue' | 'payment' | 'refund' required
revenue_centrestring required
descriptionstring required
gross_amountinteger required
net_amountinteger required
tax_amountinteger required
metaobject

Contextual references for the ledger entry — e.g. order_ref, basket_id, payment_id, voucher_code_id, or refund_id depending on the entry type.

Example response

[
  {
    "revenue_centre": "voucher",
    "description": "Trybe Voucher Sales"
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.