Voucher Object Fields

Use this entity to specify the details of any vouchers.

FieldDetailDescription
voucher_type

Type: String

Type of the voucher. This field is mandatory.
voucher_code

Type: String

Max: 256

Voucher code. If present, it is displayed on the invoice.
voucher_description

Type: String

Max: 256

A custom voucher description. It is not displayed on the invoice.
voucher_amount

Type: Number

The voucher amount can be greater than the transaction total amount. This field is mandatory.

If this is the case, the total_billable_amount is 0 and the voucher_applied_amount and voucher_remaining_amount fields will indicate how much of the voucher has been spent and remains.