Voucher Setup

Voucher Setup

🌐 Backend — EQuipWebRetail ModeSales Setup

Sales Setup — 4.12 Voucher Setup

Use Voucher Setup to create and manage gift vouchers for your customers. You can generate single vouchers or print them in bulk with unique codes. Customers redeem these vouchers as payment at the POS. Vouchers can be created individually or generated in batches with configurable prefixes, numbering sequences, and denominations. The system tracks the full voucher lifecycle: Published → Redeemed → Expired.

When to use this: When you want to create gift vouchers for your customers.

Prerequisites

  • Payment Mode for voucher redemption configured
  • Outlets configured for voucher validity

Voucher List

Voucher Setup List

📝 General Description

The list displays all vouchers with their numbers, status, and validity dates. In the screenshot above, there is one voucher: VH00001 ("voucher 10K") with status PUBLISHED, valid from 14 Jan 2026 to 14 Jan 2027.

⚙️ Configuration Guide & UI Elements

  • 🔴 1. Add New
    • Element Type: Button (Green)
    • Function: Opens the form to create a new voucher or generate a batch.
  • 🔴 2. Search Bar
    • Element Type: Input Field (Search in voucher name)
    • Function: Filters by voucher name or number.
  • 🔴 3. Filter Icon (🔽)
    • Element Type: Funnel button
    • Function: Opens advanced filter panel (status filter, show deleted).

📊 Column Descriptions

ColumnDescriptionExample
IDUnique voucher ID (clickable — opens edit form)VH00001
VoucherVoucher name/labelvoucher 10K, CNY Gift Card
StatusCurrent lifecycle status — see belowPUBLISHED, REDEEMED
Start DateValidity start date14 Jan 2026 12:00 AM
EndDateValidity end date14 Jan 2027 12:00 AM
DeletedHidden/deleted status☐ / ☑

📋 Voucher Status Lifecycle

StatusMeaningWhat Happens at POS
PUBLISHEDVoucher is active and ready to be used.Cashier can scan/enter this voucher code to apply its value to a transaction.
REDEEMEDVoucher has been used in a transaction.Cannot be used again. The system blocks re-scanning.
EXPIREDVoucher has passed its end date.System automatically rejects it at POS with an "Expired" message.

Add / Edit Voucher

Click + Add New or click an ID link to open the form:

Single Voucher

FieldTypeRequiredDescription
Voucher IDAuto-generatedSystem-generated unique ID (e.g., VH00001).
Voucher NameTextYesDisplay name (e.g., "CNY $50 Gift Card").
AmountNumberYesDollar value of the voucher.
Start DateDate PickerNoWhen the voucher becomes valid. Before this date, POS will reject it.
End DateDate PickerNoWhen the voucher expires. After this date, POS will reject it with "Expired" message. Leave blank for no expiry.
StatusDropdownNoPUBLISHED (default), REDEEMED, or EXPIRED.

Batch Generation

Generate multiple vouchers at once with sequential numbering:

FieldTypeDescription
PrefixTextStarting characters (e.g., GV-).
SuffixTextEnding characters (e.g., -SG).
Number of DigitsNumberLength of numeric portion (e.g., 40001).
Start NumberNumberFirst number in sequence (e.g., 1).
End NumberNumberLast number in sequence (e.g., 100).

Example: Prefix GV-, 4 digits, Start 1, End 100 → generates vouchers GV-0001 through GV-0100.


How to Edit a voucher

  1. In the Voucher Setup page, find the voucher you want to change.

  1. Click the blue voucher name link. The edit form opens — it looks the same as the "Add New" form, but all fields are already filled in with the current values.

  1. Change the fields you need to update.

  2. Click Save to apply your changes.

Expected Result: The voucher is saved with status PUBLISHED and redeemable at POS.

[!TIP] To make changes, just click the name of any voucher in the list — the same form opens with everything already filled in. Change what you need and click Save.


💡 Example

Chinese New Year Gift Voucher Campaign

Scenario: A retail chain wants to sell $50 gift vouchers for CNY.

  1. Click + Add New → switch to Batch Generation mode.

2. Set: Prefix = CNY2026-, Digits = 4, Start = 1, End = 500, Amount = $50.00. 3. Set Start Date = 01 Jan 2026, End Date = 28 Feb 2026.

4. Click Generate — this creates 500 vouchers: CNY2026-0001 to CNY2026-0500.

5. Print the voucher codes and sell them at the counter. 6. When a customer presents voucher CNY2026-0123, the cashier scans/enters the code at POS.

7. The $50 value is applied as a payment method → voucher status changes to REDEEMED. 8. After 28 Feb 2026, any unused vouchers automatically become EXPIRED.

Refund Voucher

Scenario: A customer returns an item worth $25. Instead of cash refund, issue a store credit voucher.

  1. Click + Add New (single mode).

2. Set: Voucher Name = Refund-CustName, Amount = $25.00, No End Date. 3. Print/email the voucher code to the customer. 4. Customer redeems it on their next visit.


Actions

ActionWhen AvailableDescription
SaveAlwaysSaves the voucher record
Save and NewAlwaysSaves then opens a blank form
Generate BatchAdd modeGenerates multiple vouchers at once
DeleteEdit mode (not deleted)Removes the voucher
RestoreEdit mode (deleted)Restores a safely deleted voucher

Access & Permissions

RoleViewCreateEditDelete
AdminYesYesYesYes
SupervisorYesYesYesNo
CashierNo backend access

[!NOTE] Exact permissions depend on the Privileges Setup configured for each role. Contact your administrator if you cannot access this page.


How to Delete a Voucher

  1. Navigate to Voucher Setup from the sidebar menu.

2. Click the name or code link (blue text) of the record you want to delete. 3. In the edit form, scroll down to the bottom.

4. Click the Delete button (red button). 5. A confirmation dialog appears — click Yes to confirm deletion.

Expected Result: The record is soft-deleted — it is hidden from the active list and POS terminals but can be restored later using the "Show Deleted" filter.

[!WARNING] Records linked to active transactions or other modules cannot be deleted. The system will display an error if deletion is not allowed.


How to Add a New Voucher

  1. Navigate to Voucher Setup from the sidebar menu.

  1. Click the + Add New button (green button).

  2. Fill in the required fields in the form.

  1. Fill in any optional fields as needed.

  2. Click Save to create the new voucher.

Expected Result: The new voucher appears in the list and is available for use across the system.


FAQ

Q: Why is this payment mode not appearing on the POS? A: Check that the payment mode is marked as Active and assigned to the correct outlet. The POS also needs to sync.

Q: Can I edit a completed sales transaction? A: No. Completed transactions cannot be edited. You can void the transaction and create a new one if correction is needed.

Q: How do I set up a new tax rate without affecting past transactions? A: Create a new GST rate with a future Commence Date. The system will automatically apply the old rate to past transactions and the new rate from the effective date.


Troubleshooting

IssuePossible CauseSolution
Cannot save the recordRequired fields are empty or invalidCheck all fields marked with * and fill in valid data
Record not appearing in POSPOS terminal has not synced yetWait for the next sync cycle or manually trigger sync from Terminal Status
Cannot delete the recordRecord is being used by other modulesCheck if the record is linked to active transactions, products, or other settings
Changes not taking effectBrowser cache showing old dataRefresh the page (Ctrl+F5) or clear browser cache
"Duplicate" error on saveA record with the same name/code already existsSearch the list (including deleted records) for duplicates
Page not loadingSession expired or network issueLog out and log back in. Check your internet connection

  • Product Setup > Product List — products linked to pricing
  • Master Data > Outlet Setup — outlet-specific payment modes
  • Master Data > POS Setup — POS terminal configuration
  • Setting > Feature Setup — enable/disable sales features

Open Questions / Confirmation Needed

[!NOTE] The following items may vary depending on your system version and configuration:

  • Exact permission settings depend on your Privileges Setup configuration
  • Sync timing to POS terminals depends on network conditions and sync schedule
  • Some features may require additional licensing or module activation
  • Field behavior may differ between EQuip versions

If you encounter behavior not described in this manual, contact your system administrator or EQuip support team.

    • Related Articles

    • Campaign Setup

      ? Backend — EQuipWebRetail ModeMembership Setup Chapter 3: Membership Setup — 3.6 Campaign Setup Use Campaign Setup to create time-limited promotions for your loyalty members — like "Double Points Weekend" or "Birthday Month 20% Off". Campaigns run ...
    • Referral Setup

      ? Backend — EQuipWebRetail ModeMembership Setup Chapter 3: Membership Setup — 3.4 Referral Setup Use Referral Setup to reward your existing members when they bring in new customers. Set up the reward — like bonus points or a discount — and the ...
    • Membership Setup

      ? Backend — EQuipWebRetail ModeMembership Setup Chapter 3: Membership Setup — 3.1 Membership List The Membership List is where you manage all your loyalty members. You can look up a customer, check their points balance, update their details, or see ...
    • Membership Group Setup

      ? Backend — EQuipWebRetail ModeMembership Setup Chapter 3: Membership Setup — 3.2 Membership Group Setup Use Membership Group Setup to create your loyalty tiers — like Regular, Gold, Platinum, or Diamond. Each tier can have different benefits, ...
    • Membership Benefit Setup

      ? Backend — EQuipWebRetail ModeMembership Setup Chapter 3: Membership Setup — 3.3 Membership Benefit Setup Use Membership Benefit Setup to give your loyalty members automatic discounts. For example, Gold members might get 10% off all purchases. Set ...