bkper 4.12.5 → 4.12.7

package/lib/agent/system-prompt.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"system-prompt.d.ts","sourceRoot":"","sources":["../../src/agent/system-prompt.ts"],"names":[],"mappings":"AAaA,wBAAgB,yBAAyB,IAAI,MAAM,CAsBlD;AAED,eAAO,MAAM,yBAAyB,2lDAgCrC,CAAC"}
+{"version":3,"file":"system-prompt.d.ts","sourceRoot":"","sources":["../../src/agent/system-prompt.ts"],"names":[],"mappings":"AAQA,wBAAgB,yBAAyB,IAAI,MAAM,CAuClD;AAED,eAAO,MAAM,yBAAyB,2lDAgCrC,CAAC"}

package/lib/agent/system-prompt.js

@@ -1,34 +1,47 @@
 import { fileURLToPath } from 'node:url';
 import path from 'node:path';
-function resolveCliReferencePath() {
+function resolveDocPath(filename) {
     const thisDir = path.dirname(fileURLToPath(import.meta.url));
-    return path.resolve(thisDir, '..', 'docs', 'cli-reference.md');
-}
-function resolveCoreConceptsPath() {
-    const thisDir = path.dirname(fileURLToPath(import.meta.url));
-    return path.resolve(thisDir, '..', 'docs', 'core-concepts.md');
+    return path.resolve(thisDir, '..', 'docs', filename);
 }
 export function getBkperAgentSystemPrompt() {
-    const cliRefPath = resolveCliReferencePath();
-    const coreConceptsPath = resolveCoreConceptsPath();
+    const cliRefPath = resolveDocPath('cli-reference.md');
+    const coreConceptsPath = resolveDocPath('core-concepts.md');
+    const bkperJsPath = resolveDocPath('bkper-js.md');
+    const bkperApiTypesPath = resolveDocPath('bkper-api-types.md');
     return `${BKPER_AGENT_SYSTEM_PROMPT}
 ## Reference Routing
 
 - Read local \`AGENTS.md\`, nearby files, and existing tests first for project-specific work.
-- If the task touches Bkper accounting semantics or data modeling — such as Accounts, Transactions, balances, account types, groups, books, or mapping real-world flows into Bkper — read:
+- If the task touches Bkper accounting semantics or data modeling — such as Accounts, Transactions, balances, account types, groups, books, or mapping real-world flows into Bkper — read full file:
 
 \`\`\`
 ${coreConceptsPath}
 \`\`\`
 
-- If the task involves using, generating, or executing \`bkper\` CLI commands, read:
+- If the task involves using, generating, or executing \`bkper\` CLI commands, read full file:
 
 \`\`\`
 ${cliRefPath}
 \`\`\`
 
+- If the task involves writing, reviewing, or debugging code that uses the \`bkper-js\` library — such as Bkper, Book, Account, Transaction, Group classes, or any import from \`bkper-js\` — read both files:
+
+\`\`\`
+${bkperJsPath}
+\`\`\`
+
+\`\`\`
+${bkperApiTypesPath}
+\`\`\`
+
 - For generic engineering work, do not load Bkper reference docs unless directly relevant.
 - When scope is unclear, inspect local files and project instructions first; load reference docs only after identifying a concrete need.
+- For any other question about Bkper — product features, accounting guides, app architecture, integrations, or general usage — fetch and read:
+
+  https://bkper.com/llms.txt
+
+  Then follow the most relevant link to find the answer.
 `;
 }
 export const BKPER_AGENT_SYSTEM_PROMPT = `# Bkper Context

package/lib/agent/system-prompt.js.map

@@ -1 +1 @@
-{"version":3,"file":"system-prompt.js","sourceRoot":"","sources":["../../src/agent/system-prompt.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,SAAS,uBAAuB;IAC5B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,kBAAkB,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,uBAAuB;IAC5B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,kBAAkB,CAAC,CAAC;AACnE,CAAC;AAED,MAAM,UAAU,yBAAyB;IACrC,MAAM,UAAU,GAAG,uBAAuB,EAAE,CAAC;IAC7C,MAAM,gBAAgB,GAAG,uBAAuB,EAAE,CAAC;IACnD,OAAO,GAAG,yBAAyB;;;;;;;EAOrC,gBAAgB;;;;;;EAMhB,UAAU;;;;;CAKX,CAAC;AACF,CAAC;AAED,MAAM,CAAC,MAAM,yBAAyB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgCxC,CAAC"}
+{"version":3,"file":"system-prompt.js","sourceRoot":"","sources":["../../src/agent/system-prompt.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,SAAS,cAAc,CAAC,QAAgB;IACpC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AACzD,CAAC;AAED,MAAM,UAAU,yBAAyB;IACrC,MAAM,UAAU,GAAG,cAAc,CAAC,kBAAkB,CAAC,CAAC;IACtD,MAAM,gBAAgB,GAAG,cAAc,CAAC,kBAAkB,CAAC,CAAC;IAC5D,MAAM,WAAW,GAAG,cAAc,CAAC,aAAa,CAAC,CAAC;IAClD,MAAM,iBAAiB,GAAG,cAAc,CAAC,oBAAoB,CAAC,CAAC;IAC/D,OAAO,GAAG,yBAAyB;;;;;;;EAOrC,gBAAgB;;;;;;EAMhB,UAAU;;;;;;EAMV,WAAW;;;;EAIX,iBAAiB;;;;;;;;;;CAUlB,CAAC;AACF,CAAC;AAED,MAAM,CAAC,MAAM,yBAAyB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgCxC,CAAC"}

package/lib/commands/accounts/batch-create.js

@@ -26,7 +26,7 @@ export function batchCreateAccounts(bookId, items, propertyOverrides) {
         const book = yield bkper.getBook(bookId);
         const accounts = [];
         for (const item of items) {
-            const account = new Account(book, item);
+            const account = yield buildAccountFromStdin(book, item);
             // CLI --property flags override stdin properties
             if (propertyOverrides) {
                 for (const raw of propertyOverrides) {
@@ -46,4 +46,26 @@ export function batchCreateAccounts(bookId, items, propertyOverrides) {
         console.log(JSON.stringify(allResults, null, 2));
     });
 }
+function buildAccountFromStdin(book, item) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const payload = Object.assign({}, item);
+        const groupRefs = payload.groups;
+        delete payload.groups;
+        const account = new Account(book, payload);
+        if (groupRefs) {
+            for (const groupRef of groupRefs) {
+                const idOrName = groupRef.id || groupRef.name;
+                if (!idOrName || idOrName.trim() === '') {
+                    throw new Error('Account group reference must include id or name');
+                }
+                const group = yield book.getGroup(idOrName);
+                if (!group) {
+                    throw new Error(`Group not found: ${idOrName}`);
+                }
+                account.addGroup(group);
+            }
+        }
+        return account;
+    });
+}
 //# sourceMappingURL=batch-create.js.map

package/lib/commands/accounts/batch-create.js.map

@@ -1 +1 @@
-{"version":3,"file":"batch-create.js","sourceRoot":"","sources":["../../../src/commands/accounts/batch-create.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAE9D;;;;;;;;;GASG;AACH,MAAM,UAAgB,mBAAmB,CACrC,MAAc,EACd,KAAgC,EAChC,iBAA4B;;QAE5B,MAAM,KAAK,GAAG,gBAAgB,EAAE,CAAC;QACjC,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEzC,MAAM,QAAQ,GAAc,EAAE,CAAC;QAE/B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,IAAqB,CAAC,CAAC;YAEzD,iDAAiD;YACjD,IAAI,iBAAiB,EAAE,CAAC;gBACpB,KAAK,MAAM,GAAG,IAAI,iBAAiB,EAAE,CAAC;oBAClC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;oBAC5C,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;wBACf,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;oBAChC,CAAC;yBAAM,CAAC;wBACJ,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;oBACpC,CAAC;gBACL,CAAC;YACL,CAAC;YAED,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzD,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QAExD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;CAAA"}
+{"version":3,"file":"batch-create.js","sourceRoot":"","sources":["../../../src/commands/accounts/batch-create.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,OAAO,EAAQ,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAE9D;;;;;;;;;GASG;AACH,MAAM,UAAgB,mBAAmB,CACrC,MAAc,EACd,KAAgC,EAChC,iBAA4B;;QAE5B,MAAM,KAAK,GAAG,gBAAgB,EAAE,CAAC;QACjC,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEzC,MAAM,QAAQ,GAAc,EAAE,CAAC;QAE/B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,OAAO,GAAG,MAAM,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAExD,iDAAiD;YACjD,IAAI,iBAAiB,EAAE,CAAC;gBACpB,KAAK,MAAM,GAAG,IAAI,iBAAiB,EAAE,CAAC;oBAClC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;oBAC5C,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;wBACf,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;oBAChC,CAAC;yBAAM,CAAC;wBACJ,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;oBACpC,CAAC;gBACL,CAAC;YACL,CAAC;YAED,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzD,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QAExD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;CAAA;AAED,SAAe,qBAAqB,CAAC,IAAU,EAAE,IAA6B;;QAC1E,MAAM,OAAO,qBAAuB,IAAsB,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;QACjC,OAAO,OAAO,CAAC,MAAM,CAAC;QAEtB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAE3C,IAAI,SAAS,EAAE,CAAC;YACZ,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBAC/B,MAAM,QAAQ,GAAG,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,IAAI,CAAC;gBAC9C,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;oBACtC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;gBACvE,CAAC;gBAED,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAC5C,IAAI,CAAC,KAAK,EAAE,CAAC;oBACT,MAAM,IAAI,KAAK,CAAC,oBAAoB,QAAQ,EAAE,CAAC,CAAC;gBACpD,CAAC;gBAED,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC5B,CAAC;QACL,CAAC;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;CAAA"}

package/lib/docs/bkper-api-types.md

@@ -0,0 +1,542 @@
+# bkper-api-types
+
+> TypeScript type definitions for the Bkper API — shared interfaces and enumerations.
+
+This package contains Typescript definitions for the [Bkper REST API](https://bkper.com/docs/#rest-api).
+
+The types are generated based on the Bkper [Open API spec](https://bkper.com/docs/api/rest/openapi.json) using the [dtsgenerator](https://github.com/horiuchi/dtsgenerator) tool.
+
+More information at the [Bkper Developer Documentation](https://bkper.com/docs/#rest-api)
+
+[![npm (scoped)](https://img.shields.io/npm/v/@bkper/bkper-api-types?color=%235889e4)](https://www.npmjs.com/package/@bkper/bkper-api-types) [![GitHub](https://img.shields.io/badge/bkper%2Fbkper--api--types-blue?logo=github)](https://github.com/bkper/bkper-api-types)
+
+### 2) Configure tsconfig.json:
+
+```
+{
+    "compilerOptions": {
+        "typeRoots" : ["node_modules/@bkper", "node_modules/@types" ]
+    }
+}
+```
+
+[Learn more](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html#types-typeroots-and-types) about **@types**, **typeRoots** and **types**
+
+## Interfaces
+
+### Account
+
+**Properties:**
+
+- `agentId?`: `string` — The id of agent that created the resource
+- `archived?`: `boolean` — Archived accounts are kept for history
+- `balance?`: `string` — The current account balance, when querying transactions.
+- `balanceVerified?`: `boolean` — Whether the account balance has been verified/audited
+- `createdAt?`: `string` — The creation timestamp, in milliseconds
+- `credit?`: `boolean` — Credit nature or Debit otherwise
+- `groups?`: `bkper.Group[]` — The groups of the account
+- `hasTransactionPosted?`: `boolean` — Tell if the account has transaction posted
+- `id?`: `string` — The unique id that identifies the Account in the Book
+- `name?`: `string` — The name of the Account
+- `normalizedName?`: `string` — The name of the Account, lowercase, without spaces or special characters
+- `permanent?`: `boolean` — Permanent are such as bank accounts, customers or the like
+- `properties?`: `{ [name: string]: string }` — The key/value custom properties of the Account
+- `type?`: `"ASSET" | "LIABILITY" | "INCOMING" | "OUTGOING"` — The type of the account
+- `updatedAt?`: `string` — The last update timestamp, in milliseconds
+
+### AccountBalances
+
+**Properties:**
+
+- `archived?`: `boolean`
+- `balances?`: `bkper.Balance[]`
+- `credit?`: `boolean`
+- `cumulativeBalance?`: `string`
+- `cumulativeCredit?`: `string`
+- `cumulativeDebit?`: `string`
+- `empty?`: `boolean`
+- `name?`: `string`
+- `normalizedName?`: `string`
+- `periodBalance?`: `string`
+- `periodCredit?`: `string`
+- `periodDebit?`: `string`
+- `permanent?`: `boolean`
+- `properties?`: `{ [name: string]: string }`
+
+### AccountList
+
+**Properties:**
+
+- `items?`: `bkper.Account[]` — List items
+
+### Agent
+
+**Properties:**
+
+- `id?`: `string` — The agent id
+- `logo?`: `string` — The agent logo. Public url or Base64 encoded
+- `logoDark?`: `string` — The agent logo on dark mode. Public url or Base64 encoded
+- `name?`: `string` — The agent name
+
+### App
+
+**Properties:**
+
+- `apiVersion?`: `"v0" | "v1" | "v2" | "v3" | "v4" | "v5"` — The API version of the event payload
+- `clientId?`: `string` — The Google OAuth Client ID
+- `clientSecret?`: `string` — The Google OAuth Client Secret
+- `connectable?`: `boolean` — Tell if this app is connectable by a user
+- `deprecated?`: `boolean` — Tell if the code app is deprecated
+- `description?`: `string` — The App description
+- `developers?`: `string` — The developers (usernames and domain patterns), comma or space separated
+- `events?`: `("FILE_CREATED" | "FILE_UPDATED" | "TRANSACTION_CREATED" | "TRANSACTION_UPDATED" | "TRANSACTION_DELETED" | "TRANSACTION_POSTED" | "TRANSACTION_CHECKED" | "TRANSACTION_UNCHECKED" | "TRANSACTION_RESTORED" | "ACCOUNT_CREATED" | "ACCOUNT_UPDATED" | "ACCOUNT_DELETED" | "QUERY_CREATED" | "QUERY_UPDATED" | "QUERY_DELETED" | "GROUP_CREATED" | "GROUP_UPDATED" | "GROUP_DELETED" | "COMMENT_CREATED" | "COMMENT_DELETED" | "COLLABORATOR_ADDED" | "COLLABORATOR_UPDATED" | "COLLABORATOR_REMOVED" | "INTEGRATION_CREATED" | "INTEGRATION_UPDATED" | "INTEGRATION_DELETED" | "BOOK_CREATED" | "BOOK_AUDITED" | "BOOK_UPDATED" | "BOOK_DELETED")[]` — Event types the App listen to
+- `filePatterns?`: `string[]` — File patters the App handles - wildcard accepted - E.g *.pdf *-bank.csv
+- `id?`: `string` — The unique agent id of the App - this can't be changed after created
+- `installable?`: `boolean` — Tell if this app is installable in a book
+- `logoUrl?`: `string` — The App logo url
+- `logoUrlDark?`: `string` — The App logo url in dark mode
+- `menuPopupHeight?`: `string` — The menu popup window height
+- `menuPopupWidth?`: `string` — The menu popup window width
+- `menuText?`: `string` — The contex menu text - default to the App name
+- `menuUrl?`: `string` — The context menu url
+- `menuUrlDev?`: `string` — The context menu url in dev mode
+- `name?`: `string` — The App name
+- `ownerEmail?`: `string` — The owner user email
+- `ownerId?`: `string` — The owner user id
+- `ownerLogoUrl?`: `string` — The owner company logo url
+- `ownerName?`: `string` — The owner company name
+- `ownerWebsite?`: `string` — The owner company website url
+- `propertiesSchema?`: `bkper.AppPropertiesSchema`
+- `published?`: `boolean` — Tell if this app already published
+- `readme?`: `string` — The readme.md file as string
+- `readmeMd?`: `string` — The readme.md file as raw markdown string
+- `repoPrivate?`: `boolean` — Tell if the code repository is private
+- `repoUrl?`: `string` — The code repository url
+- `scopes?`: `string[]` — The Google OAuth Scopes used by the app
+- `users?`: `string` — The users (usernames and domain patterns) to enable the App while not yet published
+- `webhookUrl?`: `string` — The Webhook endpoint URL to listen for book events
+- `webhookUrlDev?`: `string` — The Webhook endpoint URL to listen for book events in dev mode
+- `website?`: `string` — The App website url
+
+### AppList
+
+**Properties:**
+
+- `items?`: `bkper.App[]`
+
+### AppPropertiesSchema
+
+**Properties:**
+
+- `account?`: `bkper.AppPropertySchema`
+- `book?`: `bkper.AppPropertySchema`
+- `group?`: `bkper.AppPropertySchema`
+- `transaction?`: `bkper.AppPropertySchema`
+
+### AppPropertySchema
+
+**Properties:**
+
+- `keys?`: `string[]` — The property keys schema
+- `values?`: `string[]` — The property values schema
+
+### Backlog
+
+**Properties:**
+
+- `count?`: `number`
+
+### Balance
+
+**Properties:**
+
+- `cumulativeBalance?`: `string`
+- `cumulativeCredit?`: `string`
+- `cumulativeDebit?`: `string`
+- `day?`: `number`
+- `fuzzyDate?`: `number`
+- `month?`: `number`
+- `periodBalance?`: `string`
+- `periodCredit?`: `string`
+- `periodDebit?`: `string`
+- `year?`: `number`
+
+### Balances
+
+**Properties:**
+
+- `accountBalances?`: `bkper.AccountBalances[]`
+- `balancesUrl?`: `string`
+- `groupBalances?`: `bkper.GroupBalances[]`
+- `nextRange?`: `string`
+- `periodicity?`: `"DAILY" | "MONTHLY" | "YEARLY"`
+- `previousRange?`: `string`
+- `range?`: `string`
+- `rangeBeginLabel?`: `string`
+- `rangeEndLabel?`: `string`
+
+### Billing
+
+**Properties:**
+
+- `adminEmail?`: `string` — The billing admin email for the user's billing account
+- `daysLeftInTrial?`: `number` — How many days the user has left in the trial period
+- `email?`: `string` — The user's email address
+- `enabled?`: `boolean` — True if billing is enabled for the user
+- `hostedDomain?`: `string` — The user hosted domain
+- `plan?`: `string` — The user's current plan
+- `planOverdue?`: `boolean` — True if subscription payment is overdue
+- `startedTrial?`: `boolean` — True if the user has started the trial period
+- `totalTransactionsThisMonth?`: `number` — User-level total transactions this month
+- `totalTransactionsThisYear?`: `number` — User-level total transactions this year
+
+### Book
+
+**Properties:**
+
+- `accounts?`: `bkper.Account[]` — The book Accounts
+- `agentId?`: `string` — The id of agent that created the resource
+- `autoPost?`: `boolean` — Tells if the Book has auto post enabled
+- `closingDate?`: `string` — The book closing date
+- `collection?`: `bkper.Collection`
+- `createdAt?`: `string` — The creation timestamp, in milliseconds
+- `datePattern?`: `string` — The date pattern of the Book. Example: dd/MM/yyyy
+- `decimalSeparator?`: `"DOT" | "COMMA"` — The decimal separator of the Book
+- `fractionDigits?`: `number` — The number of fraction digits (decimal places) of the Book
+- `groups?`: `bkper.Group[]` — The book account Groups
+- `id?`: `string` — The unique id that identifies the Book in the system. Found at bookId url param
+- `lastUpdateMs?`: `string` — The last update date of the Book, in in milliseconds
+- `lockDate?`: `string` — The book lock date
+- `name?`: `string` — The name of the Book
+- `ownerName?`: `string` — The Book owner username
+- `pageSize?`: `number` — The transactions pagination page size
+- `period?`: `"MONTH" | "QUARTER" | "YEAR"` — The period slice for balances visualization
+- `periodStartMonth?`: `"JANUARY" | "FEBRUARY" | "MARCH" | "APRIL" | "MAY" | "JUNE" | "JULY" | "AUGUST" | "SEPTEMBER" | "OCTOBER" | "NOVEMBER" | "DECEMBER"` — The start month when YEAR period set
+- `permission?`: `"OWNER" | "EDITOR" | "POSTER" | "RECORDER" | "VIEWER" | "NONE"` — The Permission the current user has in the Book
+- `properties?`: `{ [name: string]: string }` — The key/value custom properties of the Book
+- `timeZone?`: `string` — The time zone of the Book
+- `timeZoneOffset?`: `number` — The time zone offset of the Book, in minutes
+- `totalTransactions?`: `number` — The total transactions posted
+- `totalTransactionsCurrentMonth?`: `number` — The total transactions posted on current month
+- `totalTransactionsCurrentYear?`: `number` — The total transactions posted on current year
+- `updatedAt?`: `string` — The last update timestamp, in milliseconds
+- `visibility?`: `"PUBLIC" | "PRIVATE"` — The Visibility of the Book
+
+### BookList
+
+**Properties:**
+
+- `items?`: `bkper.Book[]` — List items
+
+### BotResponse
+
+**Properties:**
+
+- `agentId?`: `string`
+- `createdAt?`: `string`
+- `message?`: `string`
+- `type?`: `"INFO" | "WARNING" | "ERROR"`
+
+### Collaborator
+
+**Properties:**
+
+- `agentId?`: `string` — The id of agent that created the resource
+- `createdAt?`: `string` — The creation timestamp, in milliseconds
+- `email?`: `string` — The email of the Collaborator
+- `id?`: `string` — The unique id that identifies the Collaborator in the Book
+- `permission?`: `"OWNER" | "EDITOR" | "POSTER" | "RECORDER" | "VIEWER" | "NONE"` — The permission the Collaborator has in the Book
+- `updatedAt?`: `string` — The last update timestamp, in milliseconds
+
+### CollaboratorPayloadCollection
+
+**Properties:**
+
+- `items?`: `bkper.Collaborator[]`
+
+### Collection
+
+**Properties:**
+
+- `agentId?`: `string` — The id of agent that created the resource
+- `books?`: `bkper.Book[]` — The Books contained in the Collection
+- `createdAt?`: `string` — The creation timestamp, in milliseconds
+- `id?`: `string` — The unique id of the Collection
+- `name?`: `string` — The name of the Collection
+- `ownerUsername?`: `string` — The username of the Collection owner
+- `permission?`: `"OWNER" | "EDITOR" | "POSTER" | "RECORDER" | "VIEWER" | "NONE"`
+- `updatedAt?`: `string` — The last update timestamp, in milliseconds
+
+### CollectionList
+
+**Properties:**
+
+- `items?`: `bkper.Collection[]` — List items
+
+### Connection
+
+**Properties:**
+
+- `agentId?`: `string` — The id of agent that created the resource
+- `createdAt?`: `string` — The creation timestamp, in milliseconds
+- `dateAddedMs?`: `string`
+- `email?`: `string`
+- `id?`: `string`
+- `logo?`: `string`
+- `name?`: `string`
+- `properties?`: `{ [name: string]: string }`
+- `type?`: `"APP" | "BANK"`
+- `updatedAt?`: `string` — The last update timestamp, in milliseconds
+- `userId?`: `string`
+- `uuid?`: `string`
+
+### ConnectionList
+
+**Properties:**
+
+- `items?`: `bkper.Connection[]` — List items
+
+### Count
+
+**Properties:**
+
+- `day?`: `number`
+- `fuzzyDate?`: `number`
+- `month?`: `number`
+- `total?`: `number`
+- `year?`: `number`
+
+### Counts
+
+**Properties:**
+
+- `posted?`: `bkper.Count[]`
+- `trashed?`: `bkper.Count[]`
+
+### Event
+
+**Properties:**
+
+- `agent?`: `bkper.Agent`
+- `book?`: `bkper.Book`
+- `bookId?`: `string` — The id of the Book associated to the Event
+- `botResponses?`: `bkper.BotResponse[]` — The list of bot responses associated to the Event
+- `createdAt?`: `string` — The creation timestamp, in milliseconds
+- `createdOn?`: `string` — The creation date time on RFC3339 format
+- `data?`: `bkper.EventData`
+- `id?`: `string` — The unique id that identifies the Event
+- `resource?`: `string` — The resource associated to the Event
+- `type?`: `"FILE_CREATED" | "FILE_UPDATED" | "TRANSACTION_CREATED" | "TRANSACTION_UPDATED" | "TRANSACTION_DELETED" | "TRANSACTION_POSTED" | "TRANSACTION_CHECKED" | "TRANSACTION_UNCHECKED" | "TRANSACTION_RESTORED" | "ACCOUNT_CREATED" | "ACCOUNT_UPDATED" | "ACCOUNT_DELETED" | "QUERY_CREATED" | "QUERY_UPDATED" | "QUERY_DELETED" | "GROUP_CREATED" | "GROUP_UPDATED" | "GROUP_DELETED" | "COMMENT_CREATED" | "COMMENT_DELETED" | "COLLABORATOR_ADDED" | "COLLABORATOR_UPDATED" | "COLLABORATOR_REMOVED" | "INTEGRATION_CREATED" | "INTEGRATION_UPDATED" | "INTEGRATION_DELETED" | "BOOK_CREATED" | "BOOK_AUDITED" | "BOOK_UPDATED" | "BOOK_DELETED"` — The type of the Event
+- `user?`: `bkper.User`
+
+### EventData
+
+**Properties:**
+
+- `object?`: `bkper.Any`
+- `previousAttributes?`: `{ [name: string]: string }` — The object previous attributes when updated
+
+### EventList
+
+**Properties:**
+
+- `cursor?`: `string` — The cursor, for pagination
+- `items?`: `bkper.Event[]` — List items
+
+### File
+
+**Properties:**
+
+- `agentId?`: `string` — The id of agent that created the resource
+- `content?`: `string` — The file content Base64 encoded
+- `contentType?`: `string` — The file content type
+- `createdAt?`: `string` — The creation timestamp, in milliseconds
+- `id?`: `string` — The unique id that identifies the file in the book
+- `name?`: `string` — The file name
+- `properties?`: `{ [name: string]: string }` — The key/value custom properties of the File
+- `size?`: `number` — The file size in bytes
+- `updatedAt?`: `string` — The last update timestamp, in milliseconds
+- `url?`: `string` — The file serving url
+
+### Group
+
+**Properties:**
+
+- `agentId?`: `string` — The id of agent that created the resource
+- `createdAt?`: `string` — The creation timestamp, in milliseconds
+- `credit?`: `boolean` — Tell if the group is credit
+- `hasAccounts?`: `boolean` — Tell if the group is has any accounts
+- `hasGroups?`: `boolean` — Tell if the group is has any children groups
+- `hidden?`: `boolean` — Tell if the group is hidden on transactions main menu
+- `id?`: `string` — The unique id that identifies the Group in the Book
+- `locked?`: `boolean` — Tell if the group is locked by the Book owner
+- `mixed?`: `boolean` — Tell if has mixed type of accounts
+- `name?`: `string` — The name of the Group
+- `normalizedName?`: `string` — The name of the Group, lowercase, without spaces or special characters
+- `parent?`: `bkper.Group`
+- `permanent?`: `boolean` — Tell if the group is permanent
+- `properties?`: `{ [name: string]: string }` — The key/value custom properties of the Group
+- `type?`: `"ASSET" | "LIABILITY" | "INCOMING" | "OUTGOING"`
+- `updatedAt?`: `string` — The last update timestamp, in milliseconds
+
+### GroupBalances
+
+**Properties:**
+
+- `accountBalances?`: `bkper.AccountBalances[]`
+- `balances?`: `bkper.Balance[]`
+- `credit?`: `boolean`
+- `cumulativeBalance?`: `string`
+- `cumulativeCredit?`: `string`
+- `cumulativeDebit?`: `string`
+- `groupBalances?`: `bkper.GroupBalances[]`
+- `name?`: `string`
+- `normalizedName?`: `string`
+- `periodBalance?`: `string`
+- `periodCredit?`: `string`
+- `periodDebit?`: `string`
+- `permanent?`: `boolean`
+- `properties?`: `{ [name: string]: string }`
+
+### GroupList
+
+**Properties:**
+
+- `items?`: `bkper.Group[]` — List items
+
+### Integration
+
+**Properties:**
+
+- `addedBy?`: `string`
+- `agentId?`: `string` — The id of agent that created the resource
+- `bookId?`: `string`
+- `connectionId?`: `string`
+- `createdAt?`: `string` — The creation timestamp, in milliseconds
+- `dateAddedMs?`: `string`
+- `id?`: `string`
+- `lastUpdateMs?`: `string`
+- `logo?`: `string`
+- `logoDark?`: `string`
+- `name?`: `string`
+- `normalizedName?`: `string`
+- `properties?`: `{ [name: string]: string }`
+- `updatedAt?`: `string` — The last update timestamp, in milliseconds
+- `userId?`: `string`
+
+### IntegrationList
+
+**Properties:**
+
+- `items?`: `bkper.Integration[]` — List items
+
+### Query
+
+**Properties:**
+
+- `agentId?`: `string` — The id of agent that created the resource
+- `createdAt?`: `string` — The creation timestamp, in milliseconds
+- `id?`: `string` — The unique id that identifies the saved Query in the Book
+- `query?`: `string` — The Query string to be executed
+- `title?`: `string` — The title of the saved Query
+- `updatedAt?`: `string` — The last update timestamp, in milliseconds
+
+### QueryList
+
+**Properties:**
+
+- `items?`: `bkper.Query[]` — List items
+
+### Template
+
+**Properties:**
+
+- `bookId?`: `string`
+- `bookLink?`: `string`
+- `category?`: `string`
+- `description?`: `string`
+- `imageUrl?`: `string`
+- `name?`: `string`
+- `sheetsLink?`: `string`
+- `timesUsed?`: `number`
+
+### TemplateList
+
+**Properties:**
+
+- `items?`: `bkper.Template[]` — List items
+
+### Transaction
+
+**Properties:**
+
+- `agentId?`: `string` — The id of agent that created the resource
+- `agentLogo?`: `string` — The logo of the agent that created the transaction
+- `agentLogoDark?`: `string` — The logo in dark mode, of the agent that created the transaction
+- `agentName?`: `string` — The name of the agent that created the transaction
+- `amount?`: `string` — The amount on format ####.##
+- `checked?`: `boolean` — Tell if the transaction is a checked
+- `createdAt?`: `string` — The creation timestamp, in milliseconds
+- `createdBy?`: `string` — The actor username that created the transaction
+- `creditAccount?`: `bkper.Account`
+- `date?`: `string` — The date on ISO format yyyy-MM-dd
+- `dateFormatted?`: `string` — The date on format of the Book
+- `dateValue?`: `number` — The date number representation on format YYYYMMDD
+- `debitAccount?`: `bkper.Account`
+- `description?`: `string` — The transaction description
+- `draft?`: `boolean` — Tell if its a draft transaction
+- `files?`: `bkper.File[]` — The files attached to the transaction
+- `id?`: `string` — The unique id that identifies the transaction in the book
+- `posted?`: `boolean` — Tell if the transaction is already posted on accounts, otherwise is a draft
+- `properties?`: `{ [name: string]: string }` — The key/value custom properties of the Transaction
+- `remoteIds?`: `string[]` — The transaction remote ids, to avoid duplication
+- `tags?`: `string[]` — The transaction #hashtags
+- `trashed?`: `boolean` — Tell if transaction is trashed
+- `updatedAt?`: `string` — The last update timestamp, in milliseconds
+- `urls?`: `string[]` — The transaction urls
+
+### TransactionList
+
+**Properties:**
+
+- `account?`: `string` — The account id when filtering by a single account. E.g. account='Bank'
+- `cursor?`: `string` — The cursor, for pagination
+- `items?`: `bkper.Transaction[]` — List items
+
+### TransactionOperation
+
+**Properties:**
+
+- `accounts?`: `bkper.Account[]` — The affected accounts
+- `transaction?`: `bkper.Transaction`
+
+### Url
+
+**Properties:**
+
+- `url?`: `string`
+
+### User
+
+**Properties:**
+
+- `avatarUrl?`: `string` — The user public avatar url
+- `bankConnections?`: `boolean` — True if user already had any bank connection
+- `billingAdminEmail?`: `string` — The billing admin email for this user's billing account
+- `billingEnabled?`: `boolean` — True if billing is enabled for the user
+- `daysLeftInTrial?`: `number` — How many days left in trial
+- `email?`: `string` — The user email
+- `free?`: `boolean` — True if user is in the free plan
+- `fullName?`: `string` — The user full name
+- `givenName?`: `string` — The user given name
+- `hash?`: `string` — The user hash
+- `hostedDomain?`: `string` — The user hosted domain
+- `id?`: `string` — The user unique id
+- `name?`: `string` — The user display name
+- `plan?`: `string` — The user plan
+- `planOverdue?`: `boolean` — True if subscription payment is overdue
+- `startedTrial?`: `boolean` — True if user started trial
+- `totalTransactionsThisMonth?`: `number` — User-level total transactions this month
+- `totalTransactionsThisYear?`: `number` — User-level total transactions this year
+- `username?`: `string` — The Bkper username of the user
+