Skip to content

@mbanq/core-sdk-js v0.50.0


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

Function: GetAccountProductById()

GetAccountProductById(productId): Command<{ productId: number; }, { accountingRule: { code: string; id: number; value: string; }; allowOverdraft: boolean; charges: object[]; currency: { code: string; decimalPlaces: number; displayLabel: string; displaySymbol: string; name: string; nameCode: string; }; description: string; enforceMinRequiredBalance: boolean; id: number; interestCalculationDaysInYearType: { code: string; id: number; value: string; }; interestCalculationType: { code: string; id: number; value: string; }; interestCompoundingPeriodType: { code: string; id: number; value: string; }; interestPostingPeriodType: { code: string; id: number; value: string; }; isDormancyTrackingActive: boolean; isFloatingInterestRateCalculationAllowed: boolean; isLinkedToFloatingInterestRates: boolean; isLinkedWithFundSourceAccount: boolean; isReservedProduct: boolean; isSkipCollectTransferCharge: boolean; isUsedForSuspenseAccounting: boolean; minRequiredBalance: number; name: string; shortName: string; withdrawalFeeForTransfers: boolean; withHoldTax: boolean; }>

Defined in: src/commands/rest/accountProduct.ts:214

Retrieves a single savings account product by its ID.

Parameters

productId

number

The ID of the savings product to retrieve

Returns

Command<{ productId: number; }, { accountingRule: { code: string; id: number; value: string; }; allowOverdraft: boolean; charges: object[]; currency: { code: string; decimalPlaces: number; displayLabel: string; displaySymbol: string; name: string; nameCode: string; }; description: string; enforceMinRequiredBalance: boolean; id: number; interestCalculationDaysInYearType: { code: string; id: number; value: string; }; interestCalculationType: { code: string; id: number; value: string; }; interestCompoundingPeriodType: { code: string; id: number; value: string; }; interestPostingPeriodType: { code: string; id: number; value: string; }; isDormancyTrackingActive: boolean; isFloatingInterestRateCalculationAllowed: boolean; isLinkedToFloatingInterestRates: boolean; isLinkedWithFundSourceAccount: boolean; isReservedProduct: boolean; isSkipCollectTransferCharge: boolean; isUsedForSuspenseAccounting: boolean; minRequiredBalance: number; name: string; shortName: string; withdrawalFeeForTransfers: boolean; withHoldTax: boolean; }>

A Command that when executed returns the account product details

Example

typescript
const getCmd = GetAccountProductById(101);
const result = await getCmd.execute(config);
console.log(result.name);

Released under the MIT License.