Retrieve Loan Transaction Template

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

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=disburseToSavings
loans/1/transactions/template?command=recoverypayment
loans/1/transactions/template?command=prepayLoan
loans/1/transactions/template?command=refundbycash
loans/1/transactions/template?command=refundbytransfer
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.