@mbanq/core-sdk-js v0.50.0

---

@mbanq/core-sdk-js / commands / GetLoanPreclosureTemplate

Function: GetLoanPreclosureTemplate()

GetLoanPreclosureTemplate(loanId, params?): Command<{ loanId: number; params?: { dateFormat?: string; locale?: string; transactionDate?: string; }; }, { amount: number; currency: { code: string; currencyCodeInDigit: number; decimalPlaces: number; displayLabel: string; displaySymbol: string; inMultiplesOf: number; isBaseCurrency: boolean; name: string; nameCode: string; }; date: number[]; feeChargesPortion: number; fixedEmiAmount: number; interestPortion: number; isRevolvingLoan: boolean; loanPreClosureReasonOptions: object[]; manuallyReversed: boolean; outstandingLoanBalance: number; overpaymentPortion: number; paymentTypeOptions: object[]; penaltyChargesPortion: number; principalPortion: number; type: { accrual: boolean; approveTransfer: boolean; chargePayment: boolean; code: string; contra: boolean; disbursement: boolean; id: number; initiateTransfer: boolean; recoveryRepayment: boolean; refund: boolean; refundForActiveLoans: boolean; rejectTransfer: boolean; repayment: boolean; repaymentAtDisbursement: boolean; value: string; waiveCharges: boolean; waiveInterest: boolean; withdrawTransfer: boolean; writeOff: boolean; }; unrecognizedIncomePortion: number; }>

Defined in: src/commands/rest/loan.ts:530

Retrieves the loan preclosure template details. This endpoint provides information needed for loan preclosure, including transaction details, amounts breakdown, and available payment type options.

Parameters

loanId

number

The ID of the loan to get the preclosure template for

params?

Optional query parameters (see GetLoanPreclosureTemplateRequest)

dateFormat?

string = ...

Optional: The date format string (e.g., "dd MMMM yyyy")

locale?

string = ...

Optional: The locale for formatting (e.g., "en")

transactionDate?

string = ...

Optional: The transaction date for preclosure calculation (e.g., "23 July 2024")

Returns

Command<{ loanId: number; params?: { dateFormat?: string; locale?: string; transactionDate?: string; }; }, { amount: number; currency: { code: string; currencyCodeInDigit: number; decimalPlaces: number; displayLabel: string; displaySymbol: string; inMultiplesOf: number; isBaseCurrency: boolean; name: string; nameCode: string; }; date: number[]; feeChargesPortion: number; fixedEmiAmount: number; interestPortion: number; isRevolvingLoan: boolean; loanPreClosureReasonOptions: object[]; manuallyReversed: boolean; outstandingLoanBalance: number; overpaymentPortion: number; paymentTypeOptions: object[]; penaltyChargesPortion: number; principalPortion: number; type: { accrual: boolean; approveTransfer: boolean; chargePayment: boolean; code: string; contra: boolean; disbursement: boolean; id: number; initiateTransfer: boolean; recoveryRepayment: boolean; refund: boolean; refundForActiveLoans: boolean; rejectTransfer: boolean; repayment: boolean; repaymentAtDisbursement: boolean; value: string; waiveCharges: boolean; waiveInterest: boolean; withdrawTransfer: boolean; writeOff: boolean; }; unrecognizedIncomePortion: number; }>

A Command that when executed returns the preclosure template with transaction details and payment options

Example

const templateCmd = GetLoanPreclosureTemplate(12345, {
  transactionDate: "23 July 2024",
  locale: "en",
  dateFormat: "dd MMMM yyyy"
});
const result = await templateCmd.execute(config);
console.log(result.amount); // Total preclosure amount
console.log(result.principalPortion); // Principal portion
console.log(result.interestPortion); // Interest portion
console.log(result.paymentTypeOptions); // Available payment types