LoyaltyAggrPointExprLedger

Represents information about non-qualifying currency points that expire based on a fixed model tier group. This object is available in API version 54.0 and later.

Supported Calls 

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

LoyaltyAggrPointExprLedger isn’t available in the Object Manager and can’t be customized.

Fields 

ExpirationDate 

Type: date

Properties: Create, Filter, Group, Sort, Update

Description: Required. The date on which the points are set to expire.

ExpirationPoints 

Type: double

Properties: Create, Filter, Sort, Update

Description: Required. The number of points that are set to expire on the expiration date.

HasMixedExprModelSubcurrencies 

Type: boolean

Properties: Defaulted on create, Filter, Group, Sort

Description: Indicates whether LoyaltyPgmCrcySubtypeId belongs to a parent currency that uses the Activity With Mixed Subcurrencies expiration model (true) or not (false). This field is derived from the currency in the LoyaltyProgramCurrencyId field.

Available in API version 68.0 and later.

LoyaltyPgmCrcySubtypeId 

Type: reference

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

Description: The loyalty program currency subtype of the expired points. Available in API version 68.0 and later.

This field is a relationship field.

Relationship Name: LoyaltyPgmCrcySubtype

Refers To: LoyaltyPgmCurrencySubtype

LoyaltyProgramCurrencyId 

Type: reference

Properties: Create, Filter, Group, Sort, Update

Description: Required. The loyalty program currency for which points are set to expire.

This is a relationship field.

Relationship Name: LoyaltyProgramCurrency

Relationship Type: Lookup

Refers To: LoyaltyProgramCurrency

LoyaltyProgramMemberId 

Type: reference

Properties: Create, Filter, Group, Sort, Update

Description: Required. The loyalty program member whose points are set to expire.

This is a relationship field.

Relationship Name: LoyaltyProgramMember

Relationship Type: Lookup

Refers To: LoyaltyProgramMember

PointsStatus 

Type: picklist

Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: The status of the points that are set to expire.

Possible values are:

  • Active
  • Inactive

The default value is ‘Active’.

RedeemedPoints 

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The number of points that have been redeemed by the associated loyalty program member out of the total points set to expire.

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.

LoyaltyAggrPointExprLedgerChangeEvent: Change events are available for the object.