Skip to main content
POST
Create repayment plan
  • The bank account’s AccountType must be 3 (POS account), otherwise the request is rejected.
  • Name is required and must be unique within the bank account.
  • DayCount cannot be negative.
  • CommissionRates is optional; each entry requires Name (unique within the plan), Rate (percentage, 0-100) and ExpenseCode (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, daily limit) 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 for customer endpoints; if sent, it is written to created records.

Required range: x >= 1

Path Parameters

bankAccountId
string<uuid>
required

Bank account ID.

Body

Name
null | string

Required. Unique within the bank account. At most 100 characters.

Example:

"3 Taksit"

DayCount
integer<int32>

Required. Number of days, cannot be negative.

Example:

90

CommissionRates
object[]

Commission rates of this repayment plan. On update this list fully replaces the existing ones.

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.