OrderSummary
Represents a summarized view of an order used to track fulfillment across its lifecycle.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Unique identifier for the record. | |
| OwnerId | String | False |
ID of the user who owns the record. | |
| IsDeleted | Bool | True |
Indicates whether the record has been moved to the Recycle Bin. | |
| OrderNumber | String | False |
Order identification number. | |
| CurrencyIsoCode | String | False |
ISO code for the currency in which the revenue amount is expressed. | |
| CreatedDate | Datetime | True |
Date and time when the record was created. | |
| CreatedById | String | True |
User.Id |
ID of the user who created the record. |
| LastModifiedById | String | True |
User.Id |
ID of the user who last modified the record. |
| LastViewedDate | Datetime | True |
Date and time when the record was last viewed in the user interface. | |
| LastReferencedDate | Datetime | True |
Date and time when the record was last referenced. | |
| OriginalOrderId | String | True |
Order.Id |
ID of the OriginalOrder associated with this record. |
| AccountId | String | True |
Account.Id |
ID of the Account associated with this record. |
| ChangeOrderId | String | True |
Order.Id |
ID of the ChangeOrder associated with this record. |
| TotalAmount | Decimal | True |
Total amount of the order summary. | |
| GrandTotalAmount | Decimal | True |
Grand total amount of the order summary, including all charges. | |
| TotalAdjDistAmount | Decimal | True |
Total adjustment amount distributed across the order summary. | |
| TotalAdjDistTaxAmount | Decimal | True |
Total tax amount on adjustments distributed across the order summary. | |
| BillingStreet | String | False |
Street address for Billing purposes. | |
| BillingCity | String | False |
City for Billing address. | |
| BillingState | String | False |
State or province for Billing address. | |
| BillingPostalCode | String | False |
Postal code for Billing address. | |
| BillingCountry | String | False |
Country for Billing address. | |
| BillingLatitude | Double | False |
Latitude coordinate for Billing address geolocation. | |
| BillingLongitude | Double | False |
Longitude coordinate for Billing address geolocation. | |
| BillingGeocodeAccuracy | String | False |
Accuracy level of the geocode for the Billing address. | |
| BillingEmailAddress | String | False |
Field containing BillingEmailAddress information. | |
| BillingPhoneNumber | String | False |
BillingPhone identification number. | |
| TaxLocaleType | String | True |
Type classification for TaxLocale. | |
| OrderedDate | Datetime | True |
Date associated with Ordered. | |
| TotalTaxAmount | Decimal | True |
Total tax amount for the order summary. | |
| Status | String | False |
Status of the record. | |
| Description | String | False |
Text description of the record. | |
| SalesStoreId | String | True |
WebStore.Id |
ID of the SalesStore associated with this record. |
| SalesChannelId | String | True |
SalesChannel.Id |
ID of the SalesChannel associated with this record. |
| PoNumber | String | False |
Po identification number. | |
| PoDate | Datetime | False |
Date associated with Po. | |
| TotalProductAmount | Decimal | True |
Total amount attributable to products in the order summary. | |
| TotalDeliveryAmount | Decimal | True |
Total amount attributable to delivery charges in the order summary. | |
| TotalFeeAmount | Decimal | True |
Total amount attributable to fees in the order summary. | |
| TotalAdjustedProductAmount | Decimal | True |
Total product amount after adjustments have been applied. | |
| TotalAdjustedDeliveryAmount | Decimal | True |
Total delivery amount after adjustments have been applied. | |
| TotalAdjustedFeeAmount | Decimal | True |
Total fee amount after adjustments have been applied. | |
| TotalProductAdjDistAmount | Decimal | True |
Total product adjustment amount distributed across the order summary. | |
| TotalDeliveryAdjDistAmount | Decimal | True |
Total delivery adjustment amount distributed across the order summary. | |
| TotalFeeAdjDistAmount | Decimal | True |
Total fee adjustment amount distributed across the order summary. | |
| TotalProductTaxAmount | Decimal | True |
Total tax amount attributable to products in the order summary. | |
| TotalDeliveryTaxAmount | Decimal | True |
Total tax amount attributable to delivery charges in the order summary. | |
| TotalFeeTaxAmount | Decimal | True |
Total tax amount attributable to fees in the order summary. | |
| TotalAdjustedProductTaxAmount | Decimal | True |
Total product tax amount after adjustments have been applied. | |
| TotalAdjustedDeliveryTaxAmount | Decimal | True |
Total delivery tax amount after adjustments have been applied. | |
| TotalAdjustedFeeTaxAmount | Decimal | True |
Total fee tax amount after adjustments have been applied. | |
| TotalProductAdjDistTaxAmount | Decimal | True |
Total product tax adjustment amount distributed across the order summary. | |
| TotalDeliveryAdjDistTaxAmount | Decimal | True |
Total delivery tax adjustment amount distributed across the order summary. | |
| TotalFeeAdjDistTaxAmount | Decimal | True |
Total fee tax adjustment amount distributed across the order summary. | |
| OrderLifeCycleType | String | True |
Type classification for OrderLifeCycle. | |
| BillToContactId | String | False |
Contact.Id |
ID of the BillToContact associated with this record. |
| ExternalReferenceIdentifier | String | False |
Field containing ExternalReferenceIdentifier information. | |
| TotalProductAmountWithTax | Decimal | True |
Total product amount, including tax, for the order summary. | |
| TotalDeliveryAmountWithTax | Decimal | True |
Total delivery amount, including tax, for the order summary. | |
| TotalFeeAmountWithTax | Decimal | True |
Total fee amount, including tax, for the order summary. | |
| TotalAdjProductAmtWithTax | Decimal | True |
Total adjusted product amount, including tax, for the order summary. | |
| TotalAdjDeliveryAmtWithTax | Decimal | True |
Total adjusted delivery amount, including tax, for the order summary. | |
| TotalAdjFeeAmtWithTax | Decimal | True |
Total adjusted fee amount, including tax, for the order summary. | |
| TotalProductAdjDistAmtWithTax | Decimal | True |
Total product adjustment amount, including tax, distributed across the order summary. | |
| TotalDeliveryAdjDistAmtWithTax | Decimal | True |
Total delivery adjustment amount, including tax, distributed across the order summary. | |
| TotalFeeAdjDistAmtWithTax | Decimal | True |
Total fee adjustment amount, including tax, distributed across the order summary. | |
| TotalAdjDistAmountWithTax | Decimal | True |
Total adjustment amount, including tax, distributed across the order summary. | |
| IsSuspended | Bool | False |
Indicates whether the record has the Suspended characteristic. | |
| ActiveProcessExceptionCount | Int | True |
Number of ActiveProcessException associated with this record. | |
| RoutingAttempts | Int | False |
Field containing RoutingAttempts information. | |
| OrderProductLineCount | Int | True |
Number of OrderProductLine associated with this record. | |
| BusinessModel | String | False |
Field containing BusinessModel information. | |
| SourceProcess | String | True |
Field containing SourceProcess information. | |
| SourceOrderSummaryId | String | True |
OrderSummary.Id |
ID of the SourceOrderSummary associated with this record. |
| Pricebook2Id | String | True |
Pricebook2.Id |
ID of the Pricebook2 associated with this record. |
| OperationInProgress | String | True |
Field containing OperationInProgress information. | |
| EffectiveDate | Date | True |
Date associated with Effective. | |
| OriginalOrderName | String | True |
Field containing OriginalOrderName information. | |
| OrderManagementBillingType | String | True |
Billing type used for order management, such as immediate or deferred. | |
| ExternalCustomerIdReference | String | True |
External identifier referencing the customer associated with the order. | |
| SystemModstamp | Datetime | True |
Date and time when the record was last modified by a user or by an automated process. | |
| LastModifiedDate | Datetime | True |
Date and time when the record was last modified. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| OwnerIdType | String |
Specifies the type of the 'OwnerId' polymorphic field to use in the statement. |
| OwnerIdExternalFieldName | String |
Specifies the external field name of the 'OwnerId' polymorphic field to use in an INSERT/UPDATE/UPSERT statement |
| SalesStoreIdType | String |
Specifies the type of the 'SalesStoreId' polymorphic field to use in the statement. |
| SalesStoreIdExternalFieldName | String |
Specifies the external field name of the 'SalesStoreId' polymorphic field to use in an INSERT/UPDATE/UPSERT statement |
| SOQL | String |
Specifies the SOQL query to execute against the Salesforce servers. If this pseudo column is set from the WHERE clause it will take precedence over the original query. |
| ExternalIdColumn | String |
Specifies the external Id column to use if performing an insert. If this value is specified, upsert will be used when the INSERT command is called. |
| FilterScope | String |
Optional scope to limit the records returned from queries. This property can take one of these values: Delegated, Everything, Mine, MineAndMyGroups, My_Territory, My_Team_Territory, or Team. |