payback-plans
Operations addressed under /payback-plans — 6 operations.
aurax-bff-service-dynamic-calculate-generic-payback-plan
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target calculate-generic-payback-plan; this entry declares none of its own.
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_18 | 400 | PAYBACK_PLAN_INSTALLMENT_DATE_GREATER_THAN_PAYMENT_DATE | The installment dates cannot be less than the payment date. |
ERR_PYBCKPLAN_9 | 400 | PAYBACK_PLAN_COMPATIBLE_INSTALLMENT_COUNT_CONTROL | The number of installments in the installment array must be compatible with the installment count. |
aurax-bff-service-dynamic-calculate-generic-payback-plan › Request Body
amountdayDifferentInstallmentdayInYearCountinstallmentCountmonthlyRepaymentRatepaybackPlanMethodPermitted 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 |
paymentDateannualInterestRateexpenseAmountfirstInstallmentDatepostponedInstallmentCounttermInDaystotalExpenseAmountaurax-bff-service-dynamic-calculate-generic-payback-plan › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
aurax-bff-redirect-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.
aurax-bff-redirect-get-payback-plan-list › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-get-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
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-payback-plan-details-by-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.