Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Voucher

Create a voucher

Create and return a voucher for the specified business id

post/api/business/{businessId}/voucher

Path parameters

businessIdstring required

Request body

serialNumberstring
issueDatestring date-time required
expiryDatestring date-time required
clientIdstring
creatingBranchIdstring required
originalBalancenumber required
notesstring

Example request

{
  "serialNumber": "123456",
  "clientId": "WwEaIb0m4bhJphVtm2VgIw",
  "creatingBranchId": "SE-J0emUgQnya14mOGdQS",
  "originalBalance": 123.12,
  "notes": "Example note"
}

Response

Voucher created successfully

serialNumberstring
issueDatestring date-time required
expiryDatestring date-time required
clientIdstring
creatingBranchIdstring required
originalBalancenumber required
notesstring
voucherIdstring
createdAtstring date-time
updatedAtstring date-time
remainingBalancenumber

Example response

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