Vouchers

Vouchers can be used to reduce the amount of a transaction.

You can use the vouchers object to model vouchers.

Vouchers and Discounts

It is worth considering the general difference between vouchers and discounts.

Discounts

Generally, discounts reduce the amount to be paid on the invoice. Tax is applied to the full invoice amount and the discount is taken off afterwards.

For example, if the invoice is for €10.00 + €2.30 VAT, a €5.00 discount would mean there is €5.00 + €2.30 left to pay.

DetailAmountTaxTotal
Charge10.002.3012.30
Discount-5.00
Total7.30

Note that tax is calculated on the full amount so in the example above tax of 2.30 is due to the tax authority.

See Discounts.

Vouchers

This also covers gift cards and coupons which may be treated differently.

A key consideration is whether tax was paid when purchasing the voucher itself.

For example, a €5.00 voucher might cost €6.15 including tax.

In this case, VAT has already been paid on that amount so the amount must come off the net invoice amount.

Applying the voucher to an invoice for €10.00 would result in €5.00 + €1.15 VAT:

AmountTaxTotal
Charge10.002.3012.30
Voucher-5.00-1.15-6.15
Total5.001.156.15

Modelling Vouchers

You use the fields outlined in the following table to model vouchers.

FieldDescription
voucher_typeSpecify cash-equivalent to ensure the value is deducted from the total.
voucher_amountThe total value of the voucher.
voucher_descriptionA description.
voucher_applied_amountA voucher amount that has been applied. It may not been fully applied if its amount was higher than the total transaction amount.
voucher_remaining_amountA voucher amount that has not been applied. Voucher may not been fully applied if its amount was higher than the total transaction amount.

See Voucher Object Fields.

For example:

{
		"voucher_type":"cash-equivalent"
		"voucher_code":"ABC_1234"
		"voucher_description":"Example 1"
		"voucher_amount":50
		"voucher_applied_amount":1
		"voucher_remaining_amount":0
	}
]