Newer Version Available

This content describes an older version of this product. View Latest

LoyaltyProgramCurrency

Represents qualifying and non-qualifying currencies associated with the program. Qualifying currency represents the engagement of a member with the program and it’s associated with a tier group. Non-qualifying currency represent the points that the member earns for redemption. 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
CostperUnit
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The cost for each currency associated with a loyalty program.
CurrencyType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
Type of the loyalty program currency.
Possible values are:
  • NonQualifying
  • Qualifying
ExpiryModel
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The model evaluates the type of expiration of points based on the fixed date or customer’s activity.
Possible values are:
  • Activity
  • Fixed
ExpiryPeriodFrequency
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The frequency type to evaluate the expiration of currency.
ExpiryPeriodUnit
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Unit of the period in which currency expiration is done.
Possible values are:
  • Days
  • Months
  • Years
ExtendExpiration
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The field decides if the expiration date is changed on the exact day or the last day of the month.
Possible values are:
  • None
  • TillEndOfMonth
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the loyalty program currency is active.
IsPrimary
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the loyalty program currency is primary.
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, Sort
Description
Id of the loyalty program.
LoyaltyTierGroupId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the loyalty tier group.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the loyalty program currency.