Create order

post

https://api.isx-stage-westeurope.instellix.io/v2/orders

Creates a new Order, for more information visit https://docs.nitrobox.io/docs/order-management-1

Body Params

agreedDeposits

array of objects

Agreed deposits on order.

agreedDeposits

allowances

array of objects

A list of allowances included in the order. Please see Allowance Model for more details

allowances

autoCreateDocument

string

enum

Defaults to INVOICE

deprecated

DEPRECATED. The type of document that is automatically generated at order creation. Will be one of:

Allowed:

billingTime

string

enum

Defaults to IMMEDIATELY

It defines billing time, when an invoice should be triggered. Defaults to Immediately.

Allowed:

businessSegmentIdent

string

Reference to the business segment of the order. Default business segment will be used if not specified.

debtorOrderDetails

required

language

string

enum

Defaults to de

The language of the order. Should be in ISO 639-1 ('de') format and if given must match to the used Business Segment.

lineItems

array of objects

A list of line items included in the order. Please see Line Item Model for more details

lineItems

orderDate

date-time

The date of the order.

orderIdent

string

required

length between 1 and 100

Unique external reference. Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'. Must be unique.

paymentInformation

object

A request to specify payment-related details.

paymentTerm

object

Specifies a payment term.

properties

array of objects

Additional order properties

properties

Responses

Language

Credentials

OAuth2

Response

Choose an example:

application/json

201The request has been fulfilled, resulting in the creation of a new resource.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX