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(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete()
Fields
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 or external record.The field lets you store IDs that are up to 15 characters. If you store IDs that are fewer than 15 characters and use the field to query the object, add spaces after your query term to ensure that the query term is 15 characters.
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.
LoyaltyPgmCrcySubtypeId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Loyalty program currency subtype associated with the loyalty ledger. This field is available in API version 61.0 and later.
This field is a relationship field.
Relationship Name: LoyaltyPgmCrcySubtype
Relationship Type: Lookup
Refers To: LoyaltyPgmCurrencySubtype
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
Name
Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: The name of the loyalty ledger.
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
SourceIdentifier
Type: string
Properties: Create, Filter, Group, idLookup, Nillable, Sort
Description: The identifier assigned by the originating process or external system. It’s used to correlate related records or track imported data.
This field is available in API version 68.0 and later.
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