Sales Order DTO v13

Represents a sales order with all the necessary properties, including net prices, gross prices and taxes. SalesOrders can only be created on business partners of type CUSTOMER or LEAD and can only contain items with flag "salesItem" set to true.

Field Name Type Category Constraint Reference Description
billingAddress Identifier Optional Address : 15, 16, 17, 18 Reference to the billing address of the business partner.
businessPartner Identifier Optional BusinessPartner : 16, 17, 18, 19, 20 Reference to the corresponding business partner.
code String Optional length >= 1 & length <= 512 System code of this object, normally this correlates to the erp id given by the source system.
contact Identifier Optional Contact : 12, 13, 14, 15, 16 Reference to the contact of the business partner.
deliveryDate Date Optional Date of delivery for this object.
documentOrigin DocumentOrigin Optional Allowed values { BACKEND_INFORMATION_SERVICE } The origin of this document. @See DocumentOrigin for more information.
expenses Monetary Optional Additional expense amount.
overallDiscount BigDecimal Optional Discount which is calculated on top of the total net.
paymentTermCode String Optional length >= 1 & length <= 512 Code of the associated payment term.
paymentTermName String Optional length >= 1 & length <= 512 Name of the associated payment term.
paymentTypeCode String Optional length >= 1 & length <= 512 Code of the associated payment type.
paymentTypeName String Optional length >= 1 & length <= 512 Name of the associated payment type.
refNo String Optional length >= 1 & length <= 300 Customers reference number.
remarks String Optional length >= 1 & length <= 2147483647 Remarks or notes, can be used for any string based content which contains necessary information.
salesOrderItems Set<SalesOrderitemdto_v10> Optional List of sales order items related to this object.
salesPerson Identifier Optional Person : 15, 16, 17, 18, 19 Reference to the salesperson responsible for this document.

Considered by the permission system whenever read/write permission is set to OWN.

shippingAddress Identifier Optional Address : 15, 16, 17, 18 Reference to the shipping address of the business partner.
shippingTypeCode String Optional length >= 1 & length <= 512 Code of the associated shipping type.
shippingTypeName String Optional length >= 1 & length <= 512 Name of the associated shipping type.
status SalesOrderStatus Optional Allowed values { DRAFT, OPEN, APPROVED, CLOSED } The current status of this sales order. @see SalesOrderStatus.
tax Monetary Optional Amount of tax which applies to this.
totalAmountGross Monetary Optional Total amount gross price (including taxes).
totalAmountNet Monetary Optional Total amount net price (without taxes).

SalesOrderDTO_v13.SalesOrderitemdto_v10


Field Name Type Category Constraint Reference Description
discount BigDecimal Optional Discount for that item position.
item Identifier Required Item : 17, 18, 19, 20, 21 Reference to the item used in this position.
itemName String Optional length >= 1 & length <= 512 Display name of the position.
ordinal Integer Required Ordinal of this position.
quantity BigDecimal Required Quantity of the item for this position.
salesQuotation Identifier Optional SalesQuotation : 12, 13, 14, 15, 16 Reference to sales quotation.
tax Monetary Optional Represents how much the calculated tax applied to this position is.
taxDescription String Optional length >= 1 & length <= 15 Can be used to store additional information about tax like tax-code or tax-percentage.
unitPrice Monetary Optional UnitPrice for this item (what does a unit of this item cost).
usage Identifier Optional Usage : 11, 12, 13, 14 Reference to the usage of in this position.
warehouse Identifier Optional Warehouse : 12, 13, 14, 15 Reference to the warehouse used in this position.