@mbanq/core-sdk-js / commands / GetLoanProducts
Function: GetLoanProducts()
GetLoanProducts():
Command<{ },objectOutputType<{accountingMappings:ZodObject<{fundSourceAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;incomeFromFeeAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;incomeFromPenaltyAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;interestOnLoanAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;loanPortfolioAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;overpaymentLiabilityAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;transfersInSuspenseAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;writeOffAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>; },"strip",ZodAny,objectOutputType<{fundSourceAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;incomeFromFeeAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;incomeFromPenaltyAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;interestOnLoanAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;loanPortfolioAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;overpaymentLiabilityAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;transfersInSuspenseAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;writeOffAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>; },ZodAny,"strip">,objectInputType<{fundSourceAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;incomeFromFeeAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;incomeFromPenaltyAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;interestOnLoanAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;loanPortfolioAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;overpaymentLiabilityAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;transfersInSuspenseAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>;writeOffAccount:ZodObject<{glCode:ZodNumber;id:ZodNumber;name:ZodString; },"strip",ZodTypeAny, {glCode:number;id:number;name:string; }, {glCode:number;id:number;name:string; }>; },ZodAny,"strip">>;accountingRule:ZodObject<{code:ZodString;id:ZodNumber;value:ZodString; },"strip",ZodTypeAny, {code:string;id:number;value:string; }, {code:string;id:number;value:string; }>;amortizationType:ZodObject<{code:ZodString;id:ZodNumber;value:ZodString; },"strip",ZodTypeAny, {code:string;id:number;value:string; }, {code:string;id:number;value:string; }>;annualInterestRate:ZodNumber;charges:ZodArray<ZodAny,"many">;currency:ZodObject<{code:ZodString;decimalPlaces:ZodNumber;displayLabel:ZodString;displaySymbol:ZodString;inMultiplesOf:ZodNumber;name:ZodString;nameCode:ZodString; },"strip",ZodTypeAny, {code:string;decimalPlaces:number;displayLabel:string;displaySymbol:string;inMultiplesOf:number;name:string;nameCode:string; }, {code:string;decimalPlaces:number;displayLabel:string;displaySymbol:string;inMultiplesOf:number;name:string;nameCode:string; }>;feeToIncomeAccountMappings:ZodArray<ZodAny,"many">;id:ZodNumber;includeInBorrowerCycle:ZodBoolean;interestCalculationPeriodType:ZodObject<{code:ZodString;id:ZodNumber;value:ZodString; },"strip",ZodTypeAny, {code:string;id:number;value:string; }, {code:string;id:number;value:string; }>;interestRateFrequencyType:ZodObject<{code:ZodString;id:ZodNumber;value:ZodString; },"strip",ZodTypeAny, {code:string;id:number;value:string; }, {code:string;id:number;value:string; }>;interestRatePerPeriod:ZodNumber;interestRateVariationsForBorrowerCycle:ZodArray<ZodAny,"many">;interestType:ZodObject<{code:ZodString;id:ZodNumber;value:ZodString; },"strip",ZodTypeAny, {code:string;id:number;value:string; }, {code:string;id:number;value:string; }>;maxPrincipal:ZodNumber;maxTrancheCount:ZodNumber;minPrincipal:ZodNumber;multiDisburseLoan:ZodBoolean;name:ZodString;numberOfRepayments:ZodNumber;numberOfRepaymentVariationsForBorrowerCycle:ZodArray<ZodAny,"many">;outstandingLoanBalance:ZodNumber;overdueDaysForNPA:ZodNumber;paymentChannelToFundSourceMappings:ZodArray<ZodAny,"many">;paymentDueOnNonWorkingDaysType:ZodObject<{code:ZodString;id:ZodNumber;value:ZodString; },"strip",ZodTypeAny, {code:string;id:number;value:string; }, {code:string;id:number;value:string; }>;principal:ZodNumber;principalThresholdForLastInstalment:ZodNumber;principalVariationsForBorrowerCycle:ZodArray<ZodAny,"many">;repaymentEvery:ZodNumber;repaymentFrequencyType:ZodObject<{code:ZodString;id:ZodNumber;value:ZodString; },"strip",ZodTypeAny, {code:string;id:number;value:string; }, {code:string;id:number;value:string; }>;repaymentRescheduleOnHoliday:ZodBoolean;shortName:ZodString;status:ZodString;transactionProcessingStrategyId:ZodNumber;transactionProcessingStrategyName:ZodString;useBorrowerCycle:ZodBoolean; },ZodAny,"strip">[]>
Defined in: src/commands/rest/loanProduct.ts:151
Retrieves a list of all loan products.
Returns
Command<{ }, objectOutputType<{ accountingMappings: ZodObject<{ fundSourceAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; incomeFromFeeAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; incomeFromPenaltyAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; interestOnLoanAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; loanPortfolioAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; overpaymentLiabilityAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; transfersInSuspenseAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; writeOffAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; }, "strip", ZodAny, objectOutputType<{ fundSourceAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; incomeFromFeeAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; incomeFromPenaltyAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; interestOnLoanAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; loanPortfolioAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; overpaymentLiabilityAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; transfersInSuspenseAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; writeOffAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; }, ZodAny, "strip">, objectInputType<{ fundSourceAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; incomeFromFeeAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; incomeFromPenaltyAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; interestOnLoanAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; loanPortfolioAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; overpaymentLiabilityAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; transfersInSuspenseAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; writeOffAccount: ZodObject<{ glCode: ZodNumber; id: ZodNumber; name: ZodString; }, "strip", ZodTypeAny, { glCode: number; id: number; name: string; }, { glCode: number; id: number; name: string; }>; }, ZodAny, "strip">>; accountingRule: ZodObject<{ code: ZodString; id: ZodNumber; value: ZodString; }, "strip", ZodTypeAny, { code: string; id: number; value: string; }, { code: string; id: number; value: string; }>; amortizationType: ZodObject<{ code: ZodString; id: ZodNumber; value: ZodString; }, "strip", ZodTypeAny, { code: string; id: number; value: string; }, { code: string; id: number; value: string; }>; annualInterestRate: ZodNumber; charges: ZodArray<ZodAny, "many">; currency: ZodObject<{ code: ZodString; decimalPlaces: ZodNumber; displayLabel: ZodString; displaySymbol: ZodString; inMultiplesOf: ZodNumber; name: ZodString; nameCode: ZodString; }, "strip", ZodTypeAny, { code: string; decimalPlaces: number; displayLabel: string; displaySymbol: string; inMultiplesOf: number; name: string; nameCode: string; }, { code: string; decimalPlaces: number; displayLabel: string; displaySymbol: string; inMultiplesOf: number; name: string; nameCode: string; }>; feeToIncomeAccountMappings: ZodArray<ZodAny, "many">; id: ZodNumber; includeInBorrowerCycle: ZodBoolean; interestCalculationPeriodType: ZodObject<{ code: ZodString; id: ZodNumber; value: ZodString; }, "strip", ZodTypeAny, { code: string; id: number; value: string; }, { code: string; id: number; value: string; }>; interestRateFrequencyType: ZodObject<{ code: ZodString; id: ZodNumber; value: ZodString; }, "strip", ZodTypeAny, { code: string; id: number; value: string; }, { code: string; id: number; value: string; }>; interestRatePerPeriod: ZodNumber; interestRateVariationsForBorrowerCycle: ZodArray<ZodAny, "many">; interestType: ZodObject<{ code: ZodString; id: ZodNumber; value: ZodString; }, "strip", ZodTypeAny, { code: string; id: number; value: string; }, { code: string; id: number; value: string; }>; maxPrincipal: ZodNumber; maxTrancheCount: ZodNumber; minPrincipal: ZodNumber; multiDisburseLoan: ZodBoolean; name: ZodString; numberOfRepayments: ZodNumber; numberOfRepaymentVariationsForBorrowerCycle: ZodArray<ZodAny, "many">; outstandingLoanBalance: ZodNumber; overdueDaysForNPA: ZodNumber; paymentChannelToFundSourceMappings: ZodArray<ZodAny, "many">; paymentDueOnNonWorkingDaysType: ZodObject<{ code: ZodString; id: ZodNumber; value: ZodString; }, "strip", ZodTypeAny, { code: string; id: number; value: string; }, { code: string; id: number; value: string; }>; principal: ZodNumber; principalThresholdForLastInstalment: ZodNumber; principalVariationsForBorrowerCycle: ZodArray<ZodAny, "many">; repaymentEvery: ZodNumber; repaymentFrequencyType: ZodObject<{ code: ZodString; id: ZodNumber; value: ZodString; }, "strip", ZodTypeAny, { code: string; id: number; value: string; }, { code: string; id: number; value: string; }>; repaymentRescheduleOnHoliday: ZodBoolean; shortName: ZodString; status: ZodString; transactionProcessingStrategyId: ZodNumber; transactionProcessingStrategyName: ZodString; useBorrowerCycle: ZodBoolean; }, ZodAny, "strip">[]>
A Command that when executed returns an array of loan products.
Example
const listCmd = GetLoanProducts();
const result = await listCmd.execute(config);
result.forEach(product => console.log(product.name));