idstring required
Unique id associated to this entity.
orderedDatestring date-time required
Sales order ordered date (generally the creation date but can be post/pre-dated).
customerPoNumberstring nullable
externalQuoteUrlstring nullable
A reference URL that points to an external quote entity.
createdFromQuoteIdstring nullable
Unique identifier of the quote that this sales order was created from. Please reference /api/quotes endpoints.
customerIdstring required
The id of the customer that the sales order is for
deliveryDueDatestring date-time nullable
The date the SO needs to be delivered to the customer
productionDueDatestring date-time nullable
The date that production needs to be completed by
sentToProductionDateUtcstring date-time nullable
The datetime in UTC that the SO status was updated to Send to Production
dropshipboolean
Indicates the order is dropshipped: fulfilled by shipping directly to the end customer.
dropshipCustomerPoNumberstring nullable
The end customer's purchase order number for a dropshipped order.
paymentTermsIdstring nullable
The payment terms assigned to this sales order.
discountnumber double nullable
Total discount for the SO when a Discount Line as been aded
subtotalnumber double
The sum of the line items this sales order bills, before tax, the discount and any refund are
applied. Child lines of a blanket-order line are excluded; the parent line carries the amount.
salesPersonIdstring nullable
Unique identifier of the sales person attached to this sales order.
Please reference /api/users endpoints.
publicNotestring nullable
Note to customer. This will appear on PDFs.
deletedboolean
Indicates whether this sales order has been deleted
deletedUtcstring date-time nullable
When this sales order was deleted (UTC), or null while it is live.
companyIdstring nullable
Company identifier. Please reference /api/companies endpoint.
createdUtcstring date-time required
Date this record was created (UTC).
modifiedUtcstring date-time nullable
Date this record was modified (UTC). Of note, this does account for children items (line items).
usesV3Shippingboolean
Indicate if this sales order uses V3 shipping.
status'draft' | 'needsApproval' | 'approved' | 'inProgress' | 'complete' required
priority'low' | 'moderate' | 'high'
Priority of the sales order
shipByDatestring date-time nullable
The date this sales order should ship by, as shown on the sales order in the app: the earliest ship by
date across the order's non-cancelled shipments, or, when no shipment has one, the earliest delivery
due date less the customer's shipping lead time.
externalReferencesobject nullable
External references associated with this entity.
customFieldsobject nullable
Custom fields that have been defined on this entity.