Groups Function
BKPER_GROUPS
Fetch all Groups from your Bkper Book into Google Sheets. The function returns a complete listing of groups with their hierarchy, account counts, and custom properties.
Syntax
=BKPER_GROUPS(bookId, cache)
Parameters
bookId - The universal Book Id
cache - Increase this number to clear cache and fetch fresh data
Sample usage
=BKPER_GROUPS("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgKD_4bMLDA", 1)
Output Columns
The function returns the following columns:
Column | Description |
Group Id | Unique identifier for each group |
Name | Group name |
Type | Group type: ASSET, LIABILITY, INCOMING, OUTGOING, or mixed types |
Parent | Name of the parent group, if any |
Children | Number of child groups |
Accounts | Number of accounts in the group |
Custom properties | Any custom properties defined on the groups |
Group Types
Groups can have single or mixed types:
ASSET - Groups containing only Asset accounts
LIABILITY - Groups containing only Liability accounts
INCOMING - Groups containing only Incoming accounts
OUTGOING - Groups containing only Outgoing accounts
ASSET_LIABILITY - Groups that can contain both Asset and Liability accounts
INCOMING_OUTGOING - Groups that can contain both Incoming and Outgoing accounts
Sorting
Groups are sorted hierarchically - parent groups appear first, followed by their children. Within each level, groups are sorted by type and then alphabetically by name.