Retrieve a Loan Product

GET/lokta-lms/api/v1/loanproducts/{productId}

Retrieves a Loan Product

Example Requests:

loanproducts/1

loanproducts/1?template=true

loanproducts/1?fields=name,description,numberOfRepayments

Path parameters

productIdpath · integer · int64 · required

productId

Responses

200OK

Response fields

accountingMappingsGetLoanAccountingMappings · optional

accountingRuleGetLoanProductsAccountingRule · optional

allowApprovedDisbursedAmountsOverAppliedboolean · 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

amortizationTypeGetLoanProductsAmortizationType · optional

annualInterestRatenumber · double · optional

buyDownFeeCalculationTypeStringEnumOptionData · optional

buyDownFeeCalculationTypeOptionsarray of StringEnumOptionData · optional

buyDownFeeIncomeTypeStringEnumOptionData · optional

buyDownFeeIncomeTypeOptionsarray of StringEnumOptionData · optional

buyDownFeeStrategyStringEnumOptionData · optional

buyDownFeeStrategyOptionsarray of StringEnumOptionData · optional

buydownFeeClassificationOptionsarray of GetCodeValuesDataResponse · optional

buydownFeeClassificationToIncomeAccountMappingsarray of GetClassificationToIncomeAccountMappings · optional

canDefineInstallmentAmountboolean · optional

canUseForTopupboolean · optional

capitalizedIncomeCalculationTypeStringEnumOptionData · optional

capitalizedIncomeCalculationTypeOptionsarray of StringEnumOptionData · optional

capitalizedIncomeClassificationOptionsarray of GetCodeValuesDataResponse · optional

capitalizedIncomeClassificationToIncomeAccountMappingsarray of GetClassificationToIncomeAccountMappings · optional

capitalizedIncomeStrategyStringEnumOptionData · optional

capitalizedIncomeStrategyOptionsarray of StringEnumOptionData · optional

capitalizedIncomeTypeStringEnumOptionData · optional

capitalizedIncomeTypeOptionsarray of StringEnumOptionData · optional

chargeOffBehaviourStringEnumOptionData · optional

chargeOffReasonOptionsarray of GetLoanProductsChargeOffReasonOptions · optional

chargeOffReasonToExpenseAccountMappingsarray of GetChargeOffReasonToExpenseAccountMappings · optional

chargesarray of LoanProductChargeData · optional

creditAllocationarray of CreditAllocationData · optional

currencyGetLoanProductsCurrency · optional

daysInMonthTypeGetLoanProductsDaysInMonthType · optional

daysInYearCustomStrategyStringEnumOptionData · optional

daysInYearTypeGetLoanProductsDaysInYearType · optional

delinquencyBucketDelinquencyBucketData · optional

delinquencyBucketOptionsarray of DelinquencyBucketData · optional

descriptionstring · optional

disallowExpectedDisbursementsboolean · optional

disbursedAmountPercentageForDownPaymentnumber · optional

dueDaysForRepaymentEventinteger · int32 · optional

enableAccrualActivityPostingboolean · optional

enableAutoRepaymentForDownPaymentboolean · optional

enableBuyDownFeeboolean · optional

enableDownPaymentboolean · optional

enableIncomeCapitalizationboolean · optional

enableInstallmentLevelDelinquencyboolean · optional

feeToIncomeAccountMappingsarray of GetLoanFeeToIncomeAccountMappings · optional

fixedLengthinteger · int32 · optional

fixedPrincipalPercentagePerInstallmentnumber · optional

idinteger · int64 · optional

inArrearsToleranceinteger · int32 · optional

includeInBorrowerCycleboolean · optional

interestCalculationPeriodTypeGetLoansProductsInterestCalculationPeriodType · optional

interestRateFrequencyTypeGetLoanProductsInterestRateFrequencyType · optional

interestRatePerPeriodnumber · double · optional

interestRateVariationsForBorrowerCyclearray · optional

interestRecalculationDataGetLoanProductsInterestRecalculationData · optional

interestRecognitionOnDisbursementDateboolean · optional

interestTypeGetLoanProductsInterestTemplateType · optional

isFloatingInterestRateCalculationAllowedboolean · optional

isInterestRecalculationEnabledboolean · optional

isLinkedToFloatingInterestRatesboolean · optional

isRatesEnabledboolean · optional

loanScheduleProcessingTypeEnumOptionData · optional

loanScheduleTypeEnumOptionData · optional

maxInterestRatePerPeriodnumber · double · optional

maxNumberOfRepaymentsinteger · int32 · optional

maxPrincipalnumber · double · optional

maxTrancheCountinteger · int32 · optional

maximumGapinteger · int32 · optional

merchantBuyDownFeeboolean · optional

minInterestRatePerPeriodnumber · double · optional

minNumberOfRepaymentsinteger · int32 · optional

minPrincipalnumber · double · optional

minimumGapinteger · int32 · optional

multiDisburseLoanboolean · optional

namestring · optional

numberOfRepaymentVariationsForBorrowerCyclearray · optional

numberOfRepaymentsinteger · int32 · optional

outstandingLoanBalancenumber · double · optional

overAppliedCalculationTypestring · optional

overDueDaysForRepaymentEventinteger · int32 · optional

overdueDaysForNPAinteger · int32 · optional

paymentAllocationarray of AdvancedPaymentData · optional

paymentChannelToFundSourceMappingsarray of GetLoanPaymentChannelToFundSourceMappings · optional

principalnumber · double · optional

principalThresholdForLastInstalmentinteger · int32 · optional

productsPrincipalVariationsForBorrowerCyclearray of GetLoanProductsPrincipalVariationsForBorrowerCycle · optional

repaymentEveryinteger · int32 · optional

repaymentFrequencyTypeGetLoanProductsRepaymentFrequencyType · optional

repaymentStartDateTypeGetLoanProductsRepaymentStartDateType · optional

shortNamestring · optional

statusstring · optional

supportedInterestRefundTypesarray of StringEnumOptionData · optional

transactionProcessingStrategyCodestring · optional

transactionProcessingStrategyNamestring · optional

useBorrowerCycleboolean · optional

writeOffReasonOptionsarray of GetLoanProductsWriteOffReasonOptions · optional

writeOffReasonsToExpenseMappingsarray of GetChargeOffReasonToExpenseAccountMappings · 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.