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

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: Required. Type of the loyalty program currency.

Possible values are:

NonQualifying
Qualifying

DoesAllowLedgerTracing

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Indicates whether points credited by accrual transactions and debited by redemption transactions for a fixed-model non-qualifying currency is traced (true) or not (false). This field is available in API version 61.0 and later.

The default value is false.

DoesAllowNegativeBalance

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Indicates whether a non-qualifying currency allows members to hold a negative point balance. This field is available in API version 61.0 and later.

The default value is false.

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

HasEscrow

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Indicates whether points can be escrowed for the loyalty program currency. This field is available in API version 53.0 and later.

The default value is false.

IsActive

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Required. 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: The ID of the loyalty program.

This is a relationship field.

Relationship Name: LoyaltyProgram

Relationship Type: Master-detail

Refers To: LoyaltyProgram

LoyaltyTierGroupId

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The ID of the loyalty tier group.

This is a relationship field.

Relationship Name: LoyaltyTierGroup

Relationship Type: Lookup

Refers To: LoyaltyTierGroup

Name

Type: string

Properties: Create, Filter, Group, idLookup, Sort, Update

Description: The name of the loyalty program currency.

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.

LoyaltyProgramCurrencyChangeEvent (API Version 62.0): Change events are available for the object.