Preview Re-Age Schedule

GET/lokta-lms/api/v1/loans/{loanId}/transactions/reage-preview

Generates a preview of the re-aged loan schedule based on the provided parameters without creating any transactions or modifying the loan.

Path parameters

loanIdpath · integer · int64 · required

loanId

Query parameters

frequencyNumberquery · integer · int32 · required

The frequency number for the re-aging schedule

frequencyTypequery · string · required

The frequency type (DAYS, WEEKS, MONTHS, YEARS)

startDatequery · string · required

The start date for the re-aging schedule

numberOfInstallmentsquery · integer · int32 · required

The number of installments for the re-aged loan

dateFormatquery · string · required

The date format used for the startDate parameter

localequery · string · required

The locale to use for formatting

reAgeInterestHandlingquery · string · optional

The interest handling type. Applied only for progressive interest-bearing loans. DEFAULT if not provided.

Responses

defaultdefault response

Response fields

currencyCurrencyData · optional

futurePeriodsarray of LoanSchedulePeriodData · optional

loanTermInDaysinteger · int32 · optional

periodsarray of LoanSchedulePeriodData · optional

totalCreditsnumber · optional

totalFeeChargesChargednumber · optional

totalInterestChargednumber · optional

totalOutstandingnumber · optional

totalPaidInAdvancenumber · optional

totalPaidLatenumber · optional

totalPenaltyChargesChargednumber · optional

totalPrincipalDisbursednumber · optional

totalPrincipalExpectednumber · optional

totalPrincipalPaidnumber · optional

totalRepaymentnumber · optional

totalRepaymentExpectednumber · optional

totalWaivednumber · optional

totalWrittenOffnumber · optional

Every request authenticates with HTTP Basic and carries a Tenant-Identifier header. See the conventions for dates, commands, pagination and errors. Open this operation in the interactive explorer, or read it as Markdown.

curl -X GET \ 'http://localhost:8080/lokta-lms/api/v1/loans/{loanId}/transactions/reage-preview?frequencyNumber={frequencyNumber}&frequencyType={frequencyType}&startDate={startDate}&numberOfInstallments={numberOfInstallments}&dateFormat={dateFormat}&locale={locale}' \ -u '{username}:{password}' \ -H 'Tenant-Identifier: default'

import requests response = requests.get( "http://localhost:8080/lokta-lms/api/v1/loans/{loanId}/transactions/reage-preview?frequencyNumber={frequencyNumber}&frequencyType={frequencyType}&startDate={startDate}&numberOfInstallments={numberOfInstallments}&dateFormat={dateFormat}&locale={locale}", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, ) print(response.json())

const response = await fetch("http://localhost:8080/lokta-lms/api/v1/loans/{loanId}/transactions/reage-preview?frequencyNumber={frequencyNumber}&frequencyType={frequencyType}&startDate={startDate}&numberOfInstallments={numberOfInstallments}&dateFormat={dateFormat}&locale={locale}", { method: "GET", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", }, }); console.log(await response.json());

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("http://localhost:8080/lokta-lms/api/v1/loans/{loanId}/transactions/reage-preview?frequencyNumber={frequencyNumber}&frequencyType={frequencyType}&startDate={startDate}&numberOfInstallments={numberOfInstallments}&dateFormat={dateFormat}&locale={locale}")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

req, _ := http.NewRequest("GET", "http://localhost:8080/lokta-lms/api/v1/loans/{loanId}/transactions/reage-preview?frequencyNumber={frequencyNumber}&frequencyType={frequencyType}&startDate={startDate}&numberOfInstallments={numberOfInstallments}&dateFormat={dateFormat}&locale={locale}", nil) req.SetBasicAuth("{username}", "{password}") req.Header.Set("Tenant-Identifier", "default") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(string(data))

{ "currency": { "code": "string", "decimalPlaces": 1, "displayLabel": "string", "displaySymbol": "string" }, "futurePeriods": [ {} ], "loanTermInDays": 1, "periods": [ {} ] }