# BalancesReport

Class representing a Balance Report, generated when calling [Book.getBalanceReport](#book_getbalancesreport)

### Constructor

```ts
new BalancesReport(book, payload): BalancesReport;
```

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `book` | [`Book`](https://bkper.com/docs/api/bkper-js/classes/book.md) |
| `payload` | `Balances` |

#### Returns

`BalancesReport`

### payload

```ts
payload: Balances;
```

### createDataTable()

```ts
createDataTable(): BalancesDataTableBuilder;
```

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

#### Returns

[`BalancesDataTableBuilder`](https://bkper.com/docs/api/bkper-js/classes/balancesdatatablebuilder.md)

***

### getBalancesContainer()

```ts
getBalancesContainer(name): BalancesContainer;
```

Gets a specific [[BalancesContainer]].

#### Parameters

| Parameter | Type | Description |
| :------ | :------ | :------ |
| `name` | `string` | The [[Account]] or [[Group]] name |

#### Returns

[`BalancesContainer`](https://bkper.com/docs/api/bkper-js/interfaces/balancescontainer.md)

The retrieved [[BalancesContainer]]

***

### getBalancesContainers()

```ts
getBalancesContainers(): BalancesContainer[];
```

Gets all [[BalancesContainers]] of the report.

#### Returns

[`BalancesContainer`](https://bkper.com/docs/api/bkper-js/interfaces/balancescontainer.md)[]

All [[BalancesContainers]] of the report

***

### getBook()

```ts
getBook(): Book;
```

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

#### Returns

[`Book`](https://bkper.com/docs/api/bkper-js/classes/book.md)

The [[Book]] that generated the report

***

### getPeriodicity()

```ts
getPeriodicity(): Periodicity;
```

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

#### Returns

[`Periodicity`](https://bkper.com/docs/api/bkper-js/enumerations/periodicity.md)

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