VoucherDefinition

Represents information about the voucher template. A voucher definition is used to issue vouchers to advocates and their referred friends. This object is available in API version 59.0 and later.

Supported Calls

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

Fields

Field	Details
AutogeneratedCodeLength	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The length of the autogenerated code of vouchers issued using the voucher definition. If no value is specified, the default length is eight digits.
CodePrefix	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The prefix of the autogenerated code of vouchers issued using the voucher definition.
CodeSuffix	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The suffix of the autogenerated code of vouchers issued using the voucher definition.
CostPerVoucher	Type currency Properties Create, Filter, Nillable, Sort, Update Description The liability that the company incurs for each voucher issued using the voucher definition.
Description	Type textarea Properties Create, Filter, Nillable, Sort, Update Description The description or the business use of the voucher definition.
DiscountPercent	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The percentage of discount that vouchers issued using the voucher definition provide the advocates and their referred friends.
EffectiveDate	Type date Properties Create, Filter, Group, Sort, Update Description Required. The date from which advocates or their referred friends can redeem vouchers issued using the definition.
ExpirationDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date until which advocates or their referred friends can redeem vouchers issued using the definition.
ExpirationPeriod	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of days or months that vouchers issued using the voucher definition are valid since the date it’s issued.
ExpirationPeriodUnit	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether the expiration period of vouchers issued using the voucher definition is in days or months. Possible values are: `Days` `Months`
ExpirationType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. Specifies whether vouchers issued using the voucher definition are valid until the expiration date or are valid for a specific period. Possible values are: `FixedDate`—Fixed Date `Period`
FaceValue	Type currency Properties Create, Filter, Nillable, Sort, Update Description The discount amount that advocates and their referred friends get when they redeem vouchers issued using the voucher definition.
ImageUrl	Type url Properties Create, Filter, Nillable, Sort, Update Description The URL of the file that contains the marketing image of the voucher definition.
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. Indicates whether the voucher definition is active (`true`) or not (`false`). You can only issue vouchers using active voucher definitions. The default value is `false`.
IsPartialRedeemable	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether advocates and referrals can redeem the complete value of a voucher issued using the voucher definition across multiple transactions. You can only specify `true` for voucher definition of the type FixedValue. The default value is `false`.
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.
LoyaltyProgramId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the referral program that the voucher belongs to. This field is a relationship field. Relationship Name LoyaltyProgram Relationship Type Lookup Refers To LoyaltyProgram
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the voucher definition. The name can’t contain special characters.
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
PartnerAccountId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use. This field is a relationship field. Relationship Name PartnerAccount Relationship Type Lookup Refers To Account
ProductDerivedFieldId	Type reference Properties Filter, Group, Nillable, Sort Description The ID of the product associated with the voucher definition. This field is a relationship field. Relationship Name ProductDerivedField Relationship Type Lookup Refers To Product2
ProductId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the product that advocates and their referred friends can purchase by redeeming vouchers issued using the definition. If the voucher definition is of the type ProductOrService, specify the ID of the product that advocates or referrals get when they redeem the voucher. This field is a polymorphic relationship field. Relationship Name Product Relationship Type Lookup Refers To Product2
Type	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Required. Specifies the type of reward that advocates or their referred friends get when they redeem vouchers issued using the voucher definition. Possible values are: `DiscountPercentage`—Discount Percentage `FixedValue`—Fixed Value `ProductOrService`—Product or Service

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.

VoucherDefinitionHistory: History is available for tracked fields of the object.
VoucherDefinitionShare: Sharing is available for the object.

Referral Marketing Developer Guide

VoucherDefinition

Supported Calls

Fields

Associated Objects