Newer Version Available

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

ExtendedReward

Represents the instance of an extended reward that's issued to a customer, a partner, or a member. This object is available in API version 64.0 and later.

Supported Calls

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

Fields

Field Details
AccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the account to which the reward is issued.
This field is a relationship field.
Relationship Name
Account
Refers To
Account
AdditionalNotes
Type
string
Properties
Create, Filter, Nillable, Sort, Update
Description
The reason why the reward was issued.
ContactId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the contact associated with the member.
This field is a relationship field.
Relationship Name
Contact
Refers To
Contact
EffectiveDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time from when the reward is available for redemption.
ExpirationDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the reward expires and is no longer available for redemption.
ExtendedRewardDefinitionId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the reward definition associated with the reward.
This field is a relationship field.
Relationship Name
ExtendedRewardDefinition
Refers To
ExtendedRewardDefinition
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.
LoyaltyProgramMemberId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
The ID of the loyalty program member who has been issued the reward.
This field is a relationship field.
Relationship Name
LoyaltyProgramMember
Refers To
LoyaltyProgramMember
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the reward.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the owner of the extended reward.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
PromotionId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the promotion to which the reward is issued.
This field is a relationship field.
Relationship Name
Promotion
Refers To
Promotion
ReferralId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of referral record created during the rewarding stage.
This field is a relationship field.
Relationship Name
Referral
Refers To
Referral
RewardNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The unique autogenerated number of the extended reward.
RewardRecipientId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The ID of the recipient of the reward.
This field is a polymorphic relationship field.
Relationship Name
RewardRecipient
Refers To
Account, Contact, LoyaltyProgramMember
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Status the reward is in.
Possible values are:
  • Cancelled—Canceled
  • Issued
  • Pending
  • Redeemed
The default value is Issued.
TransactionJournalId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the transaction journal associated with the member reward.
This field is a relationship field.
Relationship Name
TransactionJournal
Refers To
TransactionJournal
Value
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The value of the reward.

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.

ExtendedRewardChangeEvent
Change events are available for the object.