---
title: "List LedgerLines"
method: GET
path: "/shop/reports/voucher-ledger/list"
tags: ["VoucherLedger"]
---

# List LedgerLines

`GET /shop/reports/voucher-ledger/list`

Use this endpoint to retrieve a list of `VoucherLedgerVoucher` resources.

## Query parameters

- `site_id` string, uuid
- `page` integer
- `date` string, date

## Response `200`

The list of `VoucherLedgerVoucher` resources was successfully retrieved

- ListVoucherLedgerResponse
  - `data` VoucherLedgerVoucher[], required
    - `id` string, object-id, required — The ID of the voucher.
    - `code` string, required — The voucher code.
    - `valid_from_date` string, date-time, required — The date and time the voucher code is valid from.
    - `valid_to_date` string, date-time, required — The date and time the voucher code is valid to.
    - `amount_type` 'cash' | 'free_item', required — The type of the voucher code.
    - `amount` integer, required — The face value of the voucher code.
    - `balance` integer, required — The remaining balance of the voucher code.
    - `revenue_amount` integer, required — The amount of revenue from the voucher (i.e. what it was sold for).
    - `difference_amount` integer, required — The difference between the voucher's amount and its revenue amount.
    - `ledger_balance` integer, required — The balance of the voucher at the date of the report.
    - `ledger_balances` VoucherLedgerBalances, required
      - `voucher` integer, required — The balance of the voucher revenue centre at the date of the report.
      - `voucher_difference` integer, required — The balance of the voucher_difference revenue centre at the date of the report.
      - `voucher_discount` integer, required — The balance of the voucher_discount revenue centre at the date of the report.
      - `voucher_redemption` integer, required — The balance of the voucher_redemption revenue centre at the date of the report.
      - `voided_voucher` integer, required — The balance of the voided_voucher revenue centre at the date of the report.
    - `currency` string, required — The currency of the voucher code. See [Supported Currencies](/endpoints/Meta#metaSupportedCurrencies) for a list of supported currencies.
    - `partially_redeemable` boolean, required — Whether the voucher code is partially redeemable.
    - `voucher_name` string, required — The name of the voucher type.
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

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