Create currency
curl --request POST \
--url https://api.noyax.com/api/v1/definitions/currencies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Name": "TÜRK LİRASI",
"Code": "TRY"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/definitions/currencies");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"Name\": \"TÜRK LİRASI\",\n \"Code\": \"TRY\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'POST',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({Name: 'TÜRK LİRASI', Code: 'TRY'})
};
fetch('https://api.noyax.com/api/v1/definitions/currencies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/definitions/currencies"
payload = {
"Name": "TÜRK LİRASI",
"Code": "TRY"
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Name": "TÜRK LİRASI",
"Code": "TRY",
"SubunitName": "KURUŞ",
"IsDefault": true
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "0543",
"Message": "Currency Code is required.",
"Errors": [
{
"Code": "0543",
"Message": "Currency Code is required."
}
]
}{
"Success": false,
"ResultCode": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token.",
"Errors": [
{
"Code": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token."
}
]
}{
"Success": false,
"ResultCode": "0110",
"Message": "You do not have permission for this operation.",
"Errors": [
{
"Code": "0110",
"Message": "You do not have permission for this operation."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Currencies
Create currency
Adds a currency.
POST
/
api
/
v1
/
definitions
/
currencies
Create currency
curl --request POST \
--url https://api.noyax.com/api/v1/definitions/currencies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Name": "TÜRK LİRASI",
"Code": "TRY"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/definitions/currencies");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"Name\": \"TÜRK LİRASI\",\n \"Code\": \"TRY\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'POST',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({Name: 'TÜRK LİRASI', Code: 'TRY'})
};
fetch('https://api.noyax.com/api/v1/definitions/currencies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/definitions/currencies"
payload = {
"Name": "TÜRK LİRASI",
"Code": "TRY"
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Name": "TÜRK LİRASI",
"Code": "TRY",
"SubunitName": "KURUŞ",
"IsDefault": true
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "0543",
"Message": "Currency Code is required.",
"Errors": [
{
"Code": "0543",
"Message": "Currency Code is required."
}
]
}{
"Success": false,
"ResultCode": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token.",
"Errors": [
{
"Code": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token."
}
]
}{
"Success": false,
"ResultCode": "0110",
"Message": "You do not have permission for this operation.",
"Errors": [
{
"Code": "0110",
"Message": "You do not have permission for this operation."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}NameandCodeare required and must be unique within the company.Codeis at most 5 characters.SubunitNameis the name of the currency subunit (e.g.KURUŞ) and is optional.- If
IsDefaultistrue, the previous default currency loses the flag; a company has at most one default currency.
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.| Code | HTTP | Meaning |
|---|---|---|
0002 | 400 | Request body could not be read (malformed JSON, wrong field type), or it contains a field the endpoint does not have |
0003 | 400 | A field exceeds its maximum length (the message names the field and the limit) |
0541 | 400 | Currency Name is required |
0542 | 400 | The currency name is already used in the company; the response carries the existing record’s ID as ExistingId |
0543 | 400 | Currency Code is required |
0544 | 400 | The currency code is already used in the company; the response carries the existing record’s ID as ExistingId |
Authorizations
Headers
Body
application/jsontext/jsonapplication/*+json
Response
Created