BalancesContainer

Extends

• BalancesContainer

Methods

addBalancesContainer()

addBalancesContainer(container): BalancesContainer;

Adds an [[Account]] container to a [[Group]] container.

NOTE: Only for Group balance containers.

Parameters

Parameter	Type
container	BalancesContainer

Returns

BalancesContainer

Inherited from

Bkper.BalancesContainer.addBalancesContainer

---

createDataTable()

createDataTable(): BalancesDataTableBuilder;

Creates a BalancesDataTableBuilder to generate a two-dimensional array with all [[BalancesContainers]]

Returns

BalancesDataTableBuilder

Inherited from

Bkper.BalancesContainer.createDataTable

---

getAccount()

getAccount(): Account;

The [[Account]] associated with this container

Returns

Account

Inherited from

Bkper.BalancesContainer.getAccount

---

getAccountBalancesContainers()

getAccountBalancesContainers(): BalancesContainer[];

Gets all [[Account]] [[BalancesContainers]].

Returns

BalancesContainer[]

Inherited from

Bkper.BalancesContainer.getAccountBalancesContainers

---

getBalances()

getBalances(): Balance[];

All [[Balances]] of the container

Returns

Balance[]

Inherited from

Bkper.BalancesContainer.getBalances

---

getBalancesContainer()

getBalancesContainer(name): BalancesContainer;

Gets a specific [[BalancesContainer]].

Parameters

Parameter	Type
name	string

Returns

BalancesContainer

Inherited from

Bkper.BalancesContainer.getBalancesContainer

---

getBalancesContainers()

getBalancesContainers(): BalancesContainer[];

Gets all child [[BalancesContainers]].

NOTE: Only for Group balance containers. Accounts returns null.

Returns

BalancesContainer[]

Inherited from

Bkper.BalancesContainer.getBalancesContainers

---

getBalancesReport()

getBalancesReport(): BalancesReport;

The parent BalancesReport of the container

Returns

BalancesReport

Inherited from

Bkper.BalancesContainer.getBalancesReport

---

getCumulativeBalance()

getCumulativeBalance(): Amount;

The cumulative balance to the date.

Returns

Amount

Inherited from

Bkper.BalancesContainer.getCumulativeBalance

---

getCumulativeBalanceRaw()

getCumulativeBalanceRaw(): Amount;

The cumulative raw balance to the date.

Returns

Amount

Inherited from

Bkper.BalancesContainer.getCumulativeBalanceRaw

---

getCumulativeBalanceRawText()

getCumulativeBalanceRawText(): string;

The cumulative raw balance formatted according to [[Book]] decimal format and fraction digits.

Returns

string

Inherited from

Bkper.BalancesContainer.getCumulativeBalanceRawText

---

getCumulativeBalanceText()

getCumulativeBalanceText(): string;

The cumulative balance formatted according to [[Book]] decimal format and fraction digits.

Returns

string

Inherited from

Bkper.BalancesContainer.getCumulativeBalanceText

---

getCumulativeCredit()

getCumulativeCredit(): Amount;

The cumulative credit to the date.

Returns

Amount

Inherited from

Bkper.BalancesContainer.getCumulativeCredit

---

getCumulativeCreditText()

getCumulativeCreditText(): string;

The cumulative credit formatted according to [[Book]] decimal format and fraction digits.

Returns

string

Inherited from

Bkper.BalancesContainer.getCumulativeCreditText

---

getCumulativeDebit()

getCumulativeDebit(): Amount;

The cumulative debit to the date.

Returns

Amount

Inherited from

Bkper.BalancesContainer.getCumulativeDebit

---

getCumulativeDebitText()

getCumulativeDebitText(): string;

The cumulative credit formatted according to [[Book]] decimal format and fraction digits.

Returns

string

Inherited from

Bkper.BalancesContainer.getCumulativeDebitText

---

getDepth()

getDepth(): number;

The depth in the parent chain up to the root.

Returns

number

Inherited from

Bkper.BalancesContainer.getDepth

---

getGroup()

getGroup(): Group;

The [[Group]] associated with this container

Returns

Group

Inherited from

Bkper.BalancesContainer.getGroup

---

getName()

getName(): string;

The [[Account]] or [[Group]] name

Returns

string

Inherited from

Bkper.BalancesContainer.getName

---

getNormalizedName()

getNormalizedName(): string;

The [[Account]] or [[Group]] name without spaces or special characters.

Returns

string

Inherited from

Bkper.BalancesContainer.getNormalizedName

---

getParent()

getParent(): BalancesContainer;

The parent BalanceContainer

Returns

BalancesContainer

Inherited from

Bkper.BalancesContainer.getParent

---

getPeriodBalance()

getPeriodBalance(): Amount;

The balance on the date period.

Returns

Amount

Inherited from

Bkper.BalancesContainer.getPeriodBalance

---

getPeriodBalanceRaw()

getPeriodBalanceRaw(): Amount;

The raw balance on the date period.

Returns

Amount

Inherited from

Bkper.BalancesContainer.getPeriodBalanceRaw

---

getPeriodBalanceRawText()

getPeriodBalanceRawText(): string;

The raw balance on the date period formatted according to [[Book]] decimal format and fraction digits

Returns

string

Inherited from

Bkper.BalancesContainer.getPeriodBalanceRawText

---

getPeriodBalanceText()

getPeriodBalanceText(): string;

The balance on the date period formatted according to [[Book]] decimal format and fraction digits

Returns

string

Inherited from

Bkper.BalancesContainer.getPeriodBalanceText

---

getPeriodCredit()

getPeriodCredit(): Amount;

The credit on the date period.

Returns

Amount

Inherited from

Bkper.BalancesContainer.getPeriodCredit

---

getPeriodCreditText()

getPeriodCreditText(): string;

The credit on the date period formatted according to [[Book]] decimal format and fraction digits

Returns

string

Inherited from

Bkper.BalancesContainer.getPeriodCreditText

---

getPeriodDebit()

getPeriodDebit(): Amount;

The debit on the date period.

Returns

Amount

Inherited from

Bkper.BalancesContainer.getPeriodDebit

---

getPeriodDebitText()

getPeriodDebitText(): string;

The debit on the date period formatted according to [[Book]] decimal format and fraction digits

Returns

string

Inherited from

Bkper.BalancesContainer.getPeriodDebitText

---

getProperties()

getProperties(): object;

Gets the custom properties stored in this Account or Group.

Returns

object

Inherited from

Bkper.BalancesContainer.getProperties

---

getProperty()

getProperty(...keys): string;

Gets the property value for given keys. First property found will be retrieved

Parameters

Parameter	Type
…keys	string[]

Returns

string

Inherited from

Bkper.BalancesContainer.getProperty

---

getPropertyKeys()

getPropertyKeys(): string[];

Gets the custom properties keys stored in the associated [[Account]] or [[Group]].

Returns

string[]

Inherited from

Bkper.BalancesContainer.getPropertyKeys

---

hasGroupBalances()

hasGroupBalances(): boolean;

Tell if the balance container is from a parent group

Returns

boolean

Inherited from

Bkper.BalancesContainer.hasGroupBalances

---

isCredit()

isCredit(): boolean;

Gets the credit nature of the BalancesContainer, based on [[Account]] or [[Group]].

For [[Account]], the credit nature will be the same as the one from the Account

For [[Group]], the credit nature will be the same, if all accounts containing on it has the same credit nature. False if mixed.

Returns

boolean

Inherited from

Bkper.BalancesContainer.isCredit

---

isFromAccount()

isFromAccount(): boolean;

Tell if this balance container if from an [[Account]]

Returns

boolean

Inherited from

Bkper.BalancesContainer.isFromAccount

---

isFromGroup()

isFromGroup(): boolean;

Tell if this balance container if from a [[Group]]

Returns

boolean

Inherited from

Bkper.BalancesContainer.isFromGroup

---

isPermanent()

isPermanent(): boolean;

Tell if this balance container is permament, based on the [[Account]] or [[Group]].

Permanent are the ones which final balance is relevant and keep its balances over time.

They are also called Real Accounts

Usually represents assets or liabilities, capable of being perceived by the senses or the mind, like bank accounts, money, debts and so on.

Returns

boolean

True if its a permanent Account

Inherited from

Bkper.BalancesContainer.isPermanent

---

removeBalancesContainer()

removeBalancesContainer(container): BalancesContainer;

Removes an [[Account]] container from a [[Group]] container.

NOTE: Only for Group balance containers.

Parameters

Parameter	Type
container	BalancesContainer

Returns

BalancesContainer

Inherited from

Bkper.BalancesContainer.removeBalancesContainer