Newer Version Available

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

LoyaltyPgmPtnrLdgrSummary

Represents the aggregated ledger used by a loyalty program to credit points to or debit points from a prepaid partner's points pack. This ledger can also be used to add or deduct the monetary value of points from the postpaid partner's bill. This object is available in API version 55.0 and later.

Supported Calls

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

Fields

Field Details
ActivityDate
Type
date
Properties
Create, Filter, Group, Sort, Update
Description
Required. The date on which points that are part of the associated loyalty program partner prepaid pack are debited or credited. For postpaid billing, it is the date when the postpaid amount of the loyalty program partner is debited or credited.
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.
LoyaltyPgmPtnrPrepaidPackId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The loyalty program partner prepaid pack associated with the loyalty program partner ledger.
This is a relationship field.
Relationship Name
LoyaltyPgmPtnrPrepaidPack
Relationship Type
Lookup
Refers To
LoyaltyPgmPtnrPrepaidPack
LoyaltyProgramPartnerId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The loyalty program partner associated with the loyalty program.
This is a relationship field.
Relationship Name
LoyaltyProgramPartner
Relationship Type
Lookup
Refers To
LoyaltyProgramPartner
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the loyalty program partner ledger summary.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. Specifies the status of the loyalty program partner ledger.
Possible values are:
  • Pending

    Partner doesn't have the adequate balance and hence the ledger is pending to be processed.

  • Processed

    Partner's ledger is processed.

The default value is Pending.
TotalPoints
Type
double
Properties
Create, Filter, Sort, Update
Description
Required. The number of points debited from or credited to the associated loyalty program partner's prepaid pack or postpaid bill amount.
Type
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. Specifies the type of the loyalty program partner ledger.
Possible values are:
  • Credit
  • CreditCancellation—Credit Cancellation
  • Debit
  • DebitCancellation—Debit Cancellation
The default value is Credit.