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

# Voucher ledger summary

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

## Query parameters

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

## Response `200`

The summary was successfully generated.

- VoucherLedgerSummaryResponseDate — Summary of voucher revenue and redemptions for the given date range. Money fields are integers in minor units. Use this report to reconcile the deferred-revenue balance held against Trybe voucher sales.
  - `revenues` VoucherLedgerRevenueLine, required
    - `revenue_centre` string, required
    - `description` string, required
    - `gross_amount` integer, required
    - `net_amount` integer, required
    - `tax_amount` integer, required
    - `count` integer, required
  - `payments` VoucherLedgerPaymentLine, required
    - `revenue_centre` string, required
    - `description` string, required
    - `amount` integer, required — A negative number representing the value of vouchers redeemed in the period.
    - `count` integer, required
  - `meta` VoucherLedgerMeta, required
    - `currency` string, required
    - `opening_balance` integer, required — The outstanding voucher liability balance at the start of the period, in minor units.
    - `closing_balance` integer, required — The outstanding voucher liability balance at the end of the period, in minor units.

## 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)