Skip to main content
POST
Create order
The order, its lines and the discounts of the lines are written in a single transaction: if any of them is invalid, nothing is saved and all errors are returned in one Message. Line errors start with the line number, for example Line 2: Quantity must be greater than 0.

Field rules

Required fields, customer movement, approvals and status, lines.

Calculations

How amounts and totals are calculated.
The API does not calculate line amounts, but it checks that they add up (6120); see calculations. The order totals and AverageExchangeRate are filled from the lines, and the main unit quantity of each line is calculated by the API. Send UnitPrice excluding VAT.
  • If you send "Next" instead of OrderNumber, the number is generated from the number series of the order type.
  • With CreateCustomerMovement: true, the order amount is also written to the customer’s account (credit for a purchase order, debit for a sales order) in the same transaction. See customer movement.
  • The approvals required by the company’s approval definitions and the default order status are assigned automatically.
  • A successful response is 201 Created; the Location header points to the new order.

Minimal request

A request with only the required fields; the line amounts add up (the API checks them) and the header totals are filled from the lines. Replace the codes and names with those of your own company.

Error codes

Codes this endpoint can return. The general errors that apply to every endpoint (authentication, permissions, request headers, request limits) are not repeated here.

Authorizations

Authorization
string
header
required

Access token obtained from the Noyax auth service with your API key.

Headers

X-UserID
integer<int32>
required

ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.

Required range: x >= 1
X-CompanyID
integer<int32>
required

ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.

Required range: x >= 1
X-PeriodID
integer<int32>

ID of the accounting period. Optional; if sent, it is written to created records.

Required range: x >= 1

Body

OrderType
integer<int32>
required

Required. 1: Purchase order (placed with a supplier), 2: Sales order (received from a customer). Cannot be changed after the order is created.

Example:

2

OrderNumber
null | string
required

Required. Order number, unique within the company for the same OrderType. Send "Next" on create to generate it from the company's order number series for the type. At most 10 characters.

Example:

"SIP0000125"

Date
null | string<date-time>
required

Required. Order date. The date part is stored as the order date; if a time is sent it is stored as the order time, otherwise the current time is used.

Example:

"2026-09-21T10:30:00"

CustomerCode
null | string
required

Required. Customer code (the customer's CustomerCode from GET /api/v1/customers). The order is written with the customer's address: the invoice address when the customer has one, otherwise the first address.

Example:

"C-0001"

Lines
object[]
required

Required, at least one line. On update the lines are replaced: the order's existing lines are removed and these are saved instead.

DocumentNumber
null | string

Document number (free text). At most 20 characters.

Example:

"2026-15"

Description
null | string

Description. At most 1000 characters.

DueDays
integer<int32>

Payment term in days. Cannot be less than 0. When CreateCustomerMovement is true, the customer movement is due Date + DueDays (no due date when 0).

Example:

30

DeliveryDate
null | string<date>

Delivery date. Date only (yyyy-MM-dd), no time part.

Example:

"2026-10-15"

SharingCode
null | string

Sharing code that limits who can see the order. Empty means visible to everyone; otherwise it must be one of the user's sharing codes.

DiscountTotal
number<double>

Total discount: the sum of the lines' DiscountAmount. Filled from the lines; a value sent in the request is ignored.

Example:

100

SubTotal
number<double>

Subtotal: the sum of the lines' AmountExcludingTax. Filled from the lines; a value sent in the request is ignored.

Example:

900

VatTotal
number<double>

Total VAT after withholding: the sum of the lines' VatAmount minus WithholdingTotal. Filled from the lines; a value sent in the request is ignored.

Example:

225

AdditionalTaxTotal
number<double>

Total additional tax: the sum of the lines' additional tax amounts. Filled from the lines; a value sent in the request is ignored.

Example:

225

WithholdingTotal
number<double>

Total withheld VAT: the sum of the lines' WithheldVatAmount. Filled from the lines; a value sent in the request is ignored.

Example:

0

GrandTotal
number<double>

Grand total: the sum of the lines' AmountIncludingTax minus WithholdingTotal. Filled from the lines; a value sent in the request is ignored. When CreateCustomerMovement is true, it is the amount of the customer movement.

Example:

1350

CreateCustomerMovement
boolean

Whether the order has a customer movement. When true, a purchase order creates a credit (alacak) and a sales order creates a debit (borç) movement on the customer for GrandTotal, kept in sync on every update. When false the order has no customer movement; on update, false removes an existing movement. Movements that were already closed by a collection or payment cannot be changed or removed.

Example:

true

AverageExchangeRate
number<double>

Weighted average exchange rate: when every line has the same currency, Σ(AmountExcludingTax × ExchangeRate) / Σ AmountExcludingTax; when the lines have different currencies, 1, and the totals are converted to the default currency with each line's ExchangeRate. Filled from the lines; a value sent in the request is ignored.

Example:

1

Response

Created

Success
boolean
required

Whether the operation succeeded.

Example:

true

ResultCode
string
required

"0000" on success. On failure, the code of the first error; all errors are listed in Errors.

Example:

"0000"

Data
object
required

Response data. Null when Success is false.

Message
null | string

Error message when Success is false. Messages of all errors are joined into a single text.