payback-plans
Operations addressed under /payback-plans — 7 operations.
get-payback-plan-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<PaybackPlanDto>.
| Field | Declared type | Nullable |
|---|---|---|
PaybackPlanNumber | string | no |
Amount | decimal | no |
InstallmentCount | int | no |
MonthlyRepaymentRate | decimal | no |
TotalPaymentAmount | decimal | no |
Irr | decimal | no |
Xirr | decimal | no |
EffectiveInterestRate | decimal | no |
CompoundInterestRate | decimal | no |
PaybackPlanMethod | int | no |
PostponedInstallmentCount | int | no |
DayDifferentInstallment | string | no |
DayInYearCount | string | no |
FirstInstallmentDate | DateOnly | no |
PaymentDate | DateOnly | no |
AverageMaturity | int | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-payback-plan-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
amountaverageMaturitycompoundInterestRatedayDifferentInstallmentdayInYearCounteffectiveInterestRatefirstInstallmentDateidinstallmentCountirrmonthlyRepaymentRatepaybackPlanMethodPermitted values — validated against the payback_plan_method parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
11 | Düzensiz ödemeli | en: Irregular Installment · tr: Düzensiz ödemeli |
2 | Eşit taksit tutarlı | en: Equal Installment · tr: Eşit Taksit Tutarlı |
4 | Değişken Faizli | en: Variable Interest · tr: Değişken Faizli |
10 | Balon Ödeme | en: Balloon Installment · tr: Balon Ödeme |
12 | Spot Loan | en: Spot Loan · tr: Spot Kredi |
paybackPlanNumberpaymentDatepostponedInstallmentCounttotalPaymentAmountxirrcreate-payback-plan
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status |
|---|---|
paybackplan_number_error | 400 |
create-payback-plan › Request Body
amountaverageMaturitycompoundInterestRatedayDifferentInstallmentdayInYearCounteffectiveInterestRatefirstInstallmentDateinstallmentCountirrmonthlyRepaymentRatepaybackPlanMethodPermitted values — validated against the payback_plan_method parameter.
| Value | Meaning |
|---|---|
11 | Irregular Installment |
2 | Equal Installment |
4 | Variable Interest |
10 | Balloon Installment |
12 | Spot Loan |
Permitted values — validated against the payback_plan_method parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
11 | Düzensiz ödemeli | en: Irregular Installment · tr: Düzensiz ödemeli |
2 | Eşit taksit tutarlı | en: Equal Installment · tr: Eşit Taksit Tutarlı |
4 | Değişken Faizli | en: Variable Interest · tr: Değişken Faizli |
10 | Balon Ödeme | en: Balloon Installment · tr: Balon Ödeme |
12 | Spot Loan | en: Spot Loan · tr: Spot Kredi |
paymentDatetotalPaymentAmountxirrpostponedInstallmentCountcreate-payback-plan › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
calculate-bullet-payback-plan
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as BasePaybackPlanDto.
| Field | Declared type | Nullable |
|---|---|---|
PaymentDate | DateOnly | no |
FirstInstallmentDate | DateOnly | no |
TotalPaymentAmount | decimal | no |
IRR | decimal | no |
XIRR | decimal | no |
EffectiveInterestRate | decimal | no |
CompoundInterestRate | decimal | no |
AverageMaturity | int | no |
Installments | List<BaseInstallment> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_PYBCKPLAN_21 | 400 | PAYBACK_PLAN_BULLET_PAYMENT_REMAININGAMOUNT_MUST_BE_BIGGER_THAN_ZERO | Remaining Amount Must Be Bigger Than Zero |
ERR_PYBCKPLAN_22 | 400 | PAYBACK_PLAN_BULLET_PAYMENT_REMAININGAMOUNT_INSTALLMENT_MUST_NOT_BE_EMPTY | Remaining Amount Installment Must Not Be Empty |
calculate-bullet-payback-plan › Request Body
oldPaybackPlanIdpaybackAmountpaybackDateamountdayDifferentInstallmentfirstInstallmentDateinstallmentCountmonthlyRepaymentRatepaybackProfitAmountpaymentDatepostponedInstallmentCountcalculate-bullet-payback-plan › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
calculate-variable-interest-payback-plan
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as BasePaybackPlanDto.
| Field | Declared type | Nullable |
|---|---|---|
PaymentDate | DateOnly | no |
FirstInstallmentDate | DateOnly | no |
TotalPaymentAmount | decimal | no |
IRR | decimal | no |
XIRR | decimal | no |
EffectiveInterestRate | decimal | no |
CompoundInterestRate | decimal | no |
AverageMaturity | int | no |
Installments | List<BaseInstallment> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_PYBCKPLAN_21 | 400 | PAYBACK_PLAN_BULLET_PAYMENT_REMAININGAMOUNT_MUST_BE_BIGGER_THAN_ZERO | Remaining Amount Must Be Bigger Than Zero |
ERR_PYBCKPLAN_22 | 400 | PAYBACK_PLAN_BULLET_PAYMENT_REMAININGAMOUNT_INSTALLMENT_MUST_NOT_BE_EMPTY | Remaining Amount Installment Must Not Be Empty |
calculate-variable-interest-payback-plan › Request Body
effectiveDateoldPaybackPlanIdamountdayDifferentInstallmentfirstInstallmentDateinstallmentCountmonthlyRepaymentRatepaymentDatepostponedInstallmentCountcalculate-variable-interest-payback-plan › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-payback-plan-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as PaybackPlanDto.
| Field | Declared type | Nullable |
|---|---|---|
PaybackPlanNumber | string | no |
Amount | decimal | no |
InstallmentCount | int | no |
MonthlyRepaymentRate | decimal | no |
TotalPaymentAmount | decimal | no |
Irr | decimal | no |
Xirr | decimal | no |
EffectiveInterestRate | decimal | no |
CompoundInterestRate | decimal | no |
PaybackPlanMethod | int | no |
PostponedInstallmentCount | int | no |
DayDifferentInstallment | string | no |
DayInYearCount | string | no |
FirstInstallmentDate | DateOnly | no |
PaymentDate | DateOnly | no |
AverageMaturity | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_PYBCKPLAN_3 | 400 | PAYBACK_PLAN_MUST_NOT_BE_NULL | Payback plan cannot be found. :{0}. |
path Parameters
idget-payback-plan-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
amountcompoundInterestRatedayDifferentInstallmentdayInYearCounteffectiveInterestRatefirstInstallmentDateidinstallmentCountirrmonthlyRepaymentRatepaybackPlanMethodPermitted values — validated against the payback_plan_method parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
11 | Düzensiz ödemeli | en: Irregular Installment · tr: Düzensiz ödemeli |
2 | Eşit taksit tutarlı | en: Equal Installment · tr: Eşit Taksit Tutarlı |
4 | Değişken Faizli | en: Variable Interest · tr: Değişken Faizli |
10 | Balon Ödeme | en: Balloon Installment · tr: Balon Ödeme |
12 | Spot Loan | en: Spot Loan · tr: Spot Kredi |
paybackPlanNumberpaymentDatepostponedInstallmentCounttotalPaymentAmountxirrget-payback-plan-details-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as PaybackPlanDetailsDto.
| Field | Declared type | Nullable |
|---|---|---|
Taxes | List<TaxDto> (collection) | no |
Installments | List<Installment> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_PYBCKPLAN_3 | 400 | PAYBACK_PLAN_MUST_NOT_BE_NULL | Payback plan cannot be found. :{0}. |
path Parameters
idget-payback-plan-details-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
amountaverageMaturitycompoundInterestRatedayDifferentInstallmentdayInYearCounteffectiveInterestRatefirstInstallmentDateidinstallmentCountirrmonthlyRepaymentRatepaybackPlanMethodPermitted values — validated against the payback_plan_method parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
11 | Düzensiz ödemeli | en: Irregular Installment · tr: Düzensiz ödemeli |
2 | Eşit taksit tutarlı | en: Equal Installment · tr: Eşit Taksit Tutarlı |
4 | Değişken Faizli | en: Variable Interest · tr: Değişken Faizli |
10 | Balon Ödeme | en: Balloon Installment · tr: Balon Ödeme |
12 | Spot Loan | en: Spot Loan · tr: Spot Kredi |
paybackPlanNumberpaymentDatepostponedInstallmentCounttotalPaymentAmountxirrget-payback-plan-tax-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<TaxDto>.
| Field | Declared type | Nullable |
|---|---|---|
TaxId | Guid | no |
FromProperty | string | no |
TaxRate | decimal | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_PYBCKPLAN_3 | 400 | PAYBACK_PLAN_MUST_NOT_BE_NULL | Payback plan cannot be found. :{0}. |
path Parameters
idget-payback-plan-tax-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
fromPropertyPermitted values — validated against the from_property_tax parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | profitAmount | no label seeded |
taxIdtaxRate