Skip to main content
POST
Create quote
The quote, its lines and the discounts of the lines are written in a single transaction: if anything 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, lines, status and sharing.

Calculations

How amounts and totals are calculated.
The API does not calculate line amounts, but it checks that they add up (5118); see calculations. The quote totals and AverageExchangeRate are filled from the lines. Send UnitPrice excluding VAT.
  • Send "Next" as QuoteNumber to generate the number from the number series of the quote type.
  • The quote is created with status 0 (pending).
  • A successful response returns 201 Created and the Location header points to the new quote.

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

QuoteType
integer<int32>
required

Required. 1: Purchase quote (received), 2: Sales quote (issued). Cannot be changed after the quote is created.

Example:

2

QuoteNumber
null | string
required

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

Example:

"TKL0000125"

Date
null | string<date-time>
required

Required. Quote date. The date part is stored as the quote date; if a time is sent it is stored as the quote 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).

Example:

"C-0001"

Lines
object[]
required

Required, at least one line. On update the lines are replaced: the quote'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.

RepresentativeName
null | string

Full name of a representative of the customer (RepresentativeName from GET /api/v1/customers/{customerId}/representatives). It must belong to the customer.

DueDays
integer<int32>

Payment term in days. Cannot be less than 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 quote. 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.

Example:

1350

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.