# Book

## Extends

- `Book`

### accounts?

```ts
optional accounts: Account[];
```

The book Accounts

#### Inherited from

```ts
bkper.Book.accounts
```

***

### agentId?

```ts
optional agentId: string;
```

The id of agent that created the resource

#### Inherited from

```ts
bkper.Book.agentId
```

***

### autoPost?

```ts
optional autoPost: boolean;
```

Tells if the Book has auto post enabled

#### Inherited from

```ts
bkper.Book.autoPost
```

***

### closingDate?

```ts
optional closingDate: string;
```

The book closing date, in ISO format yyyy-MM-dd. Transactions on or before this date are closed for the period

#### Inherited from

```ts
bkper.Book.closingDate
```

***

### collection?

```ts
optional collection: Collection;
```

#### Inherited from

```ts
bkper.Book.collection
```

***

### createdAt?

```ts
optional createdAt: string;
```

The creation timestamp, in milliseconds

#### Inherited from

```ts
bkper.Book.createdAt
```

***

### datePattern?

```ts
optional datePattern: string;
```

The date pattern of the Book. Example: dd/MM/yyyy

#### Inherited from

```ts
bkper.Book.datePattern
```

***

### decimalSeparator?

```ts
optional decimalSeparator: "DOT" | "COMMA";
```

The decimal separator of the Book

#### Inherited from

```ts
bkper.Book.decimalSeparator
```

***

### fractionDigits?

```ts
optional fractionDigits: number;
```

The number of fraction digits (decimal places) of the Book. E.g. 2 for ####.##, 4 for ####.####

#### Inherited from

```ts
bkper.Book.fractionDigits
```

***

### groups?

```ts
optional groups: Group[];
```

The book account Groups

#### Inherited from

```ts
bkper.Book.groups
```

***

### id?

```ts
optional id: string;
```

The unique id that identifies the Book in the system. Found at bookId url param

#### Inherited from

```ts
bkper.Book.id
```

***

### lastUpdateMs?

```ts
optional lastUpdateMs: string;
```

The last update date of the Book, in milliseconds

#### Inherited from

```ts
bkper.Book.lastUpdateMs
```

***

### lockDate?

```ts
optional lockDate: string;
```

The book lock date, in ISO format yyyy-MM-dd. Transactions on or before this date are locked

#### Inherited from

```ts
bkper.Book.lockDate
```

***

### logoUrl?

```ts
optional logoUrl: string;
```

The logo URL of the book owner's custom domain

#### Inherited from

```ts
bkper.Book.logoUrl
```

***

### name?

```ts
optional name: string;
```

The name of the Book

#### Inherited from

```ts
bkper.Book.name
```

***

### ownerName?

```ts
optional ownerName: string;
```

The Book owner username

#### Inherited from

```ts
bkper.Book.ownerName
```

***

### pageSize?

```ts
optional pageSize: number;
```

The transactions pagination page size

#### Inherited from

```ts
bkper.Book.pageSize
```

***

### period?

```ts
optional period: "MONTH" | "QUARTER" | "YEAR";
```

The period slice for balances visualization

#### Inherited from

```ts
bkper.Book.period
```

***

### periodStartMonth?

```ts
optional periodStartMonth: 
  | "JANUARY"
  | "FEBRUARY"
  | "MARCH"
  | "APRIL"
  | "MAY"
  | "JUNE"
  | "JULY"
  | "AUGUST"
  | "SEPTEMBER"
  | "OCTOBER"
  | "NOVEMBER"
  | "DECEMBER";
```

The start month when YEAR period set

#### Inherited from

```ts
bkper.Book.periodStartMonth
```

***

### permission?

```ts
optional permission: "OWNER" | "EDITOR" | "POSTER" | "RECORDER" | "VIEWER" | "NONE";
```

The Permission the current user has in the Book

#### Inherited from

```ts
bkper.Book.permission
```

***

### properties?

```ts
optional properties: object;
```

The key/value custom properties of the Book

#### Index Signature

```ts
[name: string]: string
```

#### Inherited from

```ts
bkper.Book.properties
```

***

### timeZone?

```ts
optional timeZone: string;
```

The time zone of the Book, in IANA format. E.g. America/New_York, Europe/London

#### Inherited from

```ts
bkper.Book.timeZone
```

***

### timeZoneOffset?

```ts
optional timeZoneOffset: number;
```

The time zone offset of the Book, in minutes

#### Inherited from

```ts
bkper.Book.timeZoneOffset
```

***

### totalTransactions?

```ts
optional totalTransactions: number;
```

The total transactions posted

#### Inherited from

```ts
bkper.Book.totalTransactions
```

***

### totalTransactionsCurrentMonth?

```ts
optional totalTransactionsCurrentMonth: number;
```

The total transactions posted on current month

#### Inherited from

```ts
bkper.Book.totalTransactionsCurrentMonth
```

***

### totalTransactionsCurrentYear?

```ts
optional totalTransactionsCurrentYear: number;
```

The total transactions posted on current year

#### Inherited from

```ts
bkper.Book.totalTransactionsCurrentYear
```

***

### updatedAt?

```ts
optional updatedAt: string;
```

The last update timestamp, in milliseconds

#### Inherited from

```ts
bkper.Book.updatedAt
```

***

### visibility?

```ts
optional visibility: "PUBLIC" | "PRIVATE";
```

The Visibility of the Book

#### Inherited from

```ts
bkper.Book.visibility
```