Stratus Aperture

API Family:Default

Version:22.200.001

Screen ID:SO301000

Properties

Select a row for its DAC field and description

	Property	Type	Data Type
	`Approved`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOOrder.Approved` Description:A Boolean value that indicates whether the sales order has been approved. This field is available only if the Approval Workflow feature is enabled on the Enable/Disable Features (CS100000) form.
	`BaseCurrencyID`	`StringValue`	string
DAC Field:`PX.Objects.CM.CurrencyInfo.BaseCuryID` Description:Identifier of the base Currency. Defaults to the base currency of the company.
	`BillToAddress`	`Address`	Address
DAC Field:Not mapped to a DAC field Description:No description available
	`BillToAddressOverride`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOBillingAddress.OverrideAddress` Description:Specifies (if set to true) that the address is overriden. If the value of the isDefaultAddress field is null, the value of this field is null. If the value of the isDefaultAddress field is true, the value of this field is false. If the value of the isDefaultAddress field is false, the value of this field is true.
	`BillToAddressValidated`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOBillingAddress.IsValidated` Description:Specifies (if set to true) that the address has been validated with a third-party specialized software or service.
	`BillToContact`	`DocContact`	DocContact
DAC Field:Not mapped to a DAC field Description:No description available
	`BillToContactOverride`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOBillingContact.OverrideContact` Description:Specifies (if set to true) that the contact is overriden. If the value of the isDefaultContact field is null, the value of this field is null. If the value of the isDefaultContact field is true, the value of this field is false. If the value of the isDefaultContact field is false, the value of this field is true.
	`CashAccount`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.CashAccountID` Description:The identifier of the cash account associated with the customer payment method. The field is included in the FK.CashAccount foreign key. The value of this field corresponds to the value of the Account.accountID field. By default, the value is filled in with the cash account specified as the default for the selected method.
	`Commissions`	`Commissions`	Commissions
DAC Field:Not mapped to a DAC field Description:No description available
	`ContactID`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.ContactID` Description:The identifier of the contact. The field is included in the FK.Contact foreign key. The value of this field corresponds to the value of the Contact.contactID field.
	`ControlTotal`	`DecimalValue`	decimal
DAC Field:`PX.Objects.SO.SOOrder.CuryControlTotal` Description:The control total of the document (in the currency of the document). A user enters this amount manually.
	`CreditHold`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOOrder.CreditHold` Description:A Boolean value that specifies (if set to true) that the customer has failed the credit check, which the system performed when the order was taken off hold. An order with this status can be saved with only the Credit Hold or On Hold status if the Hold Document on Failed Credit Check field is true for the order type. This status is available for orders of the QT, SO, SA, IN, and CM order types.
	`CurrencyID`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.CuryID` Description:The identifier of the currency of the document. The field is included in the FK.Currency foreign key. The value of this field corresponds to the value of the Currency.curyID field. This field is available only if the Multicurrency Accounting feature is enabled on the Enable/Disable Features (CS100000) form.
	`CurrencyRate`	`DecimalValue`	decimal
DAC Field:`PX.Objects.CM.CurrencyInfo.SampleCuryRate` Description:The exchange rate used for calculations and determined by the values of the CuryMultDiv, CuryRate and RecipRate fields.
	`CurrencyRateTypeID`	`StringValue`	string
DAC Field:`PX.Objects.CM.CurrencyInfo.CuryRateTypeID` Description:The identifier of the Rate Type associated with this object. Corresponds to the CurrencyRateType.CuryRateTypeID field.
	`CustomerID`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.CustomerID` Description:The identifier of the customer. The field is a part of the identifier of the customer location. The field is included in the foreign keys FK.Customer and FK.CustomerLocation. For a customer, the value of this field corresponds to the value of the Customer.bAccountID field. For a customer location, the value of this field corresponds to the value of the Location.bAccountID field.
	`CustomerOrder`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.CustomerOrderNbr` Description:The reference number of the original customer document that the sales order is based on. A reference number must be specified if the Require Customer Order Nbr field is true for the order type. This field is available for orders of the TR type.
	`Date`	`DateTimeValue`	DateTime
DAC Field:`PX.Objects.SO.SOOrder.OrderDate` Description:The date of the document.
	`Description`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.OrderDesc` Description:A brief description of the document.
	`DestinationWarehouseID`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.DestinationSiteID` Description:The identifier of the destination warehouse for the items to be transferred. The field is included in the foreign keys FK.DestinationSite and FK.ToSite. The value of this field corresponds to the value of the INSite.siteID field. This field is available only if the Multiple Warehouses feature is enabled on the Enable/Disable Features (CS100000) form.
	`Details`	`List`	SalesOrderDetail
DAC Field:Not mapped to a DAC field Description:No description available
	`DisableAutomaticDiscountUpdate`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOOrder.DisableAutomaticDiscountCalculation` Description:A Boolean value that indicates whether the system treats discounts that have already been applied to the selected sales order as manual. If the value is false) for the sales order, the system updates all automatic line, group, and document discounts when users run discount recalculation or add new lines to the order. The default state of this field is the same as the state of the Disable Automatic Discount Update for the applicable order type.
	`DisableAutomaticTaxCalculation`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOOrder.DisableAutomaticTaxCalculation` Description:A Boolean value that specifies (if set to true) that the system does not need to calculate taxes, because they are already calculated.
	`DiscountDetails`	`List`	SalesOrdersDiscountDetails
DAC Field:Not mapped to a DAC field Description:No description available
	`EffectiveDate`	`DateTimeValue`	DateTime
DAC Field:`PX.Objects.CM.CurrencyInfo.CuryEffDate` Description:The date, starting from which the specified rate is considered current. Defaults to the current business date.
	`ExternalRef`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.CustomerRefNbr` Description:The reference number of the sales order in a third-party application if Acumatica ERP is integrated with such an application and imports the sales orders from it.
	`FinancialSettings`	`FinancialSettings`	FinancialSettings
DAC Field:Not mapped to a DAC field Description:No description available
	`Hold`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOOrder.Hold` Description:A Boolean value that indicates whether the order is on hold. If the order is on hold, additions and changes can be made and order quantities do not affect the item availability.
	`IsTaxValid`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOOrder.ExternalTaxesImportInProgress` Description:A Boolean value that indicates whether the taxes were calculated by an external system.
	`LastModified`	`DateTimeValue`	DateTime
DAC Field:`PX.Objects.SO.SOOrder.LastModifiedDateTime` Description:No description available
	`LocationID`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.CustomerLocationID` Description:The identifier of the customer location. The field is included in the FK.CustomerLocation foreign key. The value of this field corresponds to the value of the Location.locationID field.
	`OrderedQty`	`DecimalValue`	decimal
DAC Field:`PX.Objects.SO.SOOrder.OrderQty` Description:The summarized quantity of all items that have been added to the child order from the blanket sales order. If any items that are not from the current blanket sales order have been added to the child order, their quantity is not summed up to the value in this field.
	`OrderNbr`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.OrderNbr` Description:The unique reference number of the order. When the new sales order is saved for the first time, the system automatically generates this number by using the numbering sequence assigned to orders of SOOrderType.
	`OrderTotal`	`DecimalValue`	decimal
DAC Field:`PX.Objects.SO.SOOrder.CuryOrderTotal` Description:The total amount of the document (in the currency of the document).
	`OrderType`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.OrderType` Description:The type of the document, which is a part of the identifier of the order. The identifier of the order type. The field is included in the FK.OrderType foreign key. The value of this field corresponds to the value of the SOOrderType.orderType field. The type of the document, which is one of the predefined order types or a custom order type created by using the Order Types (SO201000) form.
	`PaymentMethod`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.PaymentMethodID` Description:The identifier of the payment method to be used to pay for the sales order. The field is included in the FK.PaymentMethod foreign key. The value of this field corresponds to the value of the PaymentMethod.paymentMethodID field. By default, the value is the default payment method of the customer.
	`Payments`	`List`	SalesOrderPayment
DAC Field:Not mapped to a DAC field Description:No description available
	`PreferredWarehouseID`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.DefaultSiteID` Description:The identifier of the warehouse from which the goods should be shipped. The field is included in the FK.DefaultSite foreign key. The value of this field corresponds to the value of the INSite.siteID field. This field is available only if the Inventory feature is enabled on the Enable/Disable Features (CS100000) form.
	`Project`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.ProjectID` Description:The identifier of the project. The field is included in the FK.Project foreign key. The value of this field corresponds to the value of the PMProject.contractID field. The value specifies the project with which this sales order is associated or the non-project code, which indicates that this order is not associated with any project. The non-project code is specified on the Projects Preferences (PM101000) form. This field is available only if the Project Accounting feature is enabled on the Enable/Disable Features (CS100000) form and the integration of the Projects submodule with Sales Orders has been enabled (that is, PMSetup.visibleInSO is true.
	`ReciprocalRate`	`DecimalValue`	decimal
DAC Field:`PX.Objects.CM.CurrencyInfo.SampleRecipRate` Description:The inverse of the SampleCuryRate. This value is also determined by the values of the CuryMultDiv, CuryRate and RecipRate fields.
	`RequestedOn`	`DateTimeValue`	DateTime
DAC Field:`PX.Objects.SO.SOOrder.RequestDate` Description:The date when the customer wants to receive the goods. The default value is the current business date. This date provides the default values for the SOLine.requestDate dates for order lines.
	`Shipments`	`List`	SalesOrderShipment
DAC Field:Not mapped to a DAC field Description:No description available
	`ShippingSettings`	`ShippingSettings`	ShippingSettings
DAC Field:Not mapped to a DAC field Description:No description available
	`ShipToAddress`	`Address`	Address
DAC Field:Not mapped to a DAC field Description:No description available
	`ShipToAddressOverride`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOShippingAddress.OverrideAddress` Description:Specifies (if set to true) that the address is overriden. If the value of the isDefaultAddress field is null, the value of this field is null. If the value of the isDefaultAddress field is true, the value of this field is false. If the value of the isDefaultAddress field is false, the value of this field is true.
	`ShipToAddressValidated`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOShippingAddress.IsValidated` Description:Specifies (if set to true) that the address has been validated with a third-party specialized software or service.
	`ShipToContact`	`DocContact`	DocContact
DAC Field:Not mapped to a DAC field Description:No description available
	`ShipToContactOverride`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOShippingContact.OverrideContact` Description:Specifies (if set to true) that the contact is overriden. If the value of the isDefaultContact field is null, the value of this field is null. If the value of the isDefaultContact field is true, the value of this field is false. If the value of the isDefaultContact field is false, the value of this field is true.
	`ShipVia`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.ShipVia` Description:The identifier of the ship via code that represents the carrier and its service to be used for shipping the ordered goods. The field is included in the FK.Carrier foreign key. The value of this field corresponds to the value of the Carrier.carrierID field. For this ship via code, if Manual is specified as the freight calculation method, the freight amount must be specified in the Freight Price field. Changing the Ship Via code for an open sales order may update the customer tax zone field.
	`Status`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.Status` Description:The status of the order. The field can have one of the values listed in SOOrderStatus.
	`TaxDetails`	`List`	TaxDetail
DAC Field:Not mapped to a DAC field Description:No description available
	`TaxTotal`	`DecimalValue`	decimal
DAC Field:`PX.Objects.SO.SOOrder.CuryTaxTotal` Description:The total amount of tax paid on the document (in the currency of the document).
	`Totals`	`Totals`	Totals
DAC Field:Not mapped to a DAC field Description:No description available
	`VATExemptTotal`	`DecimalValue`	decimal
DAC Field:`PX.Objects.SO.SOOrder.CuryVatExemptTotal` Description:The document total that is exempt from VAT (in the currency of the document).
	`VATTaxableTotal`	`DecimalValue`	decimal
DAC Field:`PX.Objects.SO.SOOrder.CuryVatTaxableTotal` Description:The document total that is subject to VAT (in the currency of the document).
	`ExternalOrderOriginal`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOOrder.ExternalOrderOriginal` Description:Indicates whether original order is external.
	`ExternalRefundRef`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.ExternalRefundRef` Description:The external ID of any refund for this order.
	`WillCall`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOOrder.WillCall` Description:A Boolean value that indicates whether the customer picks the goods from the warehouse (will call). If the value is false, the common carrier is to be used for shipping goods. If shipVia is null, the value of this field is true. If shipVia is not null, the value of this field directly corresponds to the state of the Common Carrier field for the selected ship via code.
	`PaymentRef`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.ExtRefNbr` Description:The reference number of the payment. This field is available only for sales orders of the Cash Sales or Cash Return type.
	`NoteID`	`GuidValue`	Guid
DAC Field:`PX.Objects.SO.SOOrder.NoteID` Description:The identifier of the Note object, associated with the document. The value corresponds to the Note.NoteID field.
	`UsrExternalOrderOriginal`	`BooleanValue`	boolean
DAC Field:Not mapped to a DAC field Description:No description available
	`ExternalOrderOrigin`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.ExternalOrderOrigin` Description:The external ID of the original order.
	`ExternalOrderSource`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.ExternalOrderSource` Description:The name of the external source for this order.
	`TaxCalcMode`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOOrder.TaxCalcMode` Description:The tax calculation mode to be used for the sales order. The field can have one of the following values: - TaxCalculationMode.taxSetting (default): The document uses the settings of the selected customer, or of the location of the customer if the Business Account Locations feature is enabled on the Enable/Disable Features (CS100000) form. - TaxCalculationMode.gross: The tax amount is included in the item price. - TaxCalculationMode.net: The tax amount is not included in the item price. This field is available only if the Net/Gross Entry Mode feature has been enabled on the Enable/Disable Features (CS100000) form.
	`CreatedDate`	`DateTimeValue`	DateTime
DAC Field:`PX.Objects.SO.SOOrder.CreatedDateTime` Description:No description available

Minimum Payload

Derived from static analysis of the 2025.2 source; runtime configuration may require additional fields.

{
  "CurrencyRate": {
    "value": 0
  },
  "CustomerID": {
    "value": "string"
  },
  "Status": {
    "value": "string"
  },
  "Details": [
    {
      "InventoryID": {
        "value": "string"
      }
    }
  ]
}

For every property this entity accepts, see the properties table.

Details is the detail-lines collection (SalesOrderDetail); one example row is included above because a document usually has lines, and each row needs InventoryID of its own.

Optional Children

None of these child collections is required — a payload without them is valid. If you do include one, these are the fields each row of it needs; keys the parent record supplies are named separately and must not be sent.

DiscountDetailsa list of SalesOrdersDiscountDetailsrequired if you include one:DiscountCodeSequenceIDType
TaxDetailsa list of TaxDetailrequired if you include one:TaxIDsupplied by the parent:OrderNbrOrderType

Available in Versions

25.200.001 24.200.001 23.200.001 22.200.001 20.200.001