v2

latestOpenAPI 3.0.42026-08-084694591.6 MB

Sales Order

Create a new draft sales order

post/api/sales-orders

Request body

customerIdstring required

The id of the customer to be created

orderedDatestring date-time nullable

The ordered date of the sales order. For supplied values, only the calendar date is used, exactly as written; any time or UTC offset is ignored. If not supplied, defaults to the current UTC timestamp.

customerPoNumberstring nullable

Optional customer supplied purchase order number

externalReferencesobject nullable

Arbitrary key-value-pair like data that can be used to later on search for the Sales Order

externalQuoteUrlstring nullable

A reference URL that points to an external quote entity.

dueDatestring date-time nullable

The due date of the sales order. This indicates the expected date of completion. Only the calendar date is used, exactly as written; any time or UTC offset is ignored.

paymentTermsIdstring nullable

Payment terms key identifier. Please reference /api/payment-terms endpoint.

salesPersonIdstring nullable

Sales Person identifier. Please reference /api/users endpoint. If not provided, the salesperson defined on the customer will be used.

publicNotestring nullable

Note to customer. This will appear on PDFs.

priority'low' | 'moderate' | 'high'

Priority of the sales order

companyIdstring nullable

Company identifier. Please reference /api/companies endpoint. If not provided, the primary company will be used (if available).

productionDueDatestring date-time nullable

The date that the production of items on the sales order needs to be completed by. Only the calendar date is used, exactly as written; any time or UTC offset is ignored.

shippingMethodIdstring nullable

Shipping method identifier. Please reference /api/shipping-methods endpoint.

Response

Sales order created

idstring required

The id of the created record