Balance
Extends
Balance
Properties
payload
payload: Balance;The underlying payload data for this resource
Inherited from
Bkper.Balance.payloadMethods
getCumulativeBalance()
getCumulativeBalance(): Amount;The cumulative balance to the date, based on the credit nature of the container
Returns
Amount
Inherited from
Bkper.Balance.getCumulativeBalancegetCumulativeBalanceRaw()
getCumulativeBalanceRaw(): Amount;The raw cumulative balance to the date.
Returns
Amount
Inherited from
Bkper.Balance.getCumulativeBalanceRawgetCumulativeCredit()
getCumulativeCredit(): Amount;The cumulative credit to the date.
Returns
Amount
Inherited from
Bkper.Balance.getCumulativeCreditgetCumulativeDebit()
getCumulativeDebit(): Amount;The cumulative debit to the date.
Returns
Amount
Inherited from
Bkper.Balance.getCumulativeDebitgetDate()
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).
Returns
Date
Inherited from
Bkper.Balance.getDategetDay()
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
Inherited from
Bkper.Balance.getDaygetFuzzyDate()
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
Inherited from
Bkper.Balance.getFuzzyDategetMonth()
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
Inherited from
Bkper.Balance.getMonthgetPeriodBalance()
getPeriodBalance(): Amount;The balance on the date period, based on credit nature of the container.
Returns
Amount
Inherited from
Bkper.Balance.getPeriodBalancegetPeriodBalanceRaw()
getPeriodBalanceRaw(): Amount;The raw balance on the date period.
Returns
Amount
Inherited from
Bkper.Balance.getPeriodBalanceRawgetPeriodCredit()
getPeriodCredit(): Amount;The credit on the date period.
Returns
Amount
Inherited from
Bkper.Balance.getPeriodCreditgetPeriodDebit()
getPeriodDebit(): Amount;The debit on the date period.
Returns
Amount
Inherited from
Bkper.Balance.getPeriodDebitgetYear()
getYear(): number;The year of the balance
Returns
number
Inherited from
Bkper.Balance.getYearjson()
json(): Balance;Gets an immutable copy of the JSON payload for this resource.
Returns
Balance
An immutable copy of the json payload
Inherited from
Bkper.Balance.json