# Book

## Extends

- `Book`

### payload

```ts
payload: Book;
```

The underlying payload data for this resource

#### Inherited from

```ts
Bkper.Book.payload
```

### addCollaborator()

```ts
addCollaborator(email, permission): void;
```

Adds a collaborator to the Book.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `email` | `string` |
| `permission` | [`Permission`](https://bkper.com/docs/api/bkper-gs/enumerations/permission.md) |

#### Returns

`void`

#### Inherited from

```ts
Bkper.Book.addCollaborator
```

***

### audit()

```ts
audit(): void;
```

Trigger Balances Audit async process.

#### Returns

`void`

#### Inherited from

```ts
Bkper.Book.audit
```

***

### batchCheckTransactions()

```ts
batchCheckTransactions(transactions): void;
```

Batch check [[Transactions]] on the Book.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `transactions` | `Transaction`[] |

#### Returns

`void`

#### Inherited from

```ts
Bkper.Book.batchCheckTransactions
```

***

### batchCreateAccounts()

```ts
batchCreateAccounts(accounts): Account[];
```

Create [[Accounts]] on the Book, in batch.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `accounts` | `Account`[] |

#### Returns

`Account`[]

The Accounts created

#### Inherited from

```ts
Bkper.Book.batchCreateAccounts
```

***

### batchCreateGroups()

```ts
batchCreateGroups(groups): Group[];
```

Create [[Groups]] on the Book, in batch.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `groups` | `Group`[] |

#### Returns

`Group`[]

The Groups created

#### Inherited from

```ts
Bkper.Book.batchCreateGroups
```

***

### batchCreateTransactions()

```ts
batchCreateTransactions(transactions): Transaction[];
```

Batch create [[Transactions]] on the Book.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `transactions` | `Transaction`[] |

#### Returns

`Transaction`[]

The Transactions created

#### Inherited from

```ts
Bkper.Book.batchCreateTransactions
```

***

### batchTrashTransactions()

```ts
batchTrashTransactions(transactions, trashChecked?): void;
```

Batch trash [[Transactions]] on the Book.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `transactions` | `Transaction`[] |
| `trashChecked?` | `boolean` |

#### Returns

`void`

#### Inherited from

```ts
Bkper.Book.batchTrashTransactions
```

***

### batchUncheckTransactions()

```ts
batchUncheckTransactions(transactions): void;
```

Batch uncheck [[Transactions]] on the Book.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `transactions` | `Transaction`[] |

#### Returns

`void`

#### Inherited from

```ts
Bkper.Book.batchUncheckTransactions
```

***

### batchUpdateTransactions()

```ts
batchUpdateTransactions(transactions, updateChecked?): void;
```

Batch update [[Transactions]] on the Book.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `transactions` | `Transaction`[] |
| `updateChecked?` | `boolean` |

#### Returns

`void`

#### Inherited from

```ts
Bkper.Book.batchUpdateTransactions
```

***

### continueTransactionIterator()

```ts
continueTransactionIterator(query, continuationToken): TransactionIterator;
```

Resumes a transaction iteration using a continuation token from a previous iterator.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `query` | `string` |
| `continuationToken` | `string` |

#### Returns

`TransactionIterator`

a collection of transactions that remained in a previous iterator when the continuation token was generated

#### Inherited from

```ts
Bkper.Book.continueTransactionIterator
```

***

### countTransactions()

```ts
countTransactions(query?): number;
```

Retrieve the number of transactions based on a query.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `query?` | `string` |

#### Returns

`number`

The number of matching Transactions

#### Inherited from

```ts
Bkper.Book.countTransactions
```

***

### ~~createAccount()~~

```ts
createAccount(
   name, 
   group?, 
   description?): Account;
```

Create an [[Account]] in this book.

The type of account will be determined by the type of others Accounts in same group.

If not specified, the type ASSET (permanent=true/credit=false) will be set.

If all other accounts in same group is in another group, the account will also be added to the other group.

> **Caution: Deprecated**
> This API is no longer supported and may be removed in a future release.
#### Parameters

| Parameter | Type |
| :------ | :------ |
| `name` | `string` |
| `group?` | `string` |
| `description?` | `string` |

#### Returns

`Account`

The created Account object

#### Inherited from

```ts
Bkper.Book.createAccount
```

***

### ~~createAccounts()~~

```ts
createAccounts(accounts): Account[];
```

Create [[Accounts]] on the Book, in batch.

The first column of the matrix will be used as the [[Account]] name.

The other columns will be used to find a matching [[AccountType]].

Names matching existent accounts will be skipped.

> **Caution: Deprecated**
> This API is no longer supported and may be removed in a future release.
#### Parameters

| Parameter | Type |
| :------ | :------ |
| `accounts` | `string`[][] |

#### Returns

`Account`[]

#### Inherited from

```ts
Bkper.Book.createAccounts
```

***

### createAccountsDataTable()

```ts
createAccountsDataTable(group?): AccountsDataTableBuilder;
```

Create a [[AccountsDataTableBuilder]], to build two dimensional Array representations of [[Accounts]] dataset.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `group?` | `string` |

#### Returns

`AccountsDataTableBuilder`

Accounts data table builder.

Example:

```js
var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgPXjx7oKDA");

var accountsDataTable = book.createAccountsDataTable().build();

// Or filter by group
var filteredDataTable = book.createAccountsDataTable("Revenue").build();
```

#### Inherited from

```ts
Bkper.Book.createAccountsDataTable
```

***

### createBalancesDataTable()

```ts
createBalancesDataTable(query): BalancesDataTableBuilder;
```

Create a [[BalancesDataTableBuilder]] based on a query, to create two dimensional Array representation of balances of [[Account]] or [[Group]]

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `query` | `string` |

#### Returns

`BalancesDataTableBuilder`

The balances data table builder

Example:

```js
var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgPXjx7oKDA");

var balancesDataTable = book.createBalancesDataTable("account:'Credit card' after:7/2018 before:8/2018").build();
```

#### Inherited from

```ts
Bkper.Book.createBalancesDataTable
```

***

### ~~createGroups()~~

```ts
createGroups(groups): Group[];
```

Create [[Groups]] on the Book, in batch.

> **Caution: Deprecated**
> This API is no longer supported and may be removed in a future release.
#### Parameters

| Parameter | Type |
| :------ | :------ |
| `groups` | `string`[] |

#### Returns

`Group`[]

#### Inherited from

```ts
Bkper.Book.createGroups
```

***

### createGroupsDataTable()

```ts
createGroupsDataTable(): GroupsDataTableBuilder;
```

Create a [[GroupsDataTableBuilder]], to build two dimensional Array representations of [[Groups]] dataset.

#### Returns

`GroupsDataTableBuilder`

Groups data table builder.

Example:

```js
var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgPXjx7oKDA");

var groupsDataTable = book.createGroupsDataTable().build();
```

#### Inherited from

```ts
Bkper.Book.createGroupsDataTable
```

***

### createTransactionsDataTable()

```ts
createTransactionsDataTable(query?): TransactionsDataTableBuilder;
```

Create a [[TransactionsDataTableBuilder]] based on a query, to build two dimensional Array representations of [[Transactions]] dataset.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `query?` | `string` |

#### Returns

`TransactionsDataTableBuilder`

Transactions data table builder.

Example:

```js
var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgPXjx7oKDA");

var transactionsDataTable = book.createTransactionsDataTable("account:'Bank Account' before:1/2019").build();
```

#### Inherited from

```ts
Bkper.Book.createTransactionsDataTable
```

***

### deleteProperty()

```ts
deleteProperty(key): this;
```

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `key` | `string` |

#### Returns

`this`

#### Inherited from

```ts
Bkper.Book.deleteProperty
```

***

### formatAmount()

```ts
formatAmount(amount): string;
```

Formats an amount according to [[DecimalSeparator]] and fraction digits of the Book.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `amount` | `Amount` |

#### Returns

`string`

The value formated

#### Inherited from

```ts
Bkper.Book.formatAmount
```

***

### formatDate()

```ts
formatDate(date, timeZone?): string;
```

Formats a date according to date pattern of the Book.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `date` | `Date` |
| `timeZone?` | `string` |

#### Returns

`string`

The date formated

#### Inherited from

```ts
Bkper.Book.formatDate
```

***

### ~~formatValue()~~

```ts
formatValue(value): string;
```

Formats a value according to [[DecimalSeparator]] and fraction digits of the Book.

> **Caution: Deprecated**
> This API is no longer supported and may be removed in a future release.
#### Parameters

| Parameter | Type |
| :------ | :------ |
| `value` | `Amount` |

#### Returns

`string`

The value formated

#### Inherited from

```ts
Bkper.Book.formatValue
```

***

### getAccount()

```ts
getAccount(idOrName): Account;
```

Gets an [[Account]] object

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `idOrName` | `string` |

#### Returns

`Account`

The matching Account object

#### Inherited from

```ts
Bkper.Book.getAccount
```

***

### getAccounts()

```ts
getAccounts(group?): Account[];
```

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `group?` | `string` |

#### Returns

`Account`[]

All [[Accounts]] of this Book, or filtered by group if specified

#### Inherited from

```ts
Bkper.Book.getAccounts
```

***

### getApps()

```ts
getApps(): App[];
```

Retrieve installed [[Apps]] for this Book

#### Returns

`App`[]

The Apps objects

#### Inherited from

```ts
Bkper.Book.getApps
```

***

### getBacklog()

```ts
getBacklog(): Backlog;
```

Retrieve the pending events [[Backlog]] for this Book

#### Returns

`Backlog`

The Backlog object

#### Inherited from

```ts
Bkper.Book.getBacklog
```

***

### getBalancesReport()

```ts
getBalancesReport(query): BalancesReport;
```

Create a [[BalancesReport]] based on query

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `query` | `string` |

#### Returns

`BalancesReport`

The balances report

Example:

```js
var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgPXjx7oKDA");

var balancesReport = book.getBalancesReport("group:'Equity' after:7/2018 before:8/2018");

var accountBalance = balancesReport.getBalancesContainer("Bank Account").getCumulativeBalance();
```

#### Inherited from

```ts
Bkper.Book.getBalancesReport
```

***

### getClosingDate()

```ts
getClosingDate(): string;
```

#### Returns

`string`

The closing date of the Book in ISO format yyyy-MM-dd

#### Inherited from

```ts
Bkper.Book.getClosingDate
```

***

### getCollection()

```ts
getCollection(): Collection;
```

#### Returns

`Collection`

The collection of this book

#### Inherited from

```ts
Bkper.Book.getCollection
```

***

### getDatePattern()

```ts
getDatePattern(): string;
```

#### Returns

`string`

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

#### Inherited from

```ts
Bkper.Book.getDatePattern
```

***

### getDecimalSeparator()

```ts
getDecimalSeparator(): DecimalSeparator;
```

#### Returns

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

The decimal separator of the Book

#### Inherited from

```ts
Bkper.Book.getDecimalSeparator
```

***

### getEvents()

```ts
getEvents(
   afterDate?, 
   beforeDate?, 
   onError?, 
   resource?): EventIterator;
```

Get Book events based on search parameters.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `afterDate?` | `string` |
| `beforeDate?` | `string` |
| `onError?` | `boolean` |
| `resource?` | `Account` \| `Group` \| `Transaction` |

#### Returns

`EventIterator`

The Events result as an iterator.

#### Inherited from

```ts
Bkper.Book.getEvents
```

***

### getFile()

```ts
getFile(id): File;
```

Retrieve a [[File]] by id

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `id` | `string` |

#### Returns

`File`

The matching File object

#### Inherited from

```ts
Bkper.Book.getFile
```

***

### getFiles()

```ts
getFiles(): FileIterator;
```

Gets all files uploaded to this Book.

#### Returns

`FileIterator`

A FileIterator to iterate over files

#### Inherited from

```ts
Bkper.Book.getFiles
```

***

### getFractionDigits()

```ts
getFractionDigits(): number;
```

#### Returns

`number`

The number of fraction digits (decimal places) supported by this Book

#### Inherited from

```ts
Bkper.Book.getFractionDigits
```

***

### getGroup()

```ts
getGroup(idOrName): Group;
```

Gets a [[Group]] object

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `idOrName` | `string` |

#### Returns

`Group`

The matching Group object

#### Inherited from

```ts
Bkper.Book.getGroup
```

***

### getGroups()

```ts
getGroups(): Group[];
```

#### Returns

`Group`[]

All [[Groups]] of this Book

#### Inherited from

```ts
Bkper.Book.getGroups
```

***

### getId()

```ts
getId(): string;
```

Same as bookId param

#### Returns

`string`

The id of this Book

#### Inherited from

```ts
Bkper.Book.getId
```

***

### getLastUpdateMs()

```ts
getLastUpdateMs(): number;
```

#### Returns

`number`

The last update date of the book, in in milliseconds

#### Inherited from

```ts
Bkper.Book.getLastUpdateMs
```

***

### getLockDate()

```ts
getLockDate(): string;
```

#### Returns

`string`

The lock date of the Book in ISO format yyyy-MM-dd

#### Inherited from

```ts
Bkper.Book.getLockDate
```

***

### getName()

```ts
getName(): string;
```

#### Returns

`string`

The name of this Book

#### Inherited from

```ts
Bkper.Book.getName
```

***

### getOwnerName()

```ts
getOwnerName(): string;
```

#### Returns

`string`

The name of the owner of the Book

#### Inherited from

```ts
Bkper.Book.getOwnerName
```

***

### getPeriodStartMonth()

```ts
getPeriodStartMonth(): Month;
```

#### Returns

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

The start month when YEAR period set

#### Inherited from

```ts
Bkper.Book.getPeriodStartMonth
```

***

### getPermission()

```ts
getPermission(): Permission;
```

#### Returns

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

The permission for the current user

#### Inherited from

```ts
Bkper.Book.getPermission
```

***

### getProperties()

```ts
getProperties(): object;
```

#### Returns

`object`

#### Inherited from

```ts
Bkper.Book.getProperties
```

***

### getProperty()

```ts
getProperty(...keys): string;
```

#### Parameters

| Parameter | Type |
| :------ | :------ |
| ...`keys` | `string`[] |

#### Returns

`string`

#### Inherited from

```ts
Bkper.Book.getProperty
```

***

### getPropertyKeys()

```ts
getPropertyKeys(): string[];
```

#### Returns

`string`[]

#### Inherited from

```ts
Bkper.Book.getPropertyKeys
```

***

### getSavedQueries()

```ts
getSavedQueries(): object[];
```

#### Returns

`object`[]

All saved queries from this book

#### Inherited from

```ts
Bkper.Book.getSavedQueries
```

***

### getTimeZone()

```ts
getTimeZone(): string;
```

#### Returns

`string`

The time zone of the Book

#### Inherited from

```ts
Bkper.Book.getTimeZone
```

***

### getTimeZoneOffset()

```ts
getTimeZoneOffset(): number;
```

#### Returns

`number`

The time zone offset of the book, in minutes

#### Inherited from

```ts
Bkper.Book.getTimeZoneOffset
```

***

### getTotalTransactions()

```ts
getTotalTransactions(): number;
```

#### Returns

`number`

The total number of posted transactions

#### Inherited from

```ts
Bkper.Book.getTotalTransactions
```

***

### getTotalTransactionsCurrentMonth()

```ts
getTotalTransactionsCurrentMonth(): number;
```

#### Returns

`number`

The total number of posted transactions on current month

#### Inherited from

```ts
Bkper.Book.getTotalTransactionsCurrentMonth
```

***

### getTotalTransactionsCurrentYear()

```ts
getTotalTransactionsCurrentYear(): number;
```

#### Returns

`number`

The total number of posted transactions on current year

#### Inherited from

```ts
Bkper.Book.getTotalTransactionsCurrentYear
```

***

### getTransaction()

```ts
getTransaction(id): Transaction;
```

Retrieve a [[Transaction]] by id

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `id` | `string` |

#### Returns

`Transaction`

The matching Transaction object

#### Inherited from

```ts
Bkper.Book.getTransaction
```

***

### getTransactions()

```ts
getTransactions(query?): TransactionIterator;
```

Get Book transactions based on a query.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `query?` | `string` |

#### Returns

`TransactionIterator`

The Transactions result as an iterator.

Example:

```js
var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");

var transactions = book.getTransactions("account:CreditCard after:28/01/2013 before:29/01/2013");

while (transactions.hasNext()) {
 var transaction = transactions.next();
 Logger.log(transaction.getDescription());
}
```

#### Inherited from

```ts
Bkper.Book.getTransactions
```

***

### getVisibleProperties()

```ts
getVisibleProperties(): object;
```

#### Returns

`object`

#### Inherited from

```ts
Bkper.Book.getVisibleProperties
```

***

### json()

```ts
json(): Book;
```

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

#### Returns

`Book`

An immutable copy of the json payload

#### Inherited from

```ts
Bkper.Book.json
```

***

### mergeTransactions()

```ts
mergeTransactions(transaction1, transaction2): Transaction;
```

Merge two [[Transactions]] into one.

The merged transaction is created synchronously. Cleanup of the two
originals is scheduled asynchronously by the backend.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `transaction1` | `Transaction` |
| `transaction2` | `Transaction` |

#### Returns

`Transaction`

The merged Transaction

#### Inherited from

```ts
Bkper.Book.mergeTransactions
```

***

### newAccount()

```ts
newAccount(): Account;
```

Instantiate a new [[Account]]

#### Returns

`Account`

The new Account, for chainning.

Example:
```js
var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");

book.newAccount()
 .setName('Some New Account')
 .setType('INCOMING')
 .addGroup('Revenue').addGroup('Salary')
 .setProperties({prop_a: 'A', prop_b: 'B'})
 .create();
```

#### Inherited from

```ts
Bkper.Book.newAccount
```

***

### newFile()

```ts
newFile(): File;
```

Instantiate a new [[File]]

#### Returns

`File`

The new File, for chainning.

Example:
```js
var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");

book.newFile()
 .setBlob(UrlFetchApp.fetch('https://bkper.com/images/index/integrations4.png').getBlob())
 .create();
```

#### Inherited from

```ts
Bkper.Book.newFile
```

***

### newGroup()

```ts
newGroup(): Group;
```

Instantiate a new [[Group]]

#### Returns

`Group`

The new Group, for chainning.

Example:
```js
var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");

book.newGroup()
 .setName('Some New Group')
 .setProperty('key', 'value')
 .create();
```

#### Inherited from

```ts
Bkper.Book.newGroup
```

***

### newTransaction()

```ts
newTransaction(): Transaction;
```

Instantiate a new [[Transaction]]

#### Returns

`Transaction`

The new Transaction, for chainning.

Example:

```js
var book = BkperApp.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");

book.newTransaction()
 .setDate('2013-01-25')
 .setDescription("Filling tank of my truck")
 .from('Credit Card')
 .to('Gas')
 .setAmount(126.50)
 .create();

```

#### Inherited from

```ts
Bkper.Book.newTransaction
```

***

### parseAmount()

```ts
parseAmount(value): Amount;
```

Parse an amount string according to [[DecimalSeparator]] and fraction digits of the Book.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `value` | `string` |

#### Returns

`Amount`

The Amount parsed

#### Inherited from

```ts
Bkper.Book.parseAmount
```

***

### parseDate()

```ts
parseDate(date): Date;
```

Parse a date string according to date pattern and timezone of the Book.

Also parse ISO yyyy-mm-dd format.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `date` | `string` |

#### Returns

`Date`

The date parsed

#### Inherited from

```ts
Bkper.Book.parseDate
```

***

### ~~parseValue()~~

```ts
parseValue(value): Amount;
```

Parse a value string according to [[DecimalSeparator]] and fraction digits of the Book.

> **Caution: Deprecated**
> This API is no longer supported and may be removed in a future release.
#### Parameters

| Parameter | Type |
| :------ | :------ |
| `value` | `string` |

#### Returns

`Amount`

#### Inherited from

```ts
Bkper.Book.parseValue
```

***

### ~~record()~~

```ts
record(transactions, timeZone?): void;
```

Record [[Transactions]] on the Book.

The text is usually amount and description, but it can also can contain an informed Date in full format (dd/mm/yyyy - mm/dd/yyyy).

Example:

```js
book.record("#gas 63.23");
```

> **Caution: Deprecated**
> This API is no longer supported and may be removed in a future release.
#### Parameters

| Parameter | Type |
| :------ | :------ |
| `transactions` | `string` \| `any`[] \| `any`[][] |
| `timeZone?` | `string` |

#### Returns

`void`

#### Inherited from

```ts
Bkper.Book.record
```

***

### removeCollaborator()

```ts
removeCollaborator(email): void;
```

Removes a collaborator from the Book.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `email` | `string` |

#### Returns

`void`

#### Inherited from

```ts
Bkper.Book.removeCollaborator
```

***

### round()

```ts
round(amount): Amount;
```

Rounds an amount according to the number of fraction digits of the Book

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `amount` | `Amount` |

#### Returns

`Amount`

The Amount rounded

#### Inherited from

```ts
Bkper.Book.round
```

***

### setClosingDate()

```ts
setClosingDate(closingDate): Book;
```

Sets the closing date of the Book in ISO format yyyy-MM-dd.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `closingDate` | `string` \| `null` |

#### Returns

`Book`

This Book, for chainning.

#### Inherited from

```ts
Bkper.Book.setClosingDate
```

***

### setDatePattern()

```ts
setDatePattern(datePattern): Book;
```

Sets the date pattern of the Book. Current: dd/MM/yyyy | MM/dd/yyyy | yyyy/MM/dd

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `datePattern` | `string` |

#### Returns

`Book`

This Book, for chainning.

#### Inherited from

```ts
Bkper.Book.setDatePattern
```

***

### setDecimalSeparator()

```ts
setDecimalSeparator(decimalSeparator): Book;
```

Sets the decimal separator of the Book

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `decimalSeparator` | [`DecimalSeparator`](https://bkper.com/docs/api/bkper-gs/enumerations/decimalseparator.md) |

#### Returns

`Book`

This Book, for chainning.

#### Inherited from

```ts
Bkper.Book.setDecimalSeparator
```

***

### setFractionDigits()

```ts
setFractionDigits(fractionDigits): Book;
```

Sets the number of fraction digits (decimal places) supported by this Book

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `fractionDigits` | `number` |

#### Returns

`Book`

This Book, for chainning.

#### Inherited from

```ts
Bkper.Book.setFractionDigits
```

***

### setLockDate()

```ts
setLockDate(lockDate): Book;
```

Sets the lock date of the Book in ISO format yyyy-MM-dd.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `lockDate` | `string` \| `null` |

#### Returns

`Book`

This Book, for chainning.

#### Inherited from

```ts
Bkper.Book.setLockDate
```

***

### setName()

```ts
setName(name): Book;
```

Sets the name of the Book.

#### Parameters

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

#### Returns

`Book`

This Book, for chainning.

#### Inherited from

```ts
Bkper.Book.setName
```

***

### setPeriodStartMonth()

```ts
setPeriodStartMonth(month): Book;
```

Sets the start month when YEAR period set

#### Parameters

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

#### Returns

`Book`

This Book, for chainning.

#### Inherited from

```ts
Bkper.Book.setPeriodStartMonth
```

***

### setProperties()

```ts
setProperties(properties): this;
```

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `properties` | \{ \[`key`: `string`\]: `string`; \} |

#### Returns

`this`

#### Inherited from

```ts
Bkper.Book.setProperties
```

***

### setProperty()

```ts
setProperty(key, value): this;
```

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `key` | `string` |
| `value` | `string` |

#### Returns

`this`

#### Inherited from

```ts
Bkper.Book.setProperty
```

***

### setTimeZone()

```ts
setTimeZone(timeZone): Book;
```

Sets the time zone of the Book

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `timeZone` | `string` |

#### Returns

`Book`

This Book, for chainning.

#### Inherited from

```ts
Bkper.Book.setTimeZone
```

***

### setVisibleProperties()

```ts
setVisibleProperties(properties): this;
```

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `properties` | \{ \[`key`: `string`\]: `string`; \} |

#### Returns

`this`

#### Inherited from

```ts
Bkper.Book.setVisibleProperties
```

***

### setVisibleProperty()

```ts
setVisibleProperty(key, value): this;
```

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `key` | `string` |
| `value` | `string` \| `null` |

#### Returns

`this`

#### Inherited from

```ts
Bkper.Book.setVisibleProperty
```

***

### update()

```ts
update(): Book;
```

Perform update Book, applying pending changes.

#### Returns

`Book`

This Book, for chainning.

#### Inherited from

```ts
Bkper.Book.update
```