BudgetGroup

A budget group: the organisation-wide category budgets are filed under, carrying the icon plnnrly shows beside them.

Summary view: BudgetGroupList, 7 fields. What a list returns by default.
Detail view: BudgetGroup, 7 fields. The default for a single read and for every write.
Read with: api:read:budget_groupsandbudget_groups::read
Write with: api:write:budget_groupsandbudget_groups::create

Example

detail view

{
  "id": 1,
  "name": "Development",
  "icon": "heroicon-o-code-bracket",
  "created_at": "2026-03-04T09:15:00Z",
  "updated_at": "2026-03-04T09:15:00Z",
  "budgets_count": 1,
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1",
    "budgets": "https://<your-url>/api/v2/work-items/1"
  }
}

Deleting one ungroups its budgets permanently.

Used by

GETList budget groups/budget-groupsBudgetGroupList

POSTCreate a budget group/budget-groupsBudgetGroup

GETRead a budget group/budget-groups/{budget_group}BudgetGroup

PATCHUpdate a budget group/budget-groups/{budget_group}BudgetGroup

Fields

Detail only: Only in the detail view.
Only with include: Only when you ask for it with include.
Server-assigned: Set by plnnrly, never by a request.

idinteger

Unique identifier.

namestring≤ 255

Budget group name as shown in the UI. This is the default sort key.

iconstring≤ 255

Icon identifier rendered beside the group, e.g. heroicon-o-rectangle-stack.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync.

budgets_countinteger≥ 0

Number of budgets filed under this group.

linksBudgetGroupLinks

Show 2 child fields

links.selfurl

The canonical URI of this record.

links.budgetsurl

Budgets filed under this group.

Variants

BudgetGroupList 7 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

BudgetGroupSummary 2 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: icon, created_at, updated_at, budgets_count, links

BudgetGroupLinks 2 fields

The links object on this resource.

Keys: self, budgets

Something wrong or missing on this page? Tell us