BalancesReport
Class representing a Balance Report, generated when calling Book.getBalanceReport
Constructors
Constructor
new BalancesReport(book, payload): BalancesReport;Parameters
| Parameter | Type |
|---|---|
book | Book |
payload | Balances |
Returns
BalancesReport
Properties
payload
payload: Balances;Methods
createDataTable()
createDataTable(): BalancesDataTableBuilder;Creates a BalancesDataTableBuilder to generate a two-dimensional array with all [[BalancesContainers]].
Returns
getBalancesContainer()
getBalancesContainer(name): BalancesContainer;Gets a specific [[BalancesContainer]].
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | The [[Account]] or [[Group]] name |
Returns
The retrieved [[BalancesContainer]]
getBalancesContainers()
getBalancesContainers(): BalancesContainer[];Gets all [[BalancesContainers]] of the report.
Returns
All [[BalancesContainers]] of the report
getBook()
getBook(): Book;Gets the [[Book]] that generated the report.
Returns
The [[Book]] that generated the report
getPeriodicity()
getPeriodicity(): Periodicity;Gets the [[Periodicity]] of the query used to generate the report.
Returns
The [[Periodicity]] of the query used to generate the report