---
title: "Voucher ledger detailed"
method: GET
path: "/shop/reports/voucher-ledger-detailed"
tags: ["VoucherLedger"]
---

# Voucher ledger detailed

`GET /shop/reports/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`](/endpoints/VoucherLedger#getVoucherLedgerSummaryReport).

## Query parameters

- `site_id` string, uuid, required
- `date_from` string, date, required
- `date_to` string, date, required

## Response `200`

The ledger was successfully generated.

- VoucherLedgerEntry[] — A chronologically-sorted ledger of voucher-related revenue, redemptions, and refunds in the requested period. Money fields are integers in minor units. The `meta` block accompanying the response (see `with` block) carries the opening and closing balances.
  - `date` string, date-time, required
  - `type` 'revenue' | 'payment' | 'refund', required
  - `revenue_centre` string, required
  - `description` string, required
  - `gross_amount` integer, required
  - `net_amount` integer, required
  - `tax_amount` integer, required
  - `meta` object — 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.

## Other responses

- `400` — The request failed.
- `401` — The user is unauthenticated

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)