Create repayment plan
curl --request POST \
--url https://api.noyax.com/api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Name": "3 Taksit",
"DayCount": 90
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans");
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\": \"3 Taksit\",\n \"DayCount\": 90\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: '3 Taksit', DayCount: 90})
};
fetch('https://api.noyax.com/api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans"
payload = {
"Name": "3 Taksit",
"DayCount": 90
}
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": "3 Taksit",
"DayCount": 90,
"CommissionRates": [
{
"Name": "3 Taksit",
"Rate": 2.5,
"ExpenseCode": "MSR-0001"
}
]
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "8024",
"Message": "Repayment plans can only be added to a POS account (AccountType 3).",
"Errors": [
{
"Code": "8024",
"Message": "Repayment plans can only be added to a POS account (AccountType 3)."
}
]
}{
"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."
}
]
}Repayment plans
Create repayment plan
Adds a new repayment plan and its commission rates in one operation.
POST
/
api
/
v1
/
finance
/
bank-accounts
/
{bankAccountId}
/
repayment-plans
Create repayment plan
curl --request POST \
--url https://api.noyax.com/api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Name": "3 Taksit",
"DayCount": 90
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans");
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\": \"3 Taksit\",\n \"DayCount\": 90\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: '3 Taksit', DayCount: 90})
};
fetch('https://api.noyax.com/api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans"
payload = {
"Name": "3 Taksit",
"DayCount": 90
}
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": "3 Taksit",
"DayCount": 90,
"CommissionRates": [
{
"Name": "3 Taksit",
"Rate": 2.5,
"ExpenseCode": "MSR-0001"
}
]
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "8024",
"Message": "Repayment plans can only be added to a POS account (AccountType 3).",
"Errors": [
{
"Code": "8024",
"Message": "Repayment plans can only be added to a POS account (AccountType 3)."
}
]
}{
"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."
}
]
}- The bank account’s
AccountTypemust be 3 (POS account), otherwise the request is rejected. Nameis required and must be unique within the bank account.DayCountcannot be negative.CommissionRatesis optional; each entry requiresName(unique within the plan),Rate(percentage, 0-100) andExpenseCode(the code of a product with ProductType 6/Expense). Commission rates are written in the same transaction as the plan.
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) |
0580 | 400 | A value given as text (a code or a name) matches more than one record; add the detail that tells them apart (for example City for a district, Country for a city) |
8010 | 404 | Bank account not found |
8021 | 400 | Repayment plan Name is required |
8022 | 400 | The repayment plan name is already used in this bank account; the response carries the existing record’s ID as ExistingId |
8023 | 400 | DayCount cannot be negative |
8024 | 400 | A repayment plan can only be added to a POS account (AccountType 3) |
8031 | 400 | Commission rate Name is required |
8032 | 400 | The commission rate name is used more than once in the same repayment plan |
8033 | 400 | Rate must be between 0 and 100 |
8034 | 400 | ExpenseCode is required |
8035 | 400 | ExpenseCode was not found |
Authorizations
Headers
Body
application/jsontext/jsonapplication/*+json
Response
Created