# BalancesDataTableBuilder

## Extends

- `BalancesDataTableBuilder`

### build()

```ts
build(): any[][];
```

Builds an two-dimensional array with the balances.

#### Returns

`any`[][]

#### Inherited from

```ts
Bkper.BalancesDataTableBuilder.build
```

***

### expanded()

```ts
expanded(expanded): BalancesDataTableBuilder;
```

Defines whether Groups should expand its child accounts.

true to expand itself
-1 to expand all subgroups
-2 to expand all accounts
0 to expand nothing
1 to expand itself and its first level of children
2 to expand itself and its first two levels of children
etc.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `expanded` | `number` \| `boolean` |

#### Returns

`BalancesDataTableBuilder`

This builder with respective expanded option, for chaining.

#### Inherited from

```ts
Bkper.BalancesDataTableBuilder.expanded
```

***

### formatDates()

```ts
formatDates(format): BalancesDataTableBuilder;
```

Defines whether the dates should be ISO YYYY-MM-DD formatted.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `format` | `boolean` |

#### Returns

`BalancesDataTableBuilder`

This builder with respective formatting option, for chaining.

#### Inherited from

```ts
Bkper.BalancesDataTableBuilder.formatDates
```

***

### formatValues()

```ts
formatValues(format): BalancesDataTableBuilder;
```

Defines whether the value should be formatted based on decimal separator of the [[Book]].

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `format` | `boolean` |

#### Returns

`BalancesDataTableBuilder`

This builder with respective formatting option, for chaining.

#### Inherited from

```ts
Bkper.BalancesDataTableBuilder.formatValues
```

***

### hideDates()

```ts
hideDates(hide): BalancesDataTableBuilder;
```

Defines whether the dates should be hidden for **PERIOD** or **CUMULATIVE** [[BalanceType]].

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `hide` | `boolean` |

#### Returns

`BalancesDataTableBuilder`

This builder with respective hide dates option, for chaining.

#### Inherited from

```ts
Bkper.BalancesDataTableBuilder.hideDates
```

***

### hideNames()

```ts
hideNames(hide): BalancesDataTableBuilder;
```

Defines whether the [[Accounts]] and [[Groups]] names should be hidden.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `hide` | `boolean` |

#### Returns

`BalancesDataTableBuilder`

This builder with respective hide names option, for chaining.

#### Inherited from

```ts
Bkper.BalancesDataTableBuilder.hideNames
```

***

### period()

```ts
period(period): BalancesDataTableBuilder;
```

Defines whether should force use of period balances for **TOTAL** [[BalanceType]].

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `period` | `boolean` |

#### Returns

`BalancesDataTableBuilder`

This builder with respective trial option, for chaining.

#### Inherited from

```ts
Bkper.BalancesDataTableBuilder.period
```

***

### properties()

```ts
properties(include): BalancesDataTableBuilder;
```

Defines whether include custom [[Accounts]] and [[Groups]] properties.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `include` | `boolean` |

#### Returns

`BalancesDataTableBuilder`

This builder with respective include properties option, for chaining.

#### Inherited from

```ts
Bkper.BalancesDataTableBuilder.properties
```

***

### raw()

```ts
raw(raw): BalancesDataTableBuilder;
```

Defines whether should show raw balances, no matter the credit nature of the Account or Group.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `raw` | `boolean` |

#### Returns

`BalancesDataTableBuilder`

This builder with respective trial option, for chaining.

#### Inherited from

```ts
Bkper.BalancesDataTableBuilder.raw
```

***

### transposed()

```ts
transposed(transposed): BalancesDataTableBuilder;
```

Defines whether should rows and columns should be transposed.

For **TOTAL** [[BalanceType]], the **transposed** table looks like:

```
  _____________________________
 |  Expenses | Income  |  ...  |
 | -4568.23  | 5678.93 |  ...  |
 |___________|_________|_______|

```
Two rows, and each [[Account]] or [[Group]] per column.

For **PERIOD** or **CUMULATIVE** [[BalanceType]], the **transposed** table will be a time table, and the format looks like:

```
  _______________________________________________________________
 |            | Expenses   | Income     |     ...    |    ...    |
 | 15/01/2014 | -2345.23   |  3452.93   |     ...    |    ...    |
 | 15/02/2014 | -2345.93   |  3456.46   |     ...    |    ...    |
 | 15/03/2014 | -2456.45   |  3567.87   |     ...    |    ...    |
 |     ...    |     ...    |     ...    |     ...    |    ...    |
 |____________|____________|____________|____________|___________|

```

First column will be each [[Account]] or [[Group]], and one column for each Date.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `transposed` | `boolean` |

#### Returns

`BalancesDataTableBuilder`

This builder with respective transposed option, for chaining.

#### Inherited from

```ts
Bkper.BalancesDataTableBuilder.transposed
```

***

### trial()

```ts
trial(trial): BalancesDataTableBuilder;
```

Defines whether should split **TOTAL** [[BalanceType]] into debit and credit.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `trial` | `boolean` |

#### Returns

`BalancesDataTableBuilder`

This builder with respective trial option, for chaining.

#### Inherited from

```ts
Bkper.BalancesDataTableBuilder.trial
```

***

### type()

```ts
type(type): BalancesDataTableBuilder;
```

Fluent method to set the [[BalanceType]] for the builder.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `type` | [`BalanceType`](https://bkper.com/docs/api/bkper-gs/enumerations/balancetype.md) |

#### Returns

`BalancesDataTableBuilder`

This builder with respective balance type, for chaining.

#### Inherited from

```ts
Bkper.BalancesDataTableBuilder.type
```