Voucher

Represents details about a voucher that's issued to a loyalty program member. This object is available in API version 51.0 and later.

Supported Calls

delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update()

Fields

Field	Details
BenefitId	Type reference Properties Filter, Group, Nillable, Sort Description The benefit associated with the voucher.
ContactId	Type reference Properties Filter, Group, Nillable, Sort Description The contact associated with the member.
DiscountPercent	Type int Properties Filter, Group, Nillable, Sort Description The discount percentage associated with the voucher.
EffectiveDate	Type date Properties Filter, Group, Sort Description Required. The date the voucher goes into effect.
ExpirationDate	Type date Properties Filter, Group, Nillable, Sort Description The date the voucher expires.
FaceValue	Type currency Properties Filter, Nillable, Sort Description The value of the voucher.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user referenced this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user viewed this record.
LoyaltyProgramMemberId	Type reference Properties Filter, Group, Nillable, Sort Description The member who has been issued the voucher.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the voucher.
PromotionId	Type reference Properties Filter, Group, Nillable, Sort Description The promotion associated with the voucher.
Reason	Type string Properties Filter, Group, Nillable, Sort Description The reason why the voucher was issued.
Status	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Required. The status of the voucher. Possible values are: `Cancelled` `Expired` `Issued` `Redeemed`
TransactionJournalId	Type reference Properties Filter, Group, Nillable, Sort Description The transaction journal associated with the member voucher when the voucher results from accrual of points.
UseDate	Type date Properties Filter, Group, Nillable, Sort Description The date the voucher was used.
VoucherCode	Type string Properties Filter, Group, Nillable, Sort Description The voucher identifier generated by an external system.
VoucherDefinitionId	Type reference Properties Filter, Group, Sort Description The loyalty voucher definition associated with the voucher.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

VoucherFeed (API version 52.0): Feed tracking is available for the object.
VoucherHistory (API version 52.0): History is available for tracked fields of the object.
VoucherShare (API version 52.0): Sharing is available for the object.
VoucherOwnerSharingRule (API version 52.0): Sharing rules are available for the object.

Loyalty Management Developer Guide

Voucher

Supported Calls

Fields

Associated Objects