Book

Extends

• Book

Properties

accounts?

optional accounts: Account[];

The book Accounts

Inherited from

bkper.Book.accounts

---

agentId?

optional agentId: string;

The id of agent that created the resource

Inherited from

bkper.Book.agentId

---

autoPost?

optional autoPost: boolean;

Tells if the Book has auto post enabled

Inherited from

bkper.Book.autoPost

---

closingDate?

optional closingDate: string;

The book closing date

Inherited from

bkper.Book.closingDate

---

collection?

optional collection: Collection;

Inherited from

bkper.Book.collection

---

createdAt?

optional createdAt: string;

The creation timestamp, in milliseconds

Inherited from

bkper.Book.createdAt

---

datePattern?

optional datePattern: string;

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

Inherited from

bkper.Book.datePattern

---

decimalSeparator?

optional decimalSeparator: "DOT" | "COMMA";

The decimal separator of the Book

Inherited from

bkper.Book.decimalSeparator

---

fractionDigits?

optional fractionDigits: number;

The number of fraction digits (decimal places) of the Book

Inherited from

bkper.Book.fractionDigits

---

groups?

optional groups: Group[];

The book account Groups

Inherited from

bkper.Book.groups

---

id?

optional id: string;

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

Inherited from

bkper.Book.id

---

lastUpdateMs?

optional lastUpdateMs: string;

The last update date of the Book, in in milliseconds

Inherited from

bkper.Book.lastUpdateMs

---

lockDate?

optional lockDate: string;

The book lock date

Inherited from

bkper.Book.lockDate

---

name?

optional name: string;

The name of the Book

Inherited from

bkper.Book.name

---

ownerName?

optional ownerName: string;

The Book owner username

Inherited from

bkper.Book.ownerName

---

pageSize?

optional pageSize: number;

The transactions pagination page size

Inherited from

bkper.Book.pageSize

---

period?

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

The period slice for balances visualization

Inherited from

bkper.Book.period

---

periodStartMonth?

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

The start month when YEAR period set

Inherited from

bkper.Book.periodStartMonth

---

permission?

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

The Permission the current user has in the Book

Inherited from

bkper.Book.permission

---

properties?

optional properties: object;

The key/value custom properties of the Book

Index Signature

[name: string]: string

Inherited from

bkper.Book.properties

---

timeZone?

optional timeZone: string;

The time zone of the Book

Inherited from

bkper.Book.timeZone

---

timeZoneOffset?

optional timeZoneOffset: number;

The time zone offset of the Book, in minutes

Inherited from

bkper.Book.timeZoneOffset

---

totalTransactions?

optional totalTransactions: number;

The total transactions posted

Inherited from

bkper.Book.totalTransactions

---

totalTransactionsCurrentMonth?

optional totalTransactionsCurrentMonth: number;

The total transactions posted on current month

Inherited from

bkper.Book.totalTransactionsCurrentMonth

---

totalTransactionsCurrentYear?

optional totalTransactionsCurrentYear: number;

The total transactions posted on current year

Inherited from

bkper.Book.totalTransactionsCurrentYear

---

updatedAt?

optional updatedAt: string;

The last update timestamp, in milliseconds

Inherited from

bkper.Book.updatedAt

---

visibility?

optional visibility: "PUBLIC" | "PRIVATE";

The Visibility of the Book

Inherited from

bkper.Book.visibility