Used to create, update and list sales orders. When creating sales orders that have been paid you can populate the receipts collection with payment information.
Available Services...
GET PUT POST SEARCH| Property Name | Access | Description |
|---|---|---|
| Date | ReadWrite | The order date |
| DueDate | ReadWrite | The order due date |
| Number | ReadWrite | The order number. This will be automatically assigned for new orders. |
| AlternateReference | ReadWrite | An alternate or customer reference for the order |
| Customer | ReadWrite | The customer placing the order. A list of customers can be retrieved from the customers service |
| DeliveryContact | ReadWriteCreate | The delivery contact from the associated customer's delivery contact collection. The ID of the delivery contact can be specified here when creating orders. |
| Contact | ReadWrite | The contact from the associated customer contacts collection. The ID of the delivery contact can be specified here when creating orders. |
| SalesContact | ReadWrite | This contact can either be a contact from the customer's contact list OR a contact from the Cash Customer contact list. |
| CashCustomer | ReadWrite | The cash customer account for the order. Cash customers are used when there is a single customer account used to process cash sales and you need to capture information about the customer and store it for future use. New cash customers can be added using the Cash Customers service. |
| SalesRep | ReadWrite | The sales rep for the order. A list of valid sales reps can be retrieved from the sales reps service. If this is not specified the system will use the customer accounts sales rep. |
| Branch | ReadWrite | The branch the order was placed in |
| DespatchBranch | ReadWrite | The branch responsible for shipping the order. A list of valid branches is available in the branches service. |
| WorkflowStatus | ReadWrite | The workflow status of the order. A list of states can be retrieved from the sales order workflow states service |
| OrderType | ReadWrite | The order type. A list of order types can be retrieved from the order types service. |
| Currency | ReadWrite | The currency of the order. A valid list of currencies can be retrieved from the currencies service. |
| Particulars | ReadWrite | Summary information provided in free text form |
| DeliveryInstructions.Text | ReadWrite | Special delivery instructions, encase in [] square brackets |
| DeliveryAgent | ReadWrite | The delivery agent. A list of valid delivery agents and their services can be retrieved from the delivery agent service. Specify the ID |
| DeliveryAgentService | ReadWrite | The delivery agent service. Each delivery agent has a collection of services. You can specify the ID of the appropriate service from the agents service list. Specify the ID |
| DeliveryNetAmount | ReadWrite | The delivery net amount (ex tax) |
| DeliveryTaxRate | ReadWrite | The delivery tax rate |
| DeliveryTaxAmount | ReadOnly | The delivery tax amount |
| DeliveryGrossAmount | ReadOnly | The delivery gross amount (including tax) |
| NetAmount | ReadOnly | The total net amount |
| TaxAmount | ReadOnly | The total tax amount |
| GrossAmount | ReadOnly | The total gross amount |
| SourceQuotation | ReadOnly | The source quotation for the order if it was created from a quote. |
| Items.Product | ReadWrite | Product for the order line. A list of valid product IDs or Codes can be retrieved from the products service |
| Items.Description | ReadWrite | An optional text description of the item |
| Items.Quantity | ReadWrite | Quantity ordered |
| Items.QuantitySupplied | ReadWrite | Quantity supplied to date |
| Items.NetPrice | ReadWrite | Net price before tax |
| Items.GrossPrice | ReadWrite | Gross price including tax |
| Items.NetAmount | ReadWrite | Net amount |
| Items.DiscountPercentage | ReadWrite | Discount percentage |
| Items.DiscountAmount | ReadWrite | Discount amount |
| Items.TaxRate | ReadWrite | Tax rate. A list of valid tax rates can be retrieved from the tax rates service. If not specified the appropriate rate will be applied when posted to the service. |
| Items.TaxAmount | ReadOnly | Tax amount |
| Items.GrossAmount | ReadOnly | Total for the line including tax |
| Items.PricingStatus | ReadOnly | Pricing status (Valid, Approved, YetToBePriced, PriceRulesExpired, RequiresVerification) |
| Items.CostCentre | ReadWrite | The general ledger cost centre associated with this line. A list of valid cost centres can be retrieved from the cost centers service. |
| Items.StockBin | ReadWrite | The stock bin from which the item should be dispatched |
| Items.PriceSource | ReadWrite | The price source |
| Receipts.ReceiptType | ReadWrite | The receipt type. A list of receipt types can be retrieved from the receipt type service. This is specified if the order has been paid for in full. |
| Receipts.Amount | ReadWrite | The amount received of the specified type. |
| DeliveryMethod | ReadWrite | DeliveryMethod should be the ID |
| DeliveryAgentServiceChargeTypeOverride | ReadWrite | DeliveryAgentServiceChargeTypeOverride |
| DeliveryContact.FirstName | ReadWrite | DeliveryContact.FirstName |
| DeliveryContact.LastName | ReadWrite | DeliveryContact.LastName |
| DeliveryContact.EmailAddress | ReadWrite | DeliveryContact.EmailAddress |
| DeliveryContact.Mobile | ReadWrite | DeliveryContact.Mobile |
| DeliveryContact.Phone | ReadWrite | DeliveryContact.Phone |
| DeliveryContact.Address | ReadWrite | DeliveryContact.Address |
| DeliveryContact.Address.AddressLine1 | ReadWrite | DeliveryContact.Address.AddressLine1 |
| DeliveryContact.Address.AddressLine2 | ReadWrite | DeliveryContact.Address.AddressLine2 |
| DeliveryContact.Address.AddressLine3 | ReadWrite | DeliveryContact.Address.AddressLine3 |
| DeliveryContact.Address.AddressLine4 | ReadWrite | DeliveryContact.Address.AddressLine4 |
| DeliveryContact.Address.City | ReadWrite | DeliveryContact.Address.City |
| DeliveryContact.Address.County | ReadWrite | DeliveryContact.Address.County |
| DeliveryContact.Address.PostCode | ReadWrite | DeliveryContact.Address.PostCode |
| DeliveryContact.Address.Country | ReadWrite | DeliveryContact.Address.Country |
| NetAmountLessDiscount | ReadOnly | NetAmountLessDiscount |
| Items.NetAmountLessDiscount | ReadOnly | Items.NetAmountLessDiscount |
| AccountExchangeRate | ReadWrite | AccountExchangeRate |
| Receipts.ReceiptType.Currency | ReadWrite | Currency |
| Currency | ReadWrite | Currency |
| TransactionExchangeRate | ReadWrite | TransactionExchangeRate |
| P_SalesDocumentCashDrawerJournal.Branch | ReadWriteCreate | P_SalesDocumentCashDrawerJournal.Branch |
| D_EmailAddress | ReadWrite | D_EmailAddress |
| D_CustomerPhoneNumber | ReadWrite | D_CustomerPhoneNumber |
| D_CustomerFirstName | ReadWrite | D_CustomerFirstName |
| D_CustomerLastName | ReadWrite | D_CustomerLastName |
| Items.PriceSource | ReadWrite | Items.PriceSource |
| Items.PriceListRule | ReadOnly | Items.PriceListRule |
| D_udfMagentoOrderNr | ReadWrite | D_udfMagentoOrderNr |
| Customer.Code | ReadWrite | Customer.Code |
| DeliveryAgentServiceChargeTypeOverride | ReadWrite | DeliveryAgentServiceChargeTypeOverride |
| DeliveryContact.SavePermanently | ReadWrite | DeliveryContact.SavePermanently |
| DeliveryInstructions | ReadWrite | DeliveryInstructions |
| DeliveryInstructions.Text | ReadWrite | DeliveryInstructions.Text |
| DeliveryInstructions.Text.Line1 | ReadWrite | DeliveryInstructions.Text.Line1 |
| DeliveryInstructions.Text.Line2 | ReadWrite | DeliveryInstructions.Text.Line2 |
| Items.LinearLengthAllocation.LinearTally | ReadWrite | Items.LinearLengthAllocation.LinearTally |
| DeliveryContact.D_InvoiceAddress.AddressLine1 | ReadWriteCreate | DeliveryContact.D_InvoiceAddress.AddressLine1 |
| DeliveryContact.D_InvoiceAddress.AddressLine2 | ReadWriteCreate | DeliveryContact.D_InvoiceAddress.AddressLine2 |
| DeliveryContact.D_InvoiceAddress.AddressLine3 | ReadWriteCreate | DeliveryContact.D_InvoiceAddress.AddressLine3 |
| DeliveryContact.D_InvoiceAddress.AddressLine4 | ReadWriteCreate | DeliveryContact.D_InvoiceAddress.AddressLine4 |
| DeliveryContact.D_InvoiceAddress.City | ReadWriteCreate | DeliveryContact.D_InvoiceAddress.City |
| DeliveryContact.D_InvoiceAddress.Country | ReadWriteCreate | DeliveryContact.D_InvoiceAddress.Country |
| DeliveryContact.D_InvoiceAddress.County | ReadWriteCreate | DeliveryContact.D_InvoiceAddress.County |
| DeliveryContact.D_InvoiceAddress.PostCode | ReadWriteCreate | DeliveryContact.D_InvoiceAddress.PostCode |
| DeliveryContact.D_InvoiceAddress | ReadWriteCreate | DeliveryContact.D_InvoiceAddress |
| DeliveryContact.AddressHandling | ReadWrite | DeliveryContact.AddressHandling |