Retrieve a Loan

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

Returns one loan by id, with its status, terms and balances.

Note: template=true parameter doesn't apply to this resource.Example Requests:

loans/1

loans/1?fields=id,principal,annualInterestRate

loans/1?associations=all

loans/1?associations=all&exclude=guarantors

loans/1?fields=id,principal,annualInterestRate&associations=repaymentSchedule,transactions

Path parameters

loanIdpath · integer · int64 · required

loanId

Query parameters

staffInSelectedOfficeOnlyquery · boolean · optional

staffInSelectedOfficeOnly

associationsquery · string · optional

Loan object relations to be included in the response

excludequery · string · optional

Optional Loan object relation list to be filtered in the response

fieldsquery · string · optional

Optional Loan attribute list to be in the response

Responses

200OK

Response fields

accountNostring · optional

actualNoTerminteger · int32 · optional

allowFullTermForTrancheboolean · optional

Allow full term length for each tranche disbursement

amortizationTypeGetLoansLoanIdAmortizationType · optional

annualInterestRatenumber · optional

approvedPrincipalnumber · optional

buyDownFeeCalculationTypeStringEnumOptionData · optional

buyDownFeeIncomeTypeStringEnumOptionData · optional

buyDownFeeStrategyStringEnumOptionData · optional

capitalizedIncomeCalculationTypeStringEnumOptionData · optional

capitalizedIncomeStrategyStringEnumOptionData · optional

capitalizedIncomeTypeStringEnumOptionData · optional

chargeOffBehaviourStringEnumOptionData · optional

chargedOffboolean · optional

chargesarray of GetLoansLoanIdLoanChargeData · optional

Set of charges

clientExternalIdstring · optional

clientIdinteger · int64 · optional

clientNamestring · optional

clientOfficeIdinteger · int64 · optional

currencyGetLoansLoanIdCurrency · optional

currency

delinquencyRangeDelinquencyRangeData · optional

delinquentGetLoansLoanIdDelinquencySummary · optional

Delinquent data

disallowExpectedDisbursementsboolean · optional

disbursedAmountPercentageForDownPaymentnumber · optional

disbursementDetailsarray of GetLoansLoanIdDisbursementDetails · optional

Set of GetLoansLoanIdDisbursementDetails

emiAmountVariationsarray of GetLoansLoanIdLoanTermVariations · optional

List of GetLoansLoanIdLoanTermVariations

enableAutoRepaymentForDownPaymentboolean · optional

enableBuyDownFeeboolean · optional

enableDownPaymentboolean · optional

enableIncomeCapitalizationboolean · optional

enableInstallmentLevelDelinquencyboolean · optional

externalIdstring · optional

fixedLengthinteger · int32 · optional

fixedPrincipalPercentagePerInstallmentnumber · optional

fraudboolean · optional

graceOnArrearsAgeinginteger · int32 · optional

graceOnInterestChargedinteger · int32 · optional

graceOnInterestPaymentinteger · int32 · optional

graceOnPrincipalPaymentinteger · int32 · optional

idinteger · int64 · optional

inArrearsToleranceinteger · int32 · optional

interestCalculationPeriodTypeGetLoansLoanIdInterestCalculationPeriodType · optional

interestRateFrequencyTypeGetLoansLoanIdInterestRateFrequencyType · optional

interestRatePerPeriodnumber · optional

interestRecognitionOnDisbursementDateboolean · optional

interestTypeGetLoansLoanIdInterestType · optional

isFloatingInterestRateboolean · optional

lastClosedBusinessDatestring · date · optional

loanOfficerIdinteger · int64 · optional

loanOfficerNamestring · optional

loanProductDescriptionstring · optional

loanProductIdinteger · int64 · optional

loanProductNamestring · optional

loanPurposeIdinteger · int64 · optional

loanPurposeNamestring · optional

loanScheduleProcessingTypeEnumOptionData · optional

loanScheduleTypeEnumOptionData · optional

loanTermVariationsarray of GetLoansLoanIdLoanTermVariations · optional

List of GetLoansLoanIdLoanTermVariations

loanTypeGetLoansLoanIdLoanType · optional

netDisbursalAmountnumber · optional

numberOfRepaymentsinteger · int32 · optional

overpaidOnDatestring · date · optional

principalnumber · optional

proposedPrincipalnumber · optional

repaymentEveryinteger · int32 · optional

repaymentFrequencyTypeGetLoansLoanIdRepaymentFrequencyType · optional

repaymentScheduleGetLoansLoanIdRepaymentSchedule · optional

repaymentStartDateTypeEnumOptionData · optional

statusGetLoansLoanIdStatus · optional

summaryGetLoansLoanIdSummary · optional

termFrequencyinteger · int32 · optional

termPeriodFrequencyTypeGetLoansLoanIdTermPeriodFrequencyType · optional

timelineGetLoansLoanIdTimeline · optional

totalOverpaidnumber · optional

transactionProcessingStrategyCodestring · optional

transactionsarray of GetLoansLoanIdTransactions · optional

Set of GetLoansLoanIdTransactions

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