PHphorest
Voucher

List vouchers

Get a list of vouchers for the specified business id. List can be filtered by client id, serial number, DateTime of update and possibility to include used vouchers

get/api/business/{businessId}/voucher

Request

Path parameters

businessIdstring required

Query parameters

clientIdstring

client id to filter by

serialNumberstring

serial number to filter by

includeUsedboolean

include used vouchers in the list

updated_fromstring

date-time from which the vouchers has been updated onwards

updated_tostring

date-time to which the vouchers has been updated backwards

number of voucher records to return, max is 200

page number, default is 0 and is optional

Response

Vouchers listed

Example response

{
  "_embedded": {
    "vouchers": [
      {
        "serialNumber": "123456",
        "clientId": "WwEaIb0m4bhJphVtm2VgIw",
        "creatingBranchId": "SE-J0emUgQnya14mOGdQS",
        "originalBalance": 123.12,
        "notes": "Example note",
        "voucherId": "ab-123",
        "remainingBalance": 123.45
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.