VoucherDefinition

Represents details about a voucher definition that’s associated with a loyalty program. 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
Description	Type textarea Properties Create, Filter, Nillable, Sort, Update Description The description of the voucher.
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 The date on which the voucher becomes valid.
ExpirationDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the voucher expires. The expiration date is only valid for the fixed date model.
ExpirationPeriod	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of days or months in the expiration period.
ExpirationPeriodUnit	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unit for the expiration period. Possible values are: `Days` `Months`
ExpirationType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of expiration for the voucher. Possible values are: `FixedDate`—Fixed Date `Period`
FaceValue	Type currency Properties Create, Filter, Nillable, Sort, Update Description The value of the voucher.
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the voucher is active
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 loyalty program.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name 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.
PartnerAccountId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The partner associated with the voucher.
ProductCategoryDerivedFieldId	Type reference Properties Filter, Group, Nillable, Sort Description A look up to show product category in voucher definition.
ProductDerivedFieldId	Type reference Properties Filter, Group, Nillable, Sort Description A look up to show product in voucher definition.
ProductId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The product associated with the voucher.
Type	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of voucher. Possible values are: `DiscountPercentage`—Discount Percentage `FixedValue`—Fixed Value `ProductOrService`—Product or Service

Loyalty Management Developer Guide

VoucherDefinition

Supported Calls

Fields