Skip to content

BalancesReport

Class representing a Balance Report, generated when calling Book.getBalanceReport

Constructors

Constructor

new BalancesReport(book, payload): BalancesReport;

Parameters

ParameterType
bookBook
payloadBalances

Returns

BalancesReport

Properties

payload

payload: Balances;

Methods

createDataTable()

createDataTable(): BalancesDataTableBuilder;

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

Returns

BalancesDataTableBuilder


getBalancesContainer()

getBalancesContainer(name): BalancesContainer;

Gets a specific [[BalancesContainer]].

Parameters

ParameterTypeDescription
namestringThe [[Account]] or [[Group]] name

Returns

BalancesContainer

The retrieved [[BalancesContainer]]


getBalancesContainers()

getBalancesContainers(): BalancesContainer[];

Gets all [[BalancesContainers]] of the report.

Returns

BalancesContainer[]

All [[BalancesContainers]] of the report


getBook()

getBook(): Book;

Gets the [[Book]] that generated the report.

Returns

Book

The [[Book]] that generated the report


getPeriodicity()

getPeriodicity(): Periodicity;

Gets the [[Periodicity]] of the query used to generate the report.

Returns

Periodicity

The [[Periodicity]] of the query used to generate the report