# BalancesReport

## Extends

- `BalancesReport`

### payload

```ts
payload: Balances;
```

The underlying payload data for this resource

#### Inherited from

```ts
Bkper.BalancesReport.payload
```

### createDataTable()

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

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

#### Returns

`BalancesDataTableBuilder`

#### Inherited from

```ts
Bkper.BalancesReport.createDataTable
```

***

### getAccountBalancesContainers()

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

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

#### Returns

`BalancesContainer`[]

#### Inherited from

```ts
Bkper.BalancesReport.getAccountBalancesContainers
```

***

### getBalancesContainer()

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

Gets a specific [[BalancesContainer]].

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `name` | `string` |

#### Returns

`BalancesContainer`

#### Inherited from

```ts
Bkper.BalancesReport.getBalancesContainer
```

***

### getBalancesContainers()

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

Gets all [[BalancesContainers]] of the report.

#### Returns

`BalancesContainer`[]

#### Inherited from

```ts
Bkper.BalancesReport.getBalancesContainers
```

***

### getBook()

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

The [[Book]] that generated the report.

#### Returns

`Book`

#### Inherited from

```ts
Bkper.BalancesReport.getBook
```

***

### getPeriodicity()

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

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

#### Returns

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

#### Inherited from

```ts
Bkper.BalancesReport.getPeriodicity
```

***

### hasOnlyOneGroup()

```ts
hasOnlyOneGroup(): boolean;
```

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

#### Returns

`boolean`

#### Inherited from

```ts
Bkper.BalancesReport.hasOnlyOneGroup
```

***

### json()

```ts
json(): Balances;
```

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

#### Returns

`Balances`

An immutable copy of the json payload

#### Inherited from

```ts
Bkper.BalancesReport.json
```