listAccountGroups

GET

/v5/books/{bookId}/accounts/{id}/groups

List the groups of an account

Parameters

Path Parameters

bookId

required

string

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

id

required

string

The account id or name

Responses

200

A GroupList response

object

items

List items

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

Example

{
  "items": [
    {
      "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"
    }
  ]
}