BalancesReport

Extends

• BalancesReport

Properties

payload

payload: Balances;

The underlying payload data for this resource

Inherited from

Bkper.BalancesReport.payload

Methods

createDataTable()

createDataTable(): BalancesDataTableBuilder;

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

Returns

BalancesDataTableBuilder

Inherited from

Bkper.BalancesReport.createDataTable

---

getAccountBalancesContainers()

getAccountBalancesContainers(): BalancesContainer[];

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

Returns

BalancesContainer[]

Inherited from

Bkper.BalancesReport.getAccountBalancesContainers

---

getBalancesContainer()

getBalancesContainer(name): BalancesContainer;

Gets a specific [[BalancesContainer]].

Parameters

Parameter	Type
name	string

Returns

BalancesContainer

Inherited from

Bkper.BalancesReport.getBalancesContainer

---

getBalancesContainers()

getBalancesContainers(): BalancesContainer[];

Gets all [[BalancesContainers]] of the report.

Returns

BalancesContainer[]

Inherited from

Bkper.BalancesReport.getBalancesContainers

---

getBook()

getBook(): Book;

The [[Book]] that generated the report.

Returns

Book

Inherited from

Bkper.BalancesReport.getBook

---

getPeriodicity()

getPeriodicity(): Periodicity;

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

Returns

Periodicity

Inherited from

Bkper.BalancesReport.getPeriodicity

---

hasOnlyOneGroup()

hasOnlyOneGroup(): boolean;

Check if the report has only one Group specified on query.

Returns

boolean

Inherited from

Bkper.BalancesReport.hasOnlyOneGroup

---

json()

json(): Balances;

Gets an immutable copy of the JSON payload for this resource.

Returns

Balances

An immutable copy of the json payload

Inherited from

Bkper.BalancesReport.json