Sign in
VoucherLedger

List LedgerLines

Use this endpoint to retrieve a list of VoucherLedgerVoucher resources.

get/shop/reports/voucher-ledger/list

Query parameters

site_idstring uuid

Retrieve the ledger voucher details for this site.

pageinteger

The page to retrieve results from

datestring date
Example:2023-05-05

Retrieve the ledger voucher details as at this date.

Response

The list of VoucherLedgerVoucher resources was successfully retrieved

Example response

{
  "data": [
    {
      "code": "ABC123XYZ",
      "valid_from_date": "2023-04-02T00:00:00+01:00",
      "valid_to_date": "2023-04-02T00:00:00+01:00",
      "amount": 10000,
      "balance": 5000,
      "revenue_amount": 8000,
      "difference_amount": 2000,
      "ledger_balance": 5000,
      "ledger_balances": {
        "voucher": 5000,
        "voucher_difference": 2000
      },
      "currency": "gbp",
      "voucher_name": "£100 treatment voucher"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes

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