checkTransactionsBatch

PATCH

/v5/books/{bookId}/transactions/check/batch

Batch check transactions

Parameters

Path Parameters

bookId

required

string

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

Request Body

object

account

The account id when filtering by a single account. E.g. account=‘Bank’

string

cursor

The cursor, for pagination

string

items

List items

Array<object>

object

agentId

The id of agent that created the resource

string

agentLogo

The logo of the agent that created the transaction

string

agentLogoDark

The logo in dark mode, of the agent that created the transaction

string

agentName

The name of the agent that created the transaction

string

amount

The amount on format ####.##

string

checked

Whether the transaction is checked

boolean

createdAt

The creation timestamp, in milliseconds

string

createdBy

The actor username that created the transaction

string

creditAccount

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

date

The date on ISO format yyyy-MM-dd

string

dateFormatted

The date on format of the Book

string

dateValue

The date number representation on format YYYYMMDD

integer format: int32

debitAccount

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

description

The transaction description

string

draft

Whether the transaction is a draft

boolean

files

The files attached to the transaction

Array<object>

object

agentId

The id of agent that created the resource

string

content

The file content Base64 encoded

string

contentType

The file content type

string

createdAt

The creation timestamp, in milliseconds

string

id

The unique id that identifies the file in the book

string

name

The file name

string

properties

The key/value custom properties of the File

object

key

additional properties

string

size

The file size in bytes

integer format: int64

updatedAt

The last update timestamp, in milliseconds

string

url

The file serving url

string

Example

{
  "agentId": "string",
  "content": "string",
  "contentType": "string",
  "createdAt": "1592000000000",
  "id": "string",
  "name": "string",
  "properties": {
    "key": "value"
  },
  "size": 1,
  "updatedAt": "1592000000000",
  "url": "string"
}

id

The unique id that identifies the transaction in the book

string

posted

Whether the transaction is already posted on accounts, otherwise is a draft

boolean

properties

The key/value custom properties of the Transaction

object

key

additional properties

string

remoteIds

The transaction remote ids, to avoid duplication

Array<string>

tags

The transaction #hashtags

Array<string>

trashed

Whether the transaction is trashed

boolean

updatedAt

The last update timestamp, in milliseconds

string

urls

The transaction urls

Array<string>

Example

{
  "agentId": "string",
  "agentLogo": "string",
  "agentLogoDark": "string",
  "agentName": "string",
  "amount": "1234.56",
  "checked": true,
  "createdAt": "1592000000000",
  "createdBy": "string",
  "creditAccount": {
    "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"
  },
  "date": "2024-01-15",
  "dateFormatted": "string",
  "dateValue": 1,
  "debitAccount": {
    "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"
  },
  "description": "string",
  "draft": true,
  "files": [
    {
      "agentId": "string",
      "content": "string",
      "contentType": "string",
      "createdAt": "1592000000000",
      "id": "string",
      "name": "string",
      "properties": {
        "key": "value"
      },
      "size": 1,
      "updatedAt": "1592000000000",
      "url": "string"
    }
  ],
  "id": "string",
  "posted": true,
  "properties": {
    "key": "value"
  },
  "remoteIds": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "trashed": true,
  "updatedAt": "1592000000000",
  "urls": [
    "string"
  ]
}

Example

{
  "account": "string",
  "cursor": "string",
  "items": [
    {
      "agentId": "string",
      "agentLogo": "string",
      "agentLogoDark": "string",
      "agentName": "string",
      "amount": "1234.56",
      "checked": true,
      "createdAt": "1592000000000",
      "createdBy": "string",
      "creditAccount": {
        "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"
      },
      "date": "2024-01-15",
      "dateFormatted": "string",
      "dateValue": 1,
      "debitAccount": {
        "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"
      },
      "description": "string",
      "draft": true,
      "files": [],
      "id": "string",
      "posted": true,
      "properties": {
        "key": "value"
      },
      "remoteIds": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "trashed": true,
      "updatedAt": "1592000000000",
      "urls": [
        "string"
      ]
    }
  ]
}

Responses

204

A successful response