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

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

Fields

Field	Details
AccountId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the account to which the voucher is issued. This field is available in API version 62.0 and later. If you want to issue vouchers to accounts, set up a custom process based on the requirements of your company. This field is a relationship field. Relationship Name Account Refers To Account
BenefitId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The benefit associated with the voucher. This is a relationship field. Relationship Name Benefit Relationship Type Lookup Refers To Benefit
ContactId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The contact associated with the member. This is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact
DiscountPercent	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The discount percentage associated with the voucher.
EffectiveDate	Type date Properties Create, Filter, Group, Sort, Update Description Required. The date the voucher goes into effect.
EffectiveDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time from when the voucher is available for redemption. This field is available in API version 62.0 and later.
ExpirationDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the voucher expires.
ExpirationDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the voucher expires and is no longer available for redemption. This field is available in API version 62.0 and later.
FaceValue	Type currency Properties Create, Filter, Nillable, Sort, Update 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 Create, Filter, Group, Nillable, Sort Description The member who has been issued the voucher. This is a relationship field. Relationship Name LoyaltyProgramMember Relationship Type Lookup Refers To LoyaltyProgramMember
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The autogenerated number of the voucher.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns this record. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
PromotionId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The promotion associated with the voucher. This is a relationship field. Relationship Name Promotion Relationship Type Lookup Refers To Promotion
Reason	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The reason why the voucher was issued.
RedeemedValue	Type currency Properties Create, Filter, Nillable, Sort, Update Description The voucher balance that was redeemed. This field is available in API version 53.0 and later.
RemainingValue	Type currency Properties Filter, Nillable, Sort Description The remaining value of the voucher after partial redemption. This field is available in API version 53.0 and later.
ReservationKey	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The key that's used to redeem a reserved voucher. This field is available in API version 62.0 and later.
ReservedDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the voucher is reserved for redemption. This field is available in API version 62.0 and later.
ReservedValue	Type currency Properties Create, Filter, Nillable, Sort, Update Description The value of the voucher reserved by the customer. This field is available in API version 62.0 and later.
Status	Type picklist Properties Create, 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 Create, Filter, Group, Nillable, Sort, Update Description The transaction journal associated with the member voucher when the voucher results from accrual of points. This is a relationship field. Relationship Name TransactionJournal Relationship Type Lookup Refers To TransactionJournal
UseDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the voucher was used.
VoucherCode	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The voucher identifier generated by an external system.
VoucherDefinitionId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The loyalty voucher definition associated with the voucher. This is a relationship field. Relationship Name VoucherDefinition Relationship Type Lookup Refers To VoucherDefinition

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.

VoucherChangeEvent (API Version 63.0): Change events are 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.

Loyalty Management Developer Guide

Voucher

Supported Calls

Fields

Associated Objects