loans--payback-plans
Operations addressed under /loans — 79 operations.
Rendered section: This page contains the payback-plans route group from loans. This is a presentation-only partition; it does not change the API contract or operation tags in the downloadable OpenAPI.
create-loan-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 | Meaning |
|---|---|---|
ERR_LOAN_13 | 400 | LOAN_PAYBACK_PLAN_IS_NOT_FOUND |
ERR_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL |
path Parameters
idcreate-loan-payback-plan › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-loan-payback-plan-tax-list-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 IEnumerable<LoanPaybackPlanTaxDto>.
| Field | Declared type | Nullable |
|---|---|---|
TaxId | Guid | no |
TaxRate | decimal | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_LOAN_13 | 400 | LOAN_PAYBACK_PLAN_IS_NOT_FOUND |
ERR_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL |
path Parameters
idloanPaybackPlanIdget-loan-payback-plan-tax-list-by-id › 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.
idtaxIdtaxRateupdate-loan-paybackplan-installment-detail
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_105 | 400 | LOAN_INSTALLMENT_DETAIL_AMOUNT_CONTROL | Loan installment detail amount cannot be less than 0 |
ERR_LOAN_13 | 400 | LOAN_PAYBACK_PLAN_IS_NOT_FOUND | not published in this snapshot |
ERR_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL | not published in this snapshot |
ERR_LOAN_30 | 400 | LOAN_INSTALLMENT_MUST_NOT_BE_NULL | Installment cannot be found. :{0} |
path Parameters
idpaybackPlanIdinstallmentIdupdate-loan-paybackplan-installment-detail › 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.
create-loan-paybackplan-installment-detail
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_104 | 400 | LOAN_INSTALLMENT_DETAIL_COLLECTION_TYPE_ALREADY_EXISTS | The specified loan installment detail collection type already exists. |
ERR_LOAN_105 | 400 | LOAN_INSTALLMENT_DETAIL_AMOUNT_CONTROL | Loan installment detail amount cannot be less than 0 |
ERR_LOAN_13 | 400 | LOAN_PAYBACK_PLAN_IS_NOT_FOUND | not published in this snapshot |
ERR_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL | not published in this snapshot |
ERR_LOAN_30 | 400 | LOAN_INSTALLMENT_MUST_NOT_BE_NULL | Installment cannot be found. :{0} |
path Parameters
idpaybackPlanIdinstallmentIdcreate-loan-paybackplan-installment-detail › 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.
update-loan-paybackplan-installment-detail-remaining-amount
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_105 | 400 | LOAN_INSTALLMENT_DETAIL_AMOUNT_CONTROL | Loan installment detail amount cannot be less than 0 |
ERR_LOAN_13 | 400 | LOAN_PAYBACK_PLAN_IS_NOT_FOUND | not published in this snapshot |
ERR_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL | not published in this snapshot |
ERR_LOAN_30 | 400 | LOAN_INSTALLMENT_MUST_NOT_BE_NULL | Installment cannot be found. :{0} |
path Parameters
idpaybackPlanIdinstallmentIdupdate-loan-paybackplan-installment-detail-remaining-amount › 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.
update-loan-payback-plan-status
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_LOAN_13 | 400 | LOAN_PAYBACK_PLAN_IS_NOT_FOUND |
ERR_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL |
path Parameters
idpaybackPlanIdupdate-loan-payback-plan-status › 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.