Calculate loan repayment schedule | Submit a new Loan Application

POST/lokta-lms/api/v1/loans

It calculates the loan repayment Schedule
Submits a new loan application
Mandatory Fields: clientId, productId, principal, loanTermFrequency, loanTermFrequencyType, loanType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, transactionProcessingStrategyCode, expectedDisbursementDate, submittedOnDate, loanType
Optional Fields: graceOnPrincipalPayment, graceOnInterestPayment, graceOnInterestCharged, linkAccountId, allowPartialPeriodInterestCalculation, fixedEmiAmount, maxOutstandingLoanBalance, disbursementData, graceOnArrearsAgeing, createStandingInstructionAtDisbursement (requires linkedAccountId if set to true)
Additional Mandatory Fields if interest recalculation is enabled for product and Rest frequency not same as repayment period: recalculationRestFrequencyDate
Additional Mandatory Fields if interest recalculation with interest/fee compounding is enabled for product and compounding frequency not same as repayment period: recalculationCompoundingFrequencyDate
Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type loan: datatables

Query parameters

commandquery · string · optional

command

Request body application/json

allowFullTermForTrancheboolean · optional

Allow full term length for each tranche disbursement

amortizationTypeinteger · int32 · optional

buyDownFeeCalculationTypestring · optional

One of: FLAT

buyDownFeeIncomeTypestring · optional

One of: FEE, INTEREST

buyDownFeeStrategystring · optional

One of: EQUAL_AMORTIZATION

capitalizedIncomeCalculationTypestring · optional

One of: FLAT

capitalizedIncomeStrategystring · optional

One of: EQUAL_AMORTIZATION

capitalizedIncomeTypeStringEnumOptionData · optional

chargesarray of PostLoansRequestChargeData · optional

clientIdinteger · int64 · optional

datatablesarray of PostLoansDataTable · optional

dateFormatstring · optional

daysInYearCustomStrategystring · optional

One of: FULL_LEAP_YEAR, FEB_29_PERIOD_ONLY

daysInYearTypeinteger · int32 · optional

disbursedAmountPercentageForDownPaymentnumber · optional

disbursementDataarray of PostLoansDisbursementData · optional

List of PostLoansDisbursementData

enableAutoRepaymentForDownPaymentboolean · optional

enableBuyDownFeeboolean · optional

enableDownPaymentboolean · optional

enableIncomeCapitalizationboolean · optional

enableInstallmentLevelDelinquencyboolean · optional

expectedDisbursementDatestring · optional

externalIdstring · optional

fixedEmiAmountnumber · optional

fixedLengthinteger · int32 · optional

fixedPrincipalPercentagePerInstallmentnumber · optional

graceOnArrearsAgeinginteger · int32 · optional

graceOnInterestChargedinteger · int32 · optional

graceOnInterestPaymentinteger · int32 · optional

graceOnPrincipalPaymentinteger · int32 · optional

inArrearsTolerancenumber · optional

interestCalculationPeriodTypeinteger · int32 · optional

interestRateFrequencyTypeinteger · int32 · optional

interestRatePerPeriodnumber · optional

interestRecognitionOnDisbursementDateboolean · optional

interestTypeinteger · int32 · optional

linkAccountIdinteger · int64 · optional

loanScheduleProcessingTypestring · optional

loanTermFrequencyinteger · int32 · optional

loanTermFrequencyTypeinteger · int32 · optional

loanTypestring · optional

localestring · optional

maxOutstandingLoanBalancenumber · optional

Maximum allowed outstanding balance

numberOfRepaymentsinteger · int32 · optional

originatorsarray of PostLoansOriginatorData · optional

Optional array of originators to associate with this loan. Each entry can reference an existing originator by 'id' or 'externalId'. If the global config 'enable_originator_creation_during_loan_application' is enabled, non-existing originators will be auto-created using the provided details (name, typeId, channelTypeId).

principalnumber · optional

productIdinteger · int64 · optional

repaymentEveryinteger · int32 · optional

repaymentFrequencyTypeinteger · int32 · optional

repaymentStartDateTypeinteger · int32 · optional

repaymentsStartingFromDatestring · date · optional

submittedOnDatestring · optional

transactionProcessingStrategyCodestring · optional

Responses

200OK

Response fields

clientIdinteger · int64 · optional

currencyGetLoansLoanIdCurrency · optional

currency

loanIdinteger · int64 · optional

loanTermInDaysinteger · int32 · optional

officeIdinteger · int64 · optional

periodsarray of PostLoansRepaymentSchedulePeriods · optional

resourceExternalIdstring · optional

resourceIdinteger · int64 · optional

totalFeeChargesChargedinteger · int64 · optional

totalInterestChargednumber · optional

totalOutstandinginteger · int64 · optional

totalPenaltyChargesChargedinteger · int64 · optional

totalPrincipalDisbursedinteger · int64 · optional

totalPrincipalExpectedinteger · int64 · optional

totalPrincipalPaidinteger · int64 · optional

totalRepaymentinteger · int64 · optional

totalRepaymentExpectednumber · optional

totalWaivedinteger · int64 · optional

totalWrittenOffinteger · int64 · 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.