Skip to main content
POST
Create product parameter definition
Name is required and must be unique within the company. Type decides the format of the Value field in product parameters, and can still be changed after creation:

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 for customer endpoints; if sent, it is written to created records.

Required range: x >= 1

Body

Name
null | string

Required. Parameter name, unique within the company. At most 255 characters.

Example:

"Malzeme"

Type
integer<int32>

Required. Value type: 0 Text, 1 Yes/No, 2 Integer, 3 Decimal, 4 Date, 5 Time, 6 Date and time.

Example:

0

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
Message
null | string

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