Issue Voucher Action
Issue a voucher for a member or contact.
This action is available in API version 51.0 and later for users with Loyalty Management license.
URI: /services/data/vXX.X/actions/standard/issueVoucher
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token
| Input | Type | Description |
|---|---|---|
AdditionalNotes | string | Additional details related to the action, such as the reason for issuing the voucher. |
AccountId | string | The ID of the account that’s used to issue the voucher. ProvideAccountId only when you issue vouchers to a Business Account. If both AccountId and ContactId are provided, then an error is displayed. |
BenefitId | ID | The benefit associated with the voucher. |
ContactId | ID | The contact associated with the member. Provide ContactId only when you issue vouchers to a Person Account. If both AccountId and ContactId are provided, then an error is displayed. |
DiscountPercent | percent | The discount percentage provided by the voucher. Specify a value to override the discount percentage specified in the associated voucher definition. Specify this when the associated voucher definition is of the type Discount Percentage. This field is available in API version 53.0 and later. |
FaceValue | double | The amount of discount provided by the voucher. Specify a value to override the face value specified in the associated voucher definition. Specify this when the associated voucher definition is of the type Fixed Value. This field is available in API version 53.0 and later. |
EffectiveDate | Date | The date the voucher goes into effect. |
ExpiryDate | Date | The date the voucher expires. |
JournalId | ID | The transaction journal associated with the member voucher when the voucher results from accrual of points. |
LoyaltyProgramMemberId | ID | ID of the loyalty program member to issue the voucher. |
PromotionId | ID | The promotion associated with the voucher. |
ProgramName | string | The name of the loyalty program associated with this voucher. |
VoucherCode | string | Required. The voucher identifier generated by an external system. |
VoucherDefinitionName | string | Required. The name of the voucher definition associated with the voucher code. |
| Output | Type | Description |
|---|---|---|
VoucherId | ID | The ID of the voucher that’s generated after the request is successful. |
Sample Request
Sample request to issue vouchers to a Person Account.
Sample request to issue vouchers to a Business Account.
Sample Response
Sample request for the Issue Voucher action.