Retrieve Loan Transaction Template

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

Returns the field defaults and allowed values for a transaction on a loan, for the command you name.

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:

Field Defaults
Allowed Value Lists

Example Requests:

loans/1/transactions/template?command=repaymentloans/1/transactions/template?command=merchantIssuedRefundloans/1/transactions/template?command=payoutRefundloans/1/transactions/template?command=goodwillCredit
loans/1/transactions/template?command=waiveinterest
loans/1/transactions/template?command=writeoff
loans/1/transactions/template?command=close-rescheduled
loans/1/transactions/template?command=close
loans/1/transactions/template?command=disburse
loans/1/transactions/template?command=recoverypayment
loans/1/transactions/template?command=prepayLoan
loans/1/transactions/template?command=refundbycash
loans/1/transactions/template?command=foreclosure
loans/1/transactions/template?command=interestPaymentWaiver
loans/1/transactions/template?command=creditBalanceRefund (returned 'amount' field will have the overpaid value)
loans/1/transactions/template?command=charge-off
loans/1/transactions/template?command=downPayment
loans/1/transactions/template?command=interest-refund

Path parameters

loanIdpath · integer · int64 · required

loanId

Query parameters

commandquery · string · optional

command

dateFormatquery · string · optional

dateFormat

transactionDatequery · object · optional

transactionDate

localequery · string · optional

locale

transactionIdquery · integer · int64 · optional

transactionId

Responses

200OK

Response fields

amountnumber · double · optional

chargeOffReasonOptionsarray of GetLoanProductsChargeOffReasonOptions · optional

classificationOptionsarray of GetCodeValuesDataResponse · optional

currencyGetLoanCurrency · optional

datestring · date · optional

feeChargesPortionnumber · double · optional

interestPortionnumber · double · optional

netDisbursalAmountnumber · double · optional

paymentTypeOptionsarray of GetPaymentTypeOptions · optional

penaltyChargesPortionnumber · double · optional

principalPortionnumber · double · optional

totalGetLoansTotal · optional

typeGetLoansTransactionType · 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.

This is the API reference for Lokta, the agentic loan servicing platform. Go to lokta.ai

import requests response = requests.get( "https://default.lokta.tech/lokta-lms/api/v1/loans/{loanId}/transactions/template", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, ) print(response.json())

const response = await fetch("https://default.lokta.tech/lokta-lms/api/v1/loans/{loanId}/transactions/template", { 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("https://default.lokta.tech/lokta-lms/api/v1/loans/{loanId}/transactions/template")) .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", "https://default.lokta.tech/lokta-lms/api/v1/loans/{loanId}/transactions/template", 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))

{ "amount": 200, "chargeOffReasonOptions": [ {} ], "classificationOptions": [ {} ], "currency": { "code": "UGX", "decimalPlaces": 2, "displayLabel": "Uganda Shilling (USh)", "displaySymbol": "USh" } }