Create a Loan Product
/lokta-lms/api/v1/loanproductsDepending of the Accounting Rule (accountingRule) selected, additional fields with details of the appropriate Ledger Account identifiers would need to be passed in.
Refer the accounting specification for more details regarding the significance of the selected accounting rule
Mandatory Fields: name, shortName, currencyCode, digitsAfterDecimal, inMultiplesOf, principal, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, interestRateFrequencyType, amortizationType, interestType, interestCalculationPeriodType, transactionProcessingStrategyCode, accountingRule, isInterestRecalculationEnabled, daysInYearType, daysInMonthType
Optional Fields: inArrearsTolerance, graceOnPrincipalPayment, graceOnInterestPayment, graceOnInterestCharged, graceOnArrearsAgeing, charges, paymentChannelToFundSourceMappings, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, chargeOffReasonToExpenseAccountMappings, includeInBorrowerCycle, useBorrowerCycle,principalVariationsForBorrowerCycle, numberOfRepaymentVariationsForBorrowerCycle, interestRateVariationsForBorrowerCycle, multiDisburseLoan,maxTrancheCount, outstandingLoanBalance,overdueDaysForNPA,holdGuaranteeFunds, principalThresholdForLastInstalment, accountMovesOutOfNPAOnlyOnArrearsCompletion, canDefineInstallmentAmount, installmentAmountInMultiplesOf, allowAttributeOverrides, allowPartialPeriodInterestCalculation,dueDaysForRepaymentEvent,overDueDaysForRepaymentEvent,enableDownPayment,disbursedAmountPercentageDownPayment,enableAutoRepaymentForDownPayment,repaymentStartDateType,enableBuyDownFee
Additional Mandatory Fields for Cash(2) based accounting: fundSourceAccountId, loanPortfolioAccountId, interestOnLoanAccountId, incomeFromFeeAccountId, incomeFromPenaltyAccountId, writeOffAccountId, transfersInSuspenseAccountId, overpaymentLiabilityAccountId
Additional Mandatory Fields for periodic (3) and upfront (4)accrual accounting: fundSourceAccountId, loanPortfolioAccountId, interestOnLoanAccountId, incomeFromFeeAccountId, incomeFromPenaltyAccountId, writeOffAccountId, receivableInterestAccountId, receivableFeeAccountId, receivablePenaltyAccountId, transfersInSuspenseAccountId, overpaymentLiabilityAccountId
Additional Mandatory Fields if interest recalculation is enabled(true): interestRecalculationCompoundingMethod, rescheduleStrategyMethod, recalculationRestFrequencyType
Additional Optional Fields if interest recalculation is enabled(true): isArrearsBasedOnOriginalSchedule, preClosureInterestCalculationStrategy
Additional Optional Fields if interest recalculation is enabled(true) and recalculationRestFrequencyType is not same as repayment period: recalculationRestFrequencyInterval, recalculationRestFrequencyDate
Additional Optional Fields if interest recalculation is enabled(true) and interestRecalculationCompoundingMethod is enabled: recalculationCompoundingFrequencyType
Additional Optional Fields if interest recalculation is enabled(true) and interestRecalculationCompoundingMethod is enabled and recalculationCompoundingFrequencyType is not same as repayment period: recalculationCompoundingFrequencyInterval, recalculationCompoundingFrequencyDate
Additional Mandatory Fields if Hold Guarantee funds is enabled(true): mandatoryGuarantee
Additional Optional Fields if Hold Guarantee funds is enabled(true): minimumGuaranteeFromOwnFunds,minimumGuaranteeFromGuarantor
Request body application/json
accountMovesOutOfNPAOnlyOnArrearsCompletionboolean · optionalaccountingRuleinteger · int32 · optionalallowApprovedDisbursedAmountsOverAppliedboolean · optionalallowAttributeOverridesAllowAttributeOverrides · optionalallowCompoundingOnEodboolean · optionalallowFullTermForTrancheboolean · optionalAllow full term length for each tranche disbursement. Only available for PROGRESSIVE schedule type with multi-disbursement enabled.
allowPartialPeriodInterestCalculationboolean · optionalallowVariableInstallmentsboolean · optionalamortizationTypeinteger · int32 · optionalbuyDownExpenseAccountIdinteger · int64 · optionalbuyDownFeeCalculationTypestring · optionalFLATbuyDownFeeIncomeTypestring · optionalFEE, INTERESTbuyDownFeeStrategystring · optionalEQUAL_AMORTIZATIONbuydownfeeClassificationToIncomeAccountMappingsarray of PostClassificationToIncomeAccountMappings · optionalcanDefineInstallmentAmountboolean · optionalcanUseForTopupboolean · optionalcapitalizedIncomeCalculationTypestring · optionalFLATcapitalizedIncomeClassificationToIncomeAccountMappingsarray of PostClassificationToIncomeAccountMappings · optionalcapitalizedIncomeStrategystring · optionalEQUAL_AMORTIZATIONcapitalizedIncomeTypestring · optionalFEE, INTERESTchargeOffBehaviourstring · optionalchargeOffExpenseAccountIdinteger · int64 · optionalchargeOffFraudExpenseAccountIdinteger · int64 · optionalchargeOffReasonToExpenseAccountMappingsarray of PostChargeOffReasonToExpenseAccountMappings · optionalchargesarray of LoanProductChargeData · optionalcloseDatestring · optionalcreditAllocationarray of CreditAllocationData · optionalcurrencyCodestring · optionaldateFormatstring · optionaldaysInMonthTypeinteger · int32 · optionaldaysInYearCustomStrategystring · optionaldaysInYearTypeinteger · int32 · optionaldeferredFeeIncomeAccountIdinteger · int64 · optionaldeferredIncomeLiabilityAccountIdinteger · int64 · optionaldelinquencyBucketIdinteger · int64 · optionaldescriptionstring · optionaldigitsAfterDecimalinteger · int32 · optionaldisallowExpectedDisbursementsboolean · optionaldisallowInterestCalculationOnPastDueboolean · optionaldisbursedAmountPercentageForDownPaymentnumber · optionaldueDaysForRepaymentEventinteger · int32 · optionalenableAccrualActivityPostingboolean · optionalenableAutoRepaymentForDownPaymentboolean · optionalenableBuyDownFeeboolean · optionalenableDownPaymentboolean · optionalenableIncomeCapitalizationboolean · optionalenableInstallmentLevelDelinquencyboolean · optionalexternalIdstring · optionalfeeToIncomeAccountMappingsarray of LoanProductChargeToGLAccountMapper · optionalfixedLengthinteger · int32 · optionalfixedPrincipalPercentagePerInstallmentnumber · optionalfundIdinteger · int64 · optionalfundSourceAccountIdinteger · int64 · optionalgoodwillCreditAccountIdinteger · int64 · optionalgraceOnArrearsAgeinginteger · int32 · optionalgraceOnInterestPaymentinteger · int32 · optionalgraceOnPrincipalPaymentinteger · int32 · optionalholdGuaranteeFundsboolean · optionalinArrearsToleranceinteger · int32 · optionalinMultiplesOfinteger · int32 · optionalincludeInBorrowerCycleboolean · optionalincomeFromBuyDownAccountIdinteger · int64 · optionalincomeFromCapitalizationAccountIdinteger · int64 · optionalincomeFromChargeOffFeesAccountIdinteger · int64 · optionalincomeFromChargeOffInterestAccountIdinteger · int64 · optionalincomeFromChargeOffPenaltyAccountIdinteger · int64 · optionalincomeFromFeeAccountIdinteger · int64 · optionalincomeFromGoodwillCreditFeesAccountIdinteger · int64 · optionalincomeFromGoodwillCreditInterestAccountIdinteger · int64 · optionalincomeFromGoodwillCreditPenaltyAccountIdinteger · int64 · optionalincomeFromPenaltyAccountIdinteger · int64 · optionalincomeFromRecoveryAccountIdinteger · int64 · optionalinstallmentAmountInMultiplesOfinteger · int32 · optionalinterestCalculationPeriodTypeinteger · int32 · optionalinterestOnLoanAccountIdinteger · int64 · optionalinterestRateFrequencyTypeinteger · int32 · optionalinterestRatePerPeriodnumber · double · optionalinterestRateVariationsForBorrowerCyclearray · optionalinterestRecalculationCompoundingMethodinteger · int32 · optionalinterestRecognitionOnDisbursementDateboolean · optionalinterestTypeinteger · int32 · optionalisArrearsBasedOnOriginalScheduleboolean · optionalisCompoundingToBePostedAsTransactionboolean · optionalisEqualAmortizationboolean · optionalisInterestRecalculationEnabledboolean · optionalisLinkedToFloatingInterestRatesboolean · optionalloanPortfolioAccountIdinteger · int64 · optionalloanScheduleProcessingTypestring · optionalloanScheduleTypestring · optionallocalestring · optionalmaxInterestRatePerPeriodnumber · double · optionalmaxNumberOfRepaymentsinteger · int32 · optionalmaxPrincipalnumber · double · optionalmaxTrancheCountinteger · int32 · optionalmerchantBuyDownFeeboolean · optionalminInterestRatePerPeriodnumber · double · optionalminNumberOfRepaymentsinteger · int32 · optionalminPrincipalnumber · double · optionalminimumDaysBetweenDisbursalAndFirstRepaymentinteger · int32 · optionalmultiDisburseLoanboolean · optionalnamestring · optionalnumberOfRepaymentVariationsForBorrowerCyclearray · optionalnumberOfRepaymentsinteger · int32 · optionaloutstandingLoanBalancenumber · double · optionaloverAppliedCalculationTypestring · optionaloverAppliedNumberinteger · int32 · optionaloverDueDaysForRepaymentEventinteger · int32 · optionaloverdueDaysForNPAinteger · int32 · optionaloverpaymentLiabilityAccountIdinteger · int64 · optionalpaymentAllocationarray of AdvancedPaymentData · optionalpaymentChannelToFundSourceMappingsarray of GetLoanPaymentChannelToFundSourceMappings · optionalpenaltyToIncomeAccountMappingsarray of LoanProductChargeToGLAccountMapper · optionalpreClosureInterestCalculationStrategyinteger · int32 · optionalprincipalnumber · double · optionalprincipalThresholdForLastInstallmentinteger · int32 · optionalprincipalVariationsForBorrowerCyclearray · optionalratesarray of RateData · optionalrecalculationCompoundingFrequencyIntervalinteger · int32 · optionalrecalculationCompoundingFrequencyOnDayTypeinteger · int32 · optionalrecalculationCompoundingFrequencyTypeinteger · int32 · optionalrecalculationRestFrequencyIntervalinteger · int32 · optionalrecalculationRestFrequencyTypeinteger · int32 · optionalreceivableFeeAccountIdinteger · int64 · optionalreceivableInterestAccountIdinteger · int64 · optionalreceivablePenaltyAccountIdinteger · int64 · optionalrepaymentEveryinteger · int32 · optionalrepaymentFrequencyTypeinteger · int64 · optionalrepaymentStartDateTypeinteger · int32 · optionalrescheduleStrategyMethodinteger · int32 · optionalshortNamestring · optionalstartDatestring · optionalsupportedInterestRefundTypesarray · optionaltransactionProcessingStrategyCodestring · optionaltransfersInSuspenseAccountIdinteger · int64 · optionaluseBorrowerCycleboolean · optionalwriteOffAccountIdinteger · int64 · optionalwriteOffReasonsToExpenseMappingsarray of PostWriteOffReasonToExpenseAccountMappings · optionalResponses
200OKResponse fields
resourceIdinteger · int64 · optionalEvery 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.