Skip to content
Bkper
app.header.homeapp.header.docs

listEvents

GET
/v5/books/{bookId}/events

List book events

Parameters

Path Parameters

bookId
required
string

The id of the book. Same bookId url param on Bkper

Query Parameters

after
string format: date-time

After date and time, on RFC3339 format

before
string format: date-time

Before date and time, on RFC3339 format

error
boolean

Filter by error

resoureId
string

The resourceId associated

limit
integer format: int32

The dataset limit. Useful for pagination

Responses

200

A EventList response

object
cursor

The cursor, for pagination

string
items

List items

Array<object>
object
agent
object
id

The agent id

string
logo

The agent logo. Public url or Base64 encoded

string
logoDark

The agent logo on dark mode. Public url or Base64 encoded

string
name

The agent name

string
Example
{
  "id": "string",
  "logo": "string",
  "logoDark": "string",
  "name": "string"
}
book
object
accounts

The book Accounts

Array<object>
object
agentId

The id of agent that created the resource

string
archived

Archived accounts are kept for history

boolean
balance

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

string
balanceVerified

Whether the account balance has been verified/audited

boolean
createdAt

The creation timestamp, in milliseconds

string
credit

Credit nature or Debit otherwise

boolean
groups

The groups of the account

Array<object>
object
agentId

The id of agent that created the resource

string
createdAt

The creation timestamp, in milliseconds

string
credit

Whether the group has credit nature

boolean
hasAccounts

Whether the group has any accounts

boolean
hasGroups

Whether the group has any children groups

boolean
hidden

Whether the group is hidden on the transactions main menu

boolean
id

The unique id that identifies the Group in the Book

string
locked

Whether the group is locked by the Book owner

boolean
mixed

Whether the group has mixed types of accounts

boolean
name

The name of the Group

string
normalizedName

The name of the Group, lowercase, without spaces or special characters

string
parent
object recursive
permanent

Whether the group is permanent

boolean
properties

The key/value custom properties of the Group

object
key
additional properties
string
type

The type of the accounts in the group. E.g. ASSET, LIABILITY, INCOMING, OUTGOING

string
Allowed values: ASSET LIABILITY INCOMING OUTGOING
updatedAt

The last update timestamp, in milliseconds

string
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"
}
hasTransactionPosted

Whether the account has any transactions posted

boolean
id

The unique id that identifies the Account in the Book

string
name

The name of the Account

string
normalizedName

The name of the Account, lowercase, without spaces or special characters

string
permanent

Permanent are such as bank accounts, customers or the like

boolean
properties

The key/value custom properties of the Account

object
key
additional properties
string
type

The type of the account

string
Allowed values: ASSET LIABILITY INCOMING OUTGOING
updatedAt

The last update timestamp, in milliseconds

string
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"
}
agentId

The id of agent that created the resource

string
autoPost

Tells if the Book has auto post enabled

boolean
closingDate

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

string
collection
object
agentId

The id of agent that created the resource

string
books
Array<object> recursive
createdAt

The creation timestamp, in milliseconds

string
id

The unique id of the Collection

string
name

The name of the Collection

string
ownerUsername

The username of the Collection owner

string
permission

The permission the current user has in the Collection. E.g. OWNER, EDITOR, NONE

string
Allowed values: OWNER EDITOR POSTER RECORDER VIEWER NONE
updatedAt

The last update timestamp, in milliseconds

string
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"
}
createdAt

The creation timestamp, in milliseconds

string
datePattern

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

string
decimalSeparator

The decimal separator of the Book

string
Allowed values: DOT COMMA
fractionDigits

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

integer format: int32
groups

The book account Groups

Array<object>
object
agentId

The id of agent that created the resource

string
createdAt

The creation timestamp, in milliseconds

string
credit

Whether the group has credit nature

boolean
hasAccounts

Whether the group has any accounts

boolean
hasGroups

Whether the group has any children groups

boolean
hidden

Whether the group is hidden on the transactions main menu

boolean
id

The unique id that identifies the Group in the Book

string
locked

Whether the group is locked by the Book owner

boolean
mixed

Whether the group has mixed types of accounts

boolean
name

The name of the Group

string
normalizedName

The name of the Group, lowercase, without spaces or special characters

string
parent
object recursive
permanent

Whether the group is permanent

boolean
properties

The key/value custom properties of the Group

object
key
additional properties
string
type

The type of the accounts in the group. E.g. ASSET, LIABILITY, INCOMING, OUTGOING

string
Allowed values: ASSET LIABILITY INCOMING OUTGOING
updatedAt

The last update timestamp, in milliseconds

string
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"
}
id

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

string
lastUpdateMs

The last update date of the Book, in milliseconds

string
lockDate

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

string
name

The name of the Book

string
ownerName

The Book owner username

string
pageSize

The transactions pagination page size

integer format: int32
period

The period slice for balances visualization

string
Allowed values: MONTH QUARTER YEAR
periodStartMonth

The start month when YEAR period set

string
Allowed values: JANUARY FEBRUARY MARCH APRIL MAY JUNE JULY AUGUST SEPTEMBER OCTOBER NOVEMBER DECEMBER
permission

The Permission the current user has in the Book

string
Allowed values: OWNER EDITOR POSTER RECORDER VIEWER NONE
properties

The key/value custom properties of the Book

object
key
additional properties
string
timeZone

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

string
timeZoneOffset

The time zone offset of the Book, in minutes

integer format: int32
totalTransactions

The total transactions posted

integer format: int64
totalTransactionsCurrentMonth

The total transactions posted on current month

integer format: int64
totalTransactionsCurrentYear

The total transactions posted on current year

integer format: int64
updatedAt

The last update timestamp, in milliseconds

string
visibility

The Visibility of the Book

string
Allowed values: PUBLIC PRIVATE
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"
}
bookId

The id of the Book associated to the Event

string
botResponses

The list of bot responses associated to the Event

Array<object>
object
agentId
string
createdAt
string
message
string
type
string
Allowed values: INFO WARNING ERROR
Example
{
  "agentId": "string",
  "createdAt": "string",
  "message": "string",
  "type": "INFO"
}
createdAt

The creation timestamp, in milliseconds

string
createdOn

The creation date time on RFC3339 format

string format: date-time
data
object
object
object
previousAttributes

The object previous attributes when updated

object
key
additional properties
string
Example
{
  "object": null,
  "previousAttributes": {
    "key": "value"
  }
}
id

The unique id that identifies the Event

string
resource

The resource associated to the Event

string
type

The type of the Event

string
Allowed values: 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
user
object
avatarUrl

The user public avatar url

string
bankConnections

True if user already had any bank connection

boolean
billingAdminEmail

The billing admin email for this user’s billing account

string
billingEnabled

True if billing is enabled for the user

boolean
daysLeftInTrial

How many days left in trial

integer format: int32
email

The user email

string
free

True if user is in the free plan

boolean
fullName

The user full name

string
givenName

The user given name

string
hash

The user hash

string
hostedDomain

The user hosted domain

string
id

The user unique id

string
name

The user display name

string
plan

The user plan

string
planOverdue

True if subscription payment is overdue

boolean
startedTrial

True if user started trial

boolean
totalTransactionsThisMonth

User-level total transactions this month

integer format: int64
totalTransactionsThisYear

User-level total transactions this year

integer format: int64
username

The Bkper username of the user

string
Example
{
  "avatarUrl": "string",
  "bankConnections": true,
  "billingAdminEmail": "string",
  "billingEnabled": true,
  "daysLeftInTrial": 1,
  "email": "string",
  "free": true,
  "fullName": "string",
  "givenName": "string",
  "hash": "string",
  "hostedDomain": "string",
  "id": "string",
  "name": "string",
  "plan": "string",
  "planOverdue": true,
  "startedTrial": true,
  "totalTransactionsThisMonth": 1,
  "totalTransactionsThisYear": 1,
  "username": "string"
}
Example
{
  "agent": {
    "id": "string",
    "logo": "string",
    "logoDark": "string",
    "name": "string"
  },
  "book": {
    "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"
  },
  "bookId": "string",
  "botResponses": [
    {
      "agentId": "string",
      "createdAt": "string",
      "message": "string",
      "type": "INFO"
    }
  ],
  "createdAt": "1592000000000",
  "createdOn": "string",
  "data": {
    "object": null,
    "previousAttributes": {
      "key": "value"
    }
  },
  "id": "string",
  "resource": "string",
  "type": "FILE_CREATED",
  "user": {
    "avatarUrl": "string",
    "bankConnections": true,
    "billingAdminEmail": "string",
    "billingEnabled": true,
    "daysLeftInTrial": 1,
    "email": "string",
    "free": true,
    "fullName": "string",
    "givenName": "string",
    "hash": "string",
    "hostedDomain": "string",
    "id": "string",
    "name": "string",
    "plan": "string",
    "planOverdue": true,
    "startedTrial": true,
    "totalTransactionsThisMonth": 1,
    "totalTransactionsThisYear": 1,
    "username": "string"
  }
}
Example
{
  "cursor": "string",
  "items": [
    {
      "agent": {
        "id": "string",
        "logo": "string",
        "logoDark": "string",
        "name": "string"
      },
      "book": {
        "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"
      },
      "bookId": "string",
      "botResponses": [],
      "createdAt": "1592000000000",
      "createdOn": "string",
      "data": {
        "object": null,
        "previousAttributes": {
          "key": "value"
        }
      },
      "id": "string",
      "resource": "string",
      "type": "FILE_CREATED",
      "user": {
        "avatarUrl": "string",
        "bankConnections": true,
        "billingAdminEmail": "string",
        "billingEnabled": true,
        "daysLeftInTrial": 1,
        "email": "string",
        "free": true,
        "fullName": "string",
        "givenName": "string",
        "hash": "string",
        "hostedDomain": "string",
        "id": "string",
        "name": "string",
        "plan": "string",
        "planOverdue": true,
        "startedTrial": true,
        "totalTransactionsThisMonth": 1,
        "totalTransactionsThisYear": 1,
        "username": "string"
      }
    }
  ]
}