TransactionJournal Represents information about customer or loyalty program member transactions that track activities, engagements, and adjustments. This object is available in API version 51.0 and later.
You can add up to 50 custom fields in the TransactionJournal object.
Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields
ActivityDate
Type: dateTime
Properties: Create, Filter, Sort, Update
Description: Required. The date of the transaction.
BookedFareClass
Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The class of ticket service booked.
BookedRoomType
Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The type of room booked.
BookingDate
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The booking date of a reservation or purchase.
Brand
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The brand of the purchase.
Channel
Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The channel used for transactions.
CouponId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The coupon that’s applied as a part of a promotion to provide discounts on the transaction. This field is available in API version 66.0 and later.
This field is a relationship field.
Relationship Name: Coupon
Refers To: Coupon
CreationSourceType
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies how the transaction journal was created.
Valid value is:
Import—Indicates the transaction journal was imported.
This field is available in API version 67.0 and later.
CurrencyIsoCode
Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description: The three-letter ISO 4217 currency code of the monetary currency in which the transaction took place.
Possible values are:
The default value is USD.
Destination
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ending location for a trip or the place where an order shipped to.
Distance
Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The miles or kilometers traveled or an order’s shipping distance.
EndDate
Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The end date of the transaction.
EngagementChannelTypeId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the engagement channel used for the purchase. This field is available in API version 61.0 and later.
This field is a relationship field.
Relationship Name: EngagementChannelType
Relationship Type: Lookup
Refers To: EngagementChannelType
ErrorDescription
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The description of the error.
EscrowPointsCreditDate
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date on which the escrow points are credited to the associated loyalty program member’s point balance. This field is available in API version 53.0 and later.
Establishment
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unique identifier for the purchase.
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 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.
IsParentTransaction
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the transaction journal represents the primary activity within a group of activities. This field is available in API version 60.0 and later.
The default value is false.
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. This field can store up to 999 values. After the field reaches 999 values, rename existing values that you no longer use instead of deleting values and adding new ones.
Possible values are:
Accrual Cancelation Requested by MemberOrder CanceledProduct ReturnedProduct or Service UnavailableRedemption Cancelation Requested by MemberResolve Disputed PointsService Recovery
JournalSubTypeId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The subtype of journal transaction.
This is a relationship field.
Relationship Name: JournalSubType
Relationship Type: Lookup
Refers To: JournalSubType
JournalTypeId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The type of journal transaction.
This is a relationship field.
Relationship Name: JournalType
Relationship Type: Lookup
Refers To: JournalType
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.
This is a relationship field.
Relationship Name: LoyaltyProgram
Relationship Type: Lookup
Refers To: LoyaltyProgram
MemberId
Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The member associated with the transaction.
This field is a polymorphic relationship field.
Relationship Name: Member
Relationship Type: Lookup
Refers To: LoyaltyProgramMember
Name
Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: The autogenerated number of the transaction journal.
OfferId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The offer that’s used to provide promotional discount on the transaction. This field is available in API version 66.0 and later
This field is a relationship field.
Relationship Name: Offer
Refers To: Offer
OrderId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The order associated with the transaction.
This is a relationship field.
Relationship Name: Order
Relationship Type: Lookup
Refers To: Order
OrderItemId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The order items associated with the transaction.
This is a relationship field.
Relationship Name: OrderItem
Relationship Type: Lookup
Refers To: OrderItem
Origin
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The starting location for a trip or the place where an order is shipped from.
PartnerId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Participating partners where loyalty program members can add or redeem points.
This is a relationship field.
Relationship Name: Partner
Relationship Type: Lookup
Refers To: LoyaltyProgramPartner
PaymentMethod
Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The payment method of the purchase.
ProductCategoryId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The category of the product associated with the transaction.
This is a relationship field.
Relationship Name: ProductCategory
Relationship Type: Lookup
Refers To: ProductCategory
ProductId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The product associated with the transaction.
This is a relationship field.
Relationship Name: Product
Relationship Type: Lookup
Refers To: Product2
PromotionId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The promotion associated with the transaction journal. 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
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.
This is a relationship field.
Relationship Name: QuantityUnitOfMeasure
Relationship Type: Lookup
Refers To: UnitOfMeasure
RedeemedPointsExpirationInformation
Type: textarea
Properties: Create, Nillable, Update
Description: The details of the fixed type non-qualifying points that are redeemed in a transaction journal and their corresponding expiration dates. This field is available in API version 55.0 and later.RedeemedPointsExpirationInformation isn’t able in the Object Manager and can’t be customized.
ReferredMemberId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The name of the person the loyalty program member referred.
This is a relationship field.
Relationship Name: ReferredMember
Relationship Type: Lookup
Refers To: LoyaltyProgramMember
ReferredPartyId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the contact or account associated with the transaction journal. The contact ID belongs to the person whose activity the transaction journal represents. This field is available in API version 60.0 and later.
Relationship Name: ReferredParty
Relationship Type: Lookup
Refers To: Account, Contact
RelatedCorporateMembershipId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The corporate membership associated with the transaction.
This is a relationship field.
Relationship Name: RelatedCorporateMembership
Relationship Type: Lookup
Refers To: LoyaltyProgramMember
RelatedJournalId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The related journal entry associated with this transaction.
This is a relationship field.
Relationship Name: RelatedJournal
Relationship Type: Lookup
Refers To: TransactionJournal
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: Required. The status of the transaction.
Possible values are:
CancelledErrorPendingProcessed
TotalPromotionDiscount
Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The total discount provided by the associated promotion for the activity that the transaction journal represents. This field is available in API version 61.0 and later.
TransactionAmount
Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: For reservations, the total fees or prepaid balance. For purchases, the total purchase price.
TransactionLocation
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The location of the purchase.
TransactionSourceLocationId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the retail store where the activity that the transaction journal represents has taken place. This field is available in API version 60.0 and later.
This field is a relationship field.
Relationship Name: TransactionSourceLocation
Relationship Type: Lookup
Refers To: RetailStore
TraveledFareClass
Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The class of ticket.
Unique Identifier
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unique identifier of the transaction journal.
UsageType
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort
Description: The type of usage.
Possible values are:
LoyaltyRebatesUnifiedPromotions—This value is available in API version 60.0 and later.
VoucherCode
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The voucher code generated by an external system.
Usage
You can query Transaction Journal records in your org by using a combination of these indexed fields:
ActivityDate
ExternalTransactionNumber
ID
JournalTypeId
LoyaltyProgramId
MemberId
OrderId
RelatedJournalId
UsageType
The TransactionJournal object in most orgs can store millions of records. A limited set of TransactionJournal fields are indexed to help optimize operations on the TransactionJournal object.
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.
TransactionJournalChangeEvent (API Version 63.0):
j