Newer Version Available

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

TransactionJournal

Represents information about loyalty transactions that track activities, member behavior, and adjustments. This object is available in API version 51.0 and later.

Supported Calls

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

Fields

Field Details
ActivityDate
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date of transaction.
BookedFareClass
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The class of ticket service that the member booked.
BookedRoomType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The type of room the member booked.
BookingDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date of the member booked a reservation or purchased goods or services.
Brand
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The hotel chain where the member stayed or the brand of the purchased or rented goods or services.
Channel
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The channel the member used for transactions.
Destination
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ending location for a member's trip or the place where an order shipped to.
Distance
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The miles or kilometers traveled by a member or an order's shipping distance.
EndDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The end date associated with the transaction.
ErrorDescription
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The description of the error.
Establishment
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unique identifier for the location where the member stayed or purchased goods or services.
ExternalTransactionNumber
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
The transaction number from the external systems.
FlightNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The airline flight number the member booked.
Industry
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the type of the industry.
InvoiceDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date the invoice was generated.
JournalDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date of the journal.
JournalReason
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the reason for the action that created a transaction journal.
Possible values are:
  • Accrual Cancelation Requested by Member
  • Order Canceled
  • Product Returned
  • Product or Service Unavailable
  • Redemption Cancelation Requested by Member
  • Resolve Disputed Points
  • Service Recovery
JournalSubTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The subtype of journal transaction.
JournalTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The type of journal transaction.
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.
LoyaltyProgramId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The loyalty program associated with the transaction.
MemberId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The member associated with the transaction.
OrderId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The order associated with the transaction.
OrderItemId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The order items associated with the transaction.
Origin
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The starting location for a member's trip or the place where an order shipped from.
PartnerId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Participating partners where members can add or redeem points.
PaymentMethod
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The member's payment method.
ProductCategoryId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The category of the product associated with the transaction.
ProductId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The product associated with the transaction.
Quantity
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The length of the booked stay or the order quantity.
QuantityUnitOfMeasureId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unit of measure for the booked stay or the order quantity.
ReferredMemberId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the person the member referred.
RelatedCorporateMembershipId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The corporate membership associated with the transaction.
RelatedJournalId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The related journal entry associated with this transaction.
StartDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The start date associated with the transaction.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
The status of the transaction.
Possible values are:
  • Cancelled
  • Error
  • Pending
  • Processed
TransactionAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
For reservations, the total fees or prepaid balance. For goods and services, the total purchase price.
TransactionLocation
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The location where the loyalty member purchased goods or services.
TraveledFareClass
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The class of ticket service that the member traveled.
UsageType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of usage.
Possible values are:
  • Loyalty
  • Rebates
VoucherCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The voucher identifier generated by an external system.