Newer Version Available

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

LoyaltyLedger

Records the points that have been credited or debited for a member across the transactions. This object is available in API version 51.0 and later.

Supported Calls

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

Fields

Field Details
ActivityDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date on which the transaction was performed by the loyalty program member.
AdditionalNotes
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The notes about the transactions performed by the loyalty program members.
Correlation
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of any Salesforce object.
EscrowPointsCreditDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date on which the escrow points are credited to the points balance for the loyalty ledger. This field is available in API version 53.0 and later.
EventType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The type of the loyalty transaction.
Possible values are:
  • Credit
  • Debit
  • Expiry
  • Transfer
The default value is 'Credit'.
ExpiryDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date on which the transaction expires.
Flow
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the flow.
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.
LoyaltyProgramCurrencyId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the loyalty program currency.
This is a relationship field.
Relationship Name
LoyaltyProgramCurrency
Relationship Type
Lookup
Refers To
LoyaltyProgramCurrency
LoyaltyProgramMemberId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the loyalty program member.
This is a relationship field.
Relationship Name
LoyaltyProgramMember
Relationship Type
Lookup
Refers To
LoyaltyProgramMember
Points
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The points available for the loyalty program member.
PromotionId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The promotion that's applied to the associated transaction resulting in the credit or debit of points. This field is available in API version 52.0 and later
This is a relationship field.
Relationship Name
Promotion
Relationship Type
Lookup
Refers To
Promotion
TransactionJournalId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the transaction journal.
This is a relationship field.
Relationship Name
TransactionJournal
Relationship Type
Lookup
Refers To
TransactionJournal

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.

LoyaltyLedgerChangeEvent (API version 51.0)
Change events are available for the object.