Balance
Class that represents an [[Account]] or [[Group]] balance on a window of time (Day / Month / Year).
Constructors
Constructor
new Balance(container, balancePlain): Balance;Parameters
| Parameter | Type |
|---|---|
container | BalancesContainer |
balancePlain | Balance |
Returns
Balance
Properties
payload
payload: Balance;Methods
getCumulativeBalance()
getCumulativeBalance(): Amount;The cumulative balance to the date, based on the credit nature of the container
Returns
getCumulativeBalanceRaw()
getCumulativeBalanceRaw(): Amount;The raw cumulative balance to the date.
Returns
getCumulativeCredit()
getCumulativeCredit(): Amount;The cumulative credit to the date.
Returns
getCumulativeDebit()
getCumulativeDebit(): Amount;The cumulative debit to the date.
Returns
getDate()
getDate(): Date;Date object constructed based on [[Book]] time zone offset. Usefull for
If Month or Day is zero, the date will be constructed with first Month (January) or Day (1) of the next period.
Returns
Date
getDay()
getDay(): number;The day of the balance. Days starts on 1 to 31.
Day can be 0 (zero) in case of Monthly or Early [[Periodicity]] of the [[BalancesReport]]
Returns
number
getFuzzyDate()
getFuzzyDate(): number;The Fuzzy Date of the balance, based on [[Periodicity]] of the [[BalancesReport]] query, composed by Year, Month and Day.
The format is YYYYMMDD. Very usefull for ordering and indexing
Month and Day can be 0 (zero), depending on the granularity of the [[Periodicity]].
Example:
20180125 - 25, January, 2018 - DAILY Periodicity
20180100 - January, 2018 - MONTHLY Periodicity
20180000 - 2018 - YEARLY Periodicity
Returns
number
getMonth()
getMonth(): number;The month of the balance. Months starts on 1 (January) to 12 (December)
Month can be 0 (zero) in case of Early [[Periodicity]] of the [[BalancesReport]]
Returns
number
getPeriodBalance()
getPeriodBalance(): Amount;The balance on the date period, based on credit nature of the container.
Returns
getPeriodBalanceRaw()
getPeriodBalanceRaw(): Amount;The raw balance on the date period.
Returns
getPeriodCredit()
getPeriodCredit(): Amount;The credit on the date period.
Returns
getPeriodDebit()
getPeriodDebit(): Amount;The debit on the date period.
Returns
getYear()
getYear(): number;The year of the balance
Returns
number