Newer Version Available

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

OSAsyncChgCompletedEvent

An event that allows the processing of the credit memo, invoices, and other entities after a bulk action has successfully completed. The event provides all of the values that would exist on the synchronous APIs. This object is available in API version 63.0 and later.

Supported Calls

create(), describeSObjects()

Special Access Rules

This object is only available in Salesforce Order Management orgs.

Fields

Field Details
ActionType
Type
string
Properties
Create, Nillable
Description
The type of the action that gets applied to Order Summary
Possible values are:
  • CANCEL_ALL
  • RETURN_ALL
AsyncOperationLogId
Type
reference
Properties
Create, Nillable
Description
The ID of the AsyncOperationLog.
This field is a relationship field.
Relationship Name
AsyncOperationLog
Refers To
AsyncOperationLog
CurrencyIsoCode
Type
string
Properties
Create, Nillable
Description
The ISO code for the currency of the OrderSummary that's associated with the FulfillmentOrder. This field is available only for orgs with multicurrencies enabled.
Possible values are:
  • CNY—Chinese Yuan
  • GBP—British Pound
  • USD—U.S. Dollar
The default value is USD.
EventUuid
Type
string
Properties
Nillable
Description
Uniquely identifies an event message. The ID used to match the events that are returned in the callback result with the events in the publish call.
FeeChangeOrderId
Type
reference
Properties
Create, Nillable
Description
The change order for the fee ID. This order usually used for invoices.
This field is a relationship field.
Relationship Name
FeeChangeOrder
Refers To
Order
GrandTotalAmount
Type
double
Properties
Create, Nillable
Description
The new order summary's grand total.
This amount is equal to TotalAmount + TotalTaxAmount.
InFulfillmentChangeOrderId
Type
reference
Properties
Create, Nillable
Description
The change order for any items during fulfillment.
This field is a relationship field.
Relationship Name
InFulfillmentChangeOrder
Refers To
Order
OrderSummaryId
Type
reference
Properties
Create, Nillable
Description
The foreign key for the master Order Summary entity.
This field is a relationship field.
Relationship Name
OrderSummary
Refers To
OrderSummary
PostFulfillmentChangeOrderId
Type
reference
Properties
Create, Nillable
Description
The change order for any items post-fulfillment. This ID is used for credit memos refunds
This field is a relationship field.
Relationship Name
PostFulfillmentChangeOrder
Refers To
Order
PreFulfillmentChangeOrderId
Type
reference
Properties
Create, Nillable
Description
The change order for any items that haven't been fulfilled.
This field is a relationship field.
Relationship Name
PreFulfillmentChangeOrder
Refers To
Order
TotalAdjDistAmount
Type
double
Properties
Create, Nillable
Description
The total distributed adjustment amount without taxes.
TotalAdjDistTaxAmount
Type
double
Properties
Create, Nillable
Description
The total distributed adjustment taxes.
TotalAdjustedDeliveryAmount
Type
double
Properties
Create, Nillable
Description
The total delivery adjusted amount without taxes.
TotalAdjustedDeliveryTaxAmount
Type
double
Properties
Create, Nillable
Description
The total delivery adjusted tax amount .
TotalAdjustedProductAmount
Type
double
Properties
Create, Nillable
Description
The total adjusted product amount without tax.
TotalAdjustedProductTaxAmount
Type
double
Properties
Create, Nillable
Description
The total adjusted product tax amount.
This amount is equal to TotalAdjustmentAmount + TotalAdjustmentTaxAmount.
TotalAmount
Type
double
Properties
Create, Nillable
Description
The total amount, not including taxes.
TotalExcessFundsAmount
Type
double
Properties
Create, Nillable
Description
The amount used to determine if a refund is needed pre-fulfillment.
TotalFeeAmount
Type
double
Properties
Create, Nillable
Description
Total fee amount, not including taxes.
TotalFeeTaxAmount
Type
double
Properties
Create, Nillable
Description
The total fee tax amount.
TotalRefundableAmount
Type
double
Properties
Create, Nillable
Description
The amount that can be refunded to the client.
TotalRequiredFundsAmount
Type
double
Properties
Create, Nillable
Description
The total amount of required funds.
TotalTaxAmount
Type
double
Properties
Create, Nillable
Description
The combined total of all taxes.