listBooks
GET /v5/books
List user books
Parameters
Query Parameters
Optional search term to filter books
Responses
200
A BookList response
object
List items
object
The book Accounts
object
The id of agent that created the resource
Archived accounts are kept for history
The running balance of the account at the transaction date. Only present when the account is part of a transaction response filtered by account. NOT the current account balance. To get current balances, use the Balances endpoint: GET /books/{bookId}/balances
Whether the account balance has been verified/audited
The creation timestamp, in milliseconds
Credit nature or Debit otherwise
The groups of the account
object
The id of agent that created the resource
The creation timestamp, in milliseconds
Whether the group has credit nature
Whether the group has any accounts
Whether the group has any children groups
Whether the group is hidden on the transactions main menu
The unique id that identifies the Group in the Book
Whether the group is locked by the Book owner
Whether the group has mixed types of accounts
The name of the Group
The name of the Group, lowercase, without spaces or special characters
Whether the group is permanent
The key/value custom properties of the Group
object
The type of the accounts in the group. E.g. ASSET, LIABILITY, INCOMING, OUTGOING
The last update timestamp, in milliseconds
Example
{ "agentId": "string", "createdAt": "1592000000000", "credit": true, "hasAccounts": true, "hasGroups": true, "hidden": true, "id": "string", "locked": true, "mixed": true, "name": "string", "normalizedName": "string", "parent": null, "permanent": true, "properties": { "key": "value" }, "type": "ASSET", "updatedAt": "1592000000000"}Whether the account has any transactions posted
The unique id that identifies the Account in the Book
The name of the Account
The name of the Account, lowercase, without spaces or special characters
Permanent are such as bank accounts, customers or the like
The key/value custom properties of the Account
object
The type of the account
The last update timestamp, in milliseconds
Example
{ "agentId": "string", "archived": true, "balance": "string", "balanceVerified": true, "createdAt": "1592000000000", "credit": true, "groups": [ { "agentId": "string", "createdAt": "1592000000000", "credit": true, "hasAccounts": true, "hasGroups": true, "hidden": true, "id": "string", "locked": true, "mixed": true, "name": "string", "normalizedName": "string", "parent": null, "permanent": true, "properties": { "key": "value" }, "type": "ASSET", "updatedAt": "1592000000000" } ], "hasTransactionPosted": true, "id": "string", "name": "string", "normalizedName": "string", "permanent": true, "properties": { "key": "value" }, "type": "ASSET", "updatedAt": "1592000000000"}The id of agent that created the resource
Tells if the Book has auto post enabled
The book closing date, in ISO format yyyy-MM-dd. Transactions on or before this date are closed for the period
object
The id of agent that created the resource
The creation timestamp, in milliseconds
The unique id of the Collection
The name of the Collection
The username of the Collection owner
The permission the current user has in the Collection. E.g. OWNER, EDITOR, NONE
The last update timestamp, in milliseconds
Example
{ "agentId": "string", "books": [ { "accounts": [], "agentId": "string", "autoPost": true, "closingDate": "2024-01-15", "collection": null, "createdAt": "1592000000000", "datePattern": "dd/MM/yyyy", "decimalSeparator": "DOT", "fractionDigits": 1, "groups": [], "id": "string", "lastUpdateMs": "1592000000000", "lockDate": "2024-01-15", "name": "string", "ownerName": "string", "pageSize": 1, "period": "MONTH", "periodStartMonth": "JANUARY", "permission": "OWNER", "properties": { "key": "value" }, "timeZone": "string", "timeZoneOffset": 1, "totalTransactions": 1, "totalTransactionsCurrentMonth": 1, "totalTransactionsCurrentYear": 1, "updatedAt": "1592000000000", "visibility": "PUBLIC" } ], "createdAt": "1592000000000", "id": "string", "name": "string", "ownerUsername": "string", "permission": "OWNER", "updatedAt": "1592000000000"}The creation timestamp, in milliseconds
The date pattern of the Book. Example: dd/MM/yyyy
The decimal separator of the Book
The number of fraction digits (decimal places) of the Book. E.g. 2 for ####.##, 4 for ####.####
The book account Groups
object
The id of agent that created the resource
The creation timestamp, in milliseconds
Whether the group has credit nature
Whether the group has any accounts
Whether the group has any children groups
Whether the group is hidden on the transactions main menu
The unique id that identifies the Group in the Book
Whether the group is locked by the Book owner
Whether the group has mixed types of accounts
The name of the Group
The name of the Group, lowercase, without spaces or special characters
Whether the group is permanent
The key/value custom properties of the Group
object
The type of the accounts in the group. E.g. ASSET, LIABILITY, INCOMING, OUTGOING
The last update timestamp, in milliseconds
Example
{ "agentId": "string", "createdAt": "1592000000000", "credit": true, "hasAccounts": true, "hasGroups": true, "hidden": true, "id": "string", "locked": true, "mixed": true, "name": "string", "normalizedName": "string", "parent": null, "permanent": true, "properties": { "key": "value" }, "type": "ASSET", "updatedAt": "1592000000000"}The unique id that identifies the Book in the system. Found at bookId url param
The last update date of the Book, in milliseconds
The book lock date, in ISO format yyyy-MM-dd. Transactions on or before this date are locked
The name of the Book
The Book owner username
The transactions pagination page size
The period slice for balances visualization
The start month when YEAR period set
The Permission the current user has in the Book
The key/value custom properties of the Book
object
The time zone of the Book, in IANA format. E.g. America/New_York, Europe/London
The time zone offset of the Book, in minutes
The total transactions posted
The total transactions posted on current month
The total transactions posted on current year
The last update timestamp, in milliseconds
The Visibility of the Book
Example
{ "accounts": [ { "agentId": "string", "archived": true, "balance": "string", "balanceVerified": true, "createdAt": "1592000000000", "credit": true, "groups": [], "hasTransactionPosted": true, "id": "string", "name": "string", "normalizedName": "string", "permanent": true, "properties": { "key": "value" }, "type": "ASSET", "updatedAt": "1592000000000" } ], "agentId": "string", "autoPost": true, "closingDate": "2024-01-15", "collection": { "agentId": "string", "books": [], "createdAt": "1592000000000", "id": "string", "name": "string", "ownerUsername": "string", "permission": "OWNER", "updatedAt": "1592000000000" }, "createdAt": "1592000000000", "datePattern": "dd/MM/yyyy", "decimalSeparator": "DOT", "fractionDigits": 1, "groups": [ { "agentId": "string", "createdAt": "1592000000000", "credit": true, "hasAccounts": true, "hasGroups": true, "hidden": true, "id": "string", "locked": true, "mixed": true, "name": "string", "normalizedName": "string", "parent": null, "permanent": true, "properties": { "key": "value" }, "type": "ASSET", "updatedAt": "1592000000000" } ], "id": "string", "lastUpdateMs": "1592000000000", "lockDate": "2024-01-15", "name": "string", "ownerName": "string", "pageSize": 1, "period": "MONTH", "periodStartMonth": "JANUARY", "permission": "OWNER", "properties": { "key": "value" }, "timeZone": "string", "timeZoneOffset": 1, "totalTransactions": 1, "totalTransactionsCurrentMonth": 1, "totalTransactionsCurrentYear": 1, "updatedAt": "1592000000000", "visibility": "PUBLIC"}Example
{ "items": [ { "accounts": [], "agentId": "string", "autoPost": true, "closingDate": "2024-01-15", "collection": { "agentId": "string", "books": [], "createdAt": "1592000000000", "id": "string", "name": "string", "ownerUsername": "string", "permission": "OWNER", "updatedAt": "1592000000000" }, "createdAt": "1592000000000", "datePattern": "dd/MM/yyyy", "decimalSeparator": "DOT", "fractionDigits": 1, "groups": [], "id": "string", "lastUpdateMs": "1592000000000", "lockDate": "2024-01-15", "name": "string", "ownerName": "string", "pageSize": 1, "period": "MONTH", "periodStartMonth": "JANUARY", "permission": "OWNER", "properties": { "key": "value" }, "timeZone": "string", "timeZoneOffset": 1, "totalTransactions": 1, "totalTransactionsCurrentMonth": 1, "totalTransactionsCurrentYear": 1, "updatedAt": "1592000000000", "visibility": "PUBLIC" } ]}