Skip to main content
GET
Returns an empty sales order with default values without persisting it. This is equivalent to opening a new sales order dialog in the UI.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Response

An empty sales order with default values.

itemDescriptionType
enum<integer>
required

The default item description type from global settings.

Available options:
0,
1,
2
readOnlyType
enum<integer>
required

The default read-only type.

Available options:
0,
1,
2
companyId
string<uuid>
required

The company ID the sales order is initialized for.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

languageId
string<uuid>
required

The default language ID.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

additionalWeight
number<decimal>
required

The default additional weight from global settings.

specialTaxTreatment
enum<integer>
required

The special tax treatment setting.

Available options:
0,
1,
2,
3
taxSetting
enum<integer>
required

The tax setting.

Available options:
0,
10,
15,
20
departureCountry
object
required

The departure country information.

paymentDetails
object
required

The payment details.

billingAddress
object
required

The initialized empty billing address.

shipmentAddress
object
required

The initialized empty shipment address.

salesOrderDate
string<date-time>

The default sales order date (current date/time).

vatId
string

The VAT ID of the company.