Retrieve Loan Product Details Template (V2)

GET/lokta-lms/api/v2/loanproducts/template

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:

Field Defaults
Allowed description Lists
Example Request:

v2/loanproducts/template

Query parameters

isProductMixTemplatequery · boolean · optional

isProductMixTemplate

Responses

200OK

Response fields

accountingMappingOptionsGetLoanProductsAccountingMappingOptions · optional

accountingRuleGetLoanProductsAccountingRule · optional

accountingRuleOptionsarray of GetLoanProductsAccountingRule · optional

advancedPaymentAllocationFutureInstallmentAllocationRulesarray of EnumOptionData · optional

advancedPaymentAllocationTransactionTypesarray of EnumOptionData · optional

advancedPaymentAllocationTypesarray of EnumOptionData · optional

amortizationTypeGetLoanProductsAmortizationType · optional

amortizationTypeOptionsarray of GetLoanProductsAmortizationType · optional

buyDownFeeCalculationTypeStringEnumOptionData · optional

buyDownFeeCalculationTypeOptionsarray of StringEnumOptionData · optional

buyDownFeeIncomeTypeStringEnumOptionData · optional

buyDownFeeIncomeTypeOptionsarray of StringEnumOptionData · optional

buyDownFeeStrategyStringEnumOptionData · optional

buyDownFeeStrategyOptionsarray of StringEnumOptionData · optional

buydownFeeClassificationOptionsarray of GetCodeValuesDataResponse · optional

capitalizedIncomeCalculationTypeStringEnumOptionData · optional

capitalizedIncomeCalculationTypeOptionsarray of StringEnumOptionData · optional

capitalizedIncomeClassificationOptionsarray of GetCodeValuesDataResponse · optional

capitalizedIncomeStrategyStringEnumOptionData · optional

capitalizedIncomeStrategyOptionsarray of StringEnumOptionData · optional

capitalizedIncomeTypeStringEnumOptionData · optional

capitalizedIncomeTypeOptionsarray of StringEnumOptionData · optional

chargeOffBehaviourStringEnumOptionData · optional

chargeOffBehaviourOptionsarray of StringEnumOptionData · optional

chargeOffReasonOptionsarray of GetLoanProductsChargeOffReasonOptions · optional

chargeOptionsarray of GetLoanProductsChargeOptions · optional

creditAllocationAllocationTypesarray of EnumOptionData · optional

creditAllocationTransactionTypesarray of EnumOptionData · optional

currencyGetLoanProductsTemplateCurrency · optional

currencyOptionsarray of GetLoanProductsCurrencyOptions · optional

daysInMonthTypeGetLoanProductsDaysInMonthType · optional

daysInMonthTypeOptionsarray of StringEnumOptionData · optional

daysInYearCustomStrategyStringEnumOptionData · optional

daysInYearTypeGetLoanProductsDaysInYearType · optional

daysInYearTypeCustomStrategyOptionsarray of StringEnumOptionData · optional

daysInYearTypeOptionsarray of GetLoanProductsInterestTemplateType · optional

enableBuyDownFeeboolean · optional

enableIncomeCapitalizationboolean · optional

includeInBorrowerCycleboolean · optional

interestCalculationPeriodTypeGetLoansProductsInterestCalculationPeriodType · optional

interestCalculationPeriodTypeOptionsarray of GetLoansProductsInterestCalculationPeriodType · optional

interestRateFrequencyTypeGetLoanProductsInterestRateTemplateFrequencyType · optional

interestRateFrequencyTypeOptionsarray of GetLoanProductsInterestRateTemplateFrequencyType · optional

interestRateVariationsForBorrowerCyclearray · optional

interestRecalculationCompoundingTypeOptionsarray of GetLoanProductsInterestRecalculationCompoundingType · optional

interestRecalculationDataGetLoanProductsInterestRecalculationTemplateData · optional

interestRecalculationFrequencyTypeOptionsarray of GetLoanProductsInterestRecalculationCompoundingFrequencyType · optional

interestTypeGetLoanProductsInterestTemplateType · optional

interestTypeOptionsarray of GetLoanProductsInterestTemplateType · optional

isInterestRecalculationEnabledboolean · optional

loanScheduleProcessingTypeOptionsarray of EnumOptionData · optional

loanScheduleTypeOptionsarray of EnumOptionData · optional

merchantBuyDownFeeboolean · optional

numberOfRepaymentVariationsForBorrowerCyclearray · optional

paymentTypeOptionsarray of GetLoanProductsPaymentTypeOptions · optional

preClosureInterestCalculationStrategyOptionsarray of GetLoanProductsPreClosureInterestCalculationStrategy · optional

principalVariationsForBorrowerCyclearray · optional

repaymentFrequencyTypeGetLoanProductsRepaymentTemplateFrequencyType · optional

repaymentFrequencyTypeOptionsarray of GetLoanProductsRepaymentTemplateFrequencyType · optional

repaymentStartDateTypeOptionsarray of GetLoanProductsRepaymentStartDateType · optional

rescheduleStrategyTypeOptionsarray of GetLoanProductsRescheduleStrategyType · optional

supportedInterestRefundTypesarray of StringEnumOptionData · optional

supportedInterestRefundTypesOptionsarray of StringEnumOptionData · optional

transactionProcessingStrategyOptionsarray of GetLoanProductsTransactionProcessingStrategyOptions · optional

useBorrowerCycleboolean · optional

valueConditionTypeOptionsarray of GetLoanProductsValueConditionTypeOptions · optional

writeOffReasonOptionsarray of GetLoanProductsWriteOffReasonOptions · optional

beneficiaryTypeOptionsarray of LoanProductV2CodeOption · optional

bpiMethodOptionsarray of LoanProductV2EnumOption · optional

Allowed bpiMethod choices: stable code (the only value the write API accepts) + display name + one-line description.

brokenPeriodDayCountOptionsarray of LoanProductV2EnumOption · optional

Allowed brokenPeriodDayCount choices — identical to dayCountConventionOptions (parity by design).

dayCountConventionOptionsarray of LoanProductV2EnumOption · optional

Allowed dayCountConvention choices: stable code (the only value the write API accepts) + display name + one-line description.

pmtTypeOptionsarray of LoanProductV2EnumOption · optional

Allowed pmtType choices.

productCategoryTagOptionsarray of LoanProductV2CodeOption · optional

productTypeOptionsarray of LoanProductV2CodeOption · optional

roundingModeOptionsarray · optional

The rounding-mode validation whitelist — java.math.RoundingMode names the backend accepts. No profile ids, codes or names exist externally.

scheduleSolverOptionsarray of LoanProductV2EnumOption · optional

Allowed scheduleSolver choices — exactly five, stable code (the only value the write API accepts) + display name + one-line description. All five are storable declarative configuration with no backend derivation; which values a client presents as engine-native is managed outside the backend. The backend never derives Loan terms from scheduleSolver.

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.