OrderPaymentSummaryReference

OrderPaymentSummaryReference is a junction object that allows an order payment summary to be shared with another order summary.

An order summary can share an order payment summary with any of its child order summaries (exchange order summaries). Each child can share the order payment summary with its children, and so on. Conceptually, the original order summary and its children form a tree structure, with the original order summary as the root node. If a new order payment summary is created for an exchange order summary anywhere in the tree, the new order payment summary can only be shared with that exchange order summary’s children (and their descendents), if any.

The purpose of the OrderPaymentSummaryReference object is to establish how order summaries share order payment summaries. This is only possible if the relationship between the two order summaries has already been established. A corresponding OrderSummaryRelationship record must already exist that relates a parent order summary (MainOrderSummary) with its child (AssociateOrderSummary). The record’s AssociatedRelationshipType field must be set to Exchange.

Introduced in API version 60.0.

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

• This object is only available in Salesforce Order Management orgs or if the B2B Commerce or D2C Commerce license is enabled.

• Type: currency
• Properties: Filter, Nillable, Sort
• Description: Amount of the OrderPaymentSummary that has been authorized.

• Type: currency
• Properties: Filter, Nillable, Sort
• Description: Amount of the OrderPaymentSummary that has been captured.

• Type: string
• Properties: Create, Filter, Group, idLookup, Sort, Update
• Description: Name of the OrderPaymentSummary.

• Type: reference

• Properties: Create, Filter, Group, Sort

• Description:

  ID of the OrderPaymentSummary shared with the OrderSummary (exchange order).

  This field is a relationship field.

• Relationship name: OrderPaymentSummary

• Relationship type: masterdetail

• Refers to: OrderPaymentSummary

• Type: reference

• Properties: Create, Filter, Group, Sort

• Description:

  ID of the OrderSummary (exchange order) that the OrderPaymentSummary is shared with.

  This field is a relationship field.

• Relationship name: OrderSummary

• Relationship type: masterdetail

• Refers to: OrderSummary

• Type: currency
• Properties: Filter, Nillable, Sort
• Description: Amount of the OrderPaymentSummary that was refunded.

• Type: currency
• Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
• Introduced: API version 60.0
• Description: Reserved balance amount for the exchange order for the order payment summary relationship.

• Type: picklist
• Properties: Create, Filter, Group, Restricted picklist, Sort, Update
• Description: Type of reference between the OrderSummary and the OrderPaymentSummary.
• Possible values:
  • Shared — Shared