API Search endpoints…⌘K

Create a Loan Product

POST/lokta-lms/api/v1/loanproducts

Depending 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 · optional
accountingRuleinteger · int32 · optional
allowApprovedDisbursedAmountsOverAppliedboolean · optional
allowAttributeOverridesAllowAttributeOverrides · optional
allowCompoundingOnEodboolean · optional
allowFullTermForTrancheboolean · optional

Allow full term length for each tranche disbursement. Only available for PROGRESSIVE schedule type with multi-disbursement enabled.

allowPartialPeriodInterestCalculationboolean · optional
allowVariableInstallmentsboolean · optional
amortizationTypeinteger · int32 · optional
buyDownExpenseAccountIdinteger · int64 · optional
buyDownFeeCalculationTypestring · optional
One of: FLAT
buyDownFeeIncomeTypestring · optional
One of: FEE, INTEREST
buyDownFeeStrategystring · optional
One of: EQUAL_AMORTIZATION
buydownfeeClassificationToIncomeAccountMappingsarray of PostClassificationToIncomeAccountMappings · optional
canDefineInstallmentAmountboolean · optional
canUseForTopupboolean · optional
capitalizedIncomeCalculationTypestring · optional
One of: FLAT
capitalizedIncomeClassificationToIncomeAccountMappingsarray of PostClassificationToIncomeAccountMappings · optional
capitalizedIncomeStrategystring · optional
One of: EQUAL_AMORTIZATION
capitalizedIncomeTypestring · optional
One of: FEE, INTEREST
chargeOffBehaviourstring · optional
chargeOffExpenseAccountIdinteger · int64 · optional
chargeOffFraudExpenseAccountIdinteger · int64 · optional
chargeOffReasonToExpenseAccountMappingsarray of PostChargeOffReasonToExpenseAccountMappings · optional
chargesarray of LoanProductChargeData · optional
closeDatestring · optional
creditAllocationarray of CreditAllocationData · optional
currencyCodestring · optional
dateFormatstring · optional
daysInMonthTypeinteger · int32 · optional
daysInYearCustomStrategystring · optional
daysInYearTypeinteger · int32 · optional
deferredFeeIncomeAccountIdinteger · int64 · optional
deferredIncomeLiabilityAccountIdinteger · int64 · optional
delinquencyBucketIdinteger · int64 · optional
descriptionstring · optional
digitsAfterDecimalinteger · int32 · optional
disallowExpectedDisbursementsboolean · optional
disallowInterestCalculationOnPastDueboolean · optional
disbursedAmountPercentageForDownPaymentnumber · optional
dueDaysForRepaymentEventinteger · int32 · optional
enableAccrualActivityPostingboolean · optional
enableAutoRepaymentForDownPaymentboolean · optional
enableBuyDownFeeboolean · optional
enableDownPaymentboolean · optional
enableIncomeCapitalizationboolean · optional
enableInstallmentLevelDelinquencyboolean · optional
externalIdstring · optional
feeToIncomeAccountMappingsarray of LoanProductChargeToGLAccountMapper · optional
fixedLengthinteger · int32 · optional
fixedPrincipalPercentagePerInstallmentnumber · optional
fundIdinteger · int64 · optional
fundSourceAccountIdinteger · int64 · optional
goodwillCreditAccountIdinteger · int64 · optional
graceOnArrearsAgeinginteger · int32 · optional
graceOnInterestPaymentinteger · int32 · optional
graceOnPrincipalPaymentinteger · int32 · optional
holdGuaranteeFundsboolean · optional
inArrearsToleranceinteger · int32 · optional
inMultiplesOfinteger · int32 · optional
includeInBorrowerCycleboolean · optional
incomeFromBuyDownAccountIdinteger · int64 · optional
incomeFromCapitalizationAccountIdinteger · int64 · optional
incomeFromChargeOffFeesAccountIdinteger · int64 · optional
incomeFromChargeOffInterestAccountIdinteger · int64 · optional
incomeFromChargeOffPenaltyAccountIdinteger · int64 · optional
incomeFromFeeAccountIdinteger · int64 · optional
incomeFromGoodwillCreditFeesAccountIdinteger · int64 · optional
incomeFromGoodwillCreditInterestAccountIdinteger · int64 · optional
incomeFromGoodwillCreditPenaltyAccountIdinteger · int64 · optional
incomeFromPenaltyAccountIdinteger · int64 · optional
incomeFromRecoveryAccountIdinteger · int64 · optional
installmentAmountInMultiplesOfinteger · int32 · optional
interestCalculationPeriodTypeinteger · int32 · optional
interestOnLoanAccountIdinteger · int64 · optional
interestRateFrequencyTypeinteger · int32 · optional
interestRatePerPeriodnumber · double · optional
interestRateVariationsForBorrowerCyclearray · optional
interestRecalculationCompoundingMethodinteger · int32 · optional
interestRecognitionOnDisbursementDateboolean · optional
interestTypeinteger · int32 · optional
isArrearsBasedOnOriginalScheduleboolean · optional
isCompoundingToBePostedAsTransactionboolean · optional
isEqualAmortizationboolean · optional
isInterestRecalculationEnabledboolean · optional
isLinkedToFloatingInterestRatesboolean · optional
loanPortfolioAccountIdinteger · int64 · optional
loanScheduleProcessingTypestring · optional
loanScheduleTypestring · optional
localestring · optional
maxInterestRatePerPeriodnumber · double · optional
maxNumberOfRepaymentsinteger · int32 · optional
maxPrincipalnumber · double · optional
maxTrancheCountinteger · int32 · optional
merchantBuyDownFeeboolean · optional
minInterestRatePerPeriodnumber · double · optional
minNumberOfRepaymentsinteger · int32 · optional
minPrincipalnumber · double · optional
minimumDaysBetweenDisbursalAndFirstRepaymentinteger · int32 · optional
multiDisburseLoanboolean · optional
namestring · optional
numberOfRepaymentVariationsForBorrowerCyclearray · optional
numberOfRepaymentsinteger · int32 · optional
outstandingLoanBalancenumber · double · optional
overAppliedCalculationTypestring · optional
overAppliedNumberinteger · int32 · optional
overDueDaysForRepaymentEventinteger · int32 · optional
overdueDaysForNPAinteger · int32 · optional
overpaymentLiabilityAccountIdinteger · int64 · optional
paymentAllocationarray of AdvancedPaymentData · optional
paymentChannelToFundSourceMappingsarray of GetLoanPaymentChannelToFundSourceMappings · optional
penaltyToIncomeAccountMappingsarray of LoanProductChargeToGLAccountMapper · optional
preClosureInterestCalculationStrategyinteger · int32 · optional
principalnumber · double · optional
principalThresholdForLastInstallmentinteger · int32 · optional
principalVariationsForBorrowerCyclearray · optional
ratesarray of RateData · optional
recalculationCompoundingFrequencyIntervalinteger · int32 · optional
recalculationCompoundingFrequencyOnDayTypeinteger · int32 · optional
recalculationCompoundingFrequencyTypeinteger · int32 · optional
recalculationRestFrequencyIntervalinteger · int32 · optional
recalculationRestFrequencyTypeinteger · int32 · optional
receivableFeeAccountIdinteger · int64 · optional
receivableInterestAccountIdinteger · int64 · optional
receivablePenaltyAccountIdinteger · int64 · optional
repaymentEveryinteger · int32 · optional
repaymentFrequencyTypeinteger · int64 · optional
repaymentStartDateTypeinteger · int32 · optional
rescheduleStrategyMethodinteger · int32 · optional
shortNamestring · optional
startDatestring · optional
supportedInterestRefundTypesarray · optional
transactionProcessingStrategyCodestring · optional
transfersInSuspenseAccountIdinteger · int64 · optional
useBorrowerCycleboolean · optional
writeOffAccountIdinteger · int64 · optional
writeOffReasonsToExpenseMappingsarray of PostWriteOffReasonToExpenseAccountMappings · optional

Responses

200OK

Response fields

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