Voucher

Represents the details of a voucher that’s issued to an advocate or to a referred friend. This object is available in API version 59.0 and later.

Referral Marketing automatically issues vouchers to advocates when their referrals sign up and issues vouchers to referrals when they complete their first purchase.

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 business account associated with the advocate or referred party who is issued the voucher for a B2B referral program. This field is a relationship field. Relationship Name Account Refers To Account
ContactId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the contact associated with the advocate or referred friend who is issued the voucher for a B2C referral program. This field 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 percentage of the discount that the voucher offers to the referred party it is issued to.
EffectiveDate	Type date Properties Create, Filter, Group, Sort, Update Description Required. The date from which the referred party can redeem the voucher.
ExpirationDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date on which the voucher expires and is no longer available for redemption.
FaceValue	Type currency Properties Create, Filter, Nillable, Sort, Update Description The discount amount that the voucher offers to the referred party it is issued to.
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 ID of the loyalty program member associated with the advocate who is issued the voucher. This field 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 unique number of the issued voucher.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the record. This field 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 ID of the referral promotion that issued to voucher. This field 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 value that the advocate or referred party has already redeemed from the voucher. This field is only valid for vouchers that are issued using a FixedValue type voucher definition.
RemainingValue	Type currency Properties Filter, Nillable, Sort Description The value that the advocate or referred party is yet to redeem from the voucher. This field is only valid for vouchers that are issued using a FixedValue type voucher definition.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Required. Specifies the status of the voucher. Possible values are: `Cancelled` `Expired` `Issued` `Redeemed` The default value is `Issued`.
TransactionJournalId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the transaction journal that represents the advocate or referred party event for which the voucher was issued. This field 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 on which the advocate or the referred party used the voucher.
VoucherCode	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique code of the voucher.
VoucherDefinitionId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the voucher definition that was used to issue the voucher. This field 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.

VoucherHistory: History is available for tracked fields of the object.
VoucherOwnerSharingRule: Sharing rules are available for the object.
VoucherShare: Sharing is available for the object.

Referral Marketing Developer Guide

Voucher

Supported Calls

Fields

Associated Objects