Voucher Object Fields
Learn about the fields used to model vouchers.
These field references describe the fields in a voucher object. Specify the voucher in the transaction object. A transaction object only supports one voucher.
Field
The following fields are available:
| Field | Description |
|---|---|
voucher_type | The voucher type. This field is required and must be cash-equivalent. |
voucher_code | The voucher code. If specified, the service displays it on the invoice. |
voucher_description | The custom description for the voucher. The service does not display the description on the invoice. |
voucher_amount | The voucher amount. This field is required and can exceed the transaction total. If it does, total_billable_amount is 0, and voucher_applied_amount and voucher_remaining_amount indicate how much of the voucher was used and how much remains. |
Considerations
Note the following considerations:
- A voucher object is only supported at the transaction level.
- A transaction object only supports one voucher.
Updated 14 days ago
Did this page help you?