Even geduld a.u.b...

Exact Online REST API - SalesOrders

Endpoint

SalesOrders

Good to know

Use this endpoint to create, read, update and delete sales orders.
Note: You must include a parameter for 'SalesOrderLines' to add sales order lines when you POST to the SalesOrders endpoint. This parameter is not necessary when you PUT to this endpoint.

Sales order lines support trade-in lines. For more details, please refer description under properties SalesOrderLines > Quantity

Sales orders describe the items that you plan to sell to your customers.
For more information about the sales order functionality in Exact Online, see About sales orders.

To view an example of the business use of this endpoint, see Rest API - Business example API sales order.


This endpoint is available for the following packages:


This entity supports webhooks.
Subscribe to the topic SalesOrders to get updates on the SalesOrders resource. You will also receive events on the SalesOrders resource.


This API allows to filter only on specific fields. Below you can see per field if it can be filtered on or not.
When you filter on a key field, there are two syntaxes possible which are both supported. In the example usage section you can see the two syntaxes which are supported.

Scope

Sales orders

URI

/api/v1/{division}/salesorder/SalesOrders


GET POST PUT DELETE

Example usage

/api/v1/{division}/salesorder/SalesOrders

/api/v1/{division}/salesorder/SalesOrders

/api/v1/{division}/salesorder/SalesOrders

/api/v1/{division}/salesorder/SalesOrders

/api/v1/{division}/salesorder/SalesOrders


Properties

Name Mandatory Value Value Type Webhook Filter Description
OrderID False Edm.Guid Mandatory filter Primary key
AmountDC False Edm.Double Supports webhook Amount in the default currency of the company
AmountDiscount False Edm.Double Supports webhook Discount amount in the default currency of the company
AmountDiscountExclVat False Edm.Double Supports webhook Discount amount excluding VAT in the default currency of the company
AmountFC False Edm.Double Supports webhook Amount in the currency of the transaction
AmountFCExclVat False Edm.Double Supports webhook Amount exclude VAT in the currency of the transaction
ApprovalStatus False Edm.Int16 Supports webhook Mandatory filter Approval status of sales order. 0=Awaiting approval, 1=Automatically, 2=Approved. Approve a new sales order by giving value 2 if user has SalesOrderApproval right.
ApprovalStatusDescription False Edm.String Description of ApprovalStatus
Approved False Edm.DateTime Supports webhook Approval datetime
Approver False Edm.Guid Supports webhook Mandatory filter User who approved the sales order
ApproverFullName False Edm.String Name of approver
Created False Edm.DateTime Mandatory filter Creation date
Creator False Edm.Guid User ID of creator
CreatorFullName False Edm.String Name of creator
Currency False Edm.String Supports webhook Currency code
DeliverTo False Edm.Guid Supports webhook Mandatory filter Reference to the delivery customer. For an existing sales order this value can not be changed.
DeliverToContactPerson False Edm.Guid Supports webhook Mandatory filter Reference to contact person of delivery customer
DeliverToContactPersonFullName False Edm.String Name of contact person of delivery customer
DeliverToName False Edm.String Name of delivery customer
DeliveryAddress False Edm.Guid Supports webhook Mandatory filter Delivery address
DeliveryDate False Edm.DateTime Supports webhook Mandatory filter Delivery date
DeliveryStatus False Edm.Int16 Supports webhook Mandatory filter Shipping status
DeliveryStatusDescription False Edm.String Description of DeliveryStatus
Description False Edm.String Supports webhook Mandatory filter Description
Discount False Edm.Double Supports webhook Discount percentage
Division False Edm.Int32 Division code
Document False Edm.Guid Supports webhook Mandatory filter Document that is manually linked to the sales order
DocumentNumber False Edm.Int32 Number of the document
DocumentSubject False Edm.String Subject of the document
IncotermAddress False Edm.String Address of Incoterm
IncotermCode False Edm.String Code of Incoterm
IncotermVersion False Edm.Int16 Version of Incoterm
Supported version for Incoterms : 2010, 2020
InvoiceStatus False Edm.Int16 Supports webhook Mandatory filter Invoice status
InvoiceStatusDescription False Edm.String Description of InvoiceStatus
InvoiceTo False Edm.Guid Supports webhook Mandatory filter Reference to the customer who will receive the invoice. For an existing sales order this value can not be changed.
InvoiceToContactPerson False Edm.Guid Supports webhook Mandatory filter Reference to the contact person of the customer who will receive the invoice
InvoiceToContactPersonFullName False Edm.String Name of the contact person of the customer who will receive the invoice
InvoiceToName False Edm.String Name of the customer who will receive the invoice
Modified False Edm.DateTime Mandatory filter Last modified date
Modifier False Edm.Guid User ID of modifier
ModifierFullName False Edm.String Name of modifier
OrderDate False Edm.DateTime Supports webhook Mandatory filter Order date
OrderedBy True Edm.Guid Supports webhook Mandatory filter Customer who ordered the sales order. For an existing sales order this value can not be changed.
OrderedByContactPerson False Edm.Guid Supports webhook Mandatory filter Contact person of the customer who ordered the sales order
OrderedByContactPersonFullName False Edm.String Name of contact person of the customer who ordered the sales order
OrderedByName False Edm.String Name of the customer who ordered the sales order
OrderNumber False Edm.Int32 Mandatory filter Number of sales order
PaymentCondition False Edm.String Supports webhook The payment condition used for due date and discount calculation
PaymentConditionDescription False Edm.String Description of PaymentCondition
PaymentReference False Edm.String Supports webhook Mandatory filter Payment reference for sales order
Remarks False Edm.String Supports webhook Extra remarks
SalesChannel False Edm.Guid ID of Sales channel.
SalesChannelCode False Edm.String Code of Sales channel
SalesChannelDescription False Edm.String Description of Sales channel
SalesOrderLines True Collection of lines
SalesOrderOrderChargeLines False Collection of order charge lines
Salesperson False Edm.Guid Supports webhook Mandatory filter Sales representative
SalespersonFullName False Edm.String Name of sales representative
SelectionCode False Edm.Guid Mandatory filter ID of selection code. Only supported by the Plus, Professional and Premium for Wholesale & Distribution and Manufacturing
SelectionCodeCode False Edm.String Code of selection code
SelectionCodeDescription False Edm.String Description of selection code
ShippingMethod False Edm.Guid Supports webhook Mandatory filter ShippingMethod
ShippingMethodDescription False Edm.String Description of ShippingMethod
Status False Edm.Int16 Supports webhook Mandatory filter The status of the sales order. 12 = Open, 20 = Partial, 21 = Complete, 45 = Cancelled.
StatusDescription False Edm.String Description of Status
TaxSchedule False Edm.Guid Mandatory filter Obsolete
TaxScheduleCode False Edm.String Obsolete
TaxScheduleDescription False Edm.String Obsolete
WarehouseCode False Edm.String Code of Warehouse
WarehouseDescription False Edm.String Description of Warehouse
WarehouseID False Edm.Guid Supports webhook Mandatory filter Warehouse. Only supported by the Plus, Professional and Premium editions for Wholesale & Distribution and Manufacturing
YourRef False Edm.String Supports webhook Mandatory filter The reference number of the customer

Returns