Skip to main content

Budgets

This design is included in the Core module.

Description​

Design for managing financial budgets, including sub-budgets and budget periods for tracking expenditure against allocations.

Properties​

This design has the following properties.

PropertyValue
NameBudgets
Codedesigns_budgets
TypeDesign
ContextCore
AI agent enabledtrue
Iconicon-budgets
Colour#690095  
Title{{attributes_budgetsName}}
SubtitleBudget

Implements​

This design implements the following interfaces.

NameCode
Items With ReportsdesignInterfaces_itemsWithReports

Attributes​

This design has the following attributes. It may also inherit attributes from any of the interfaces it implements.

Name​

The name of the budget (e.g. Highways Maintenance Budget 2025/26).

PropertyValue
NameName
Codeattributes_budgetsName
TypeString
Requiredtrue
Uniquefalse
Read-onlyfalse
AI agent enabledtrue
Options
{
"max": 128
}

Code​

A short reference code used to identify the budget in reports and integrations.

PropertyValue
NameCode
Codeattributes_budgetsCode
TypeString
Requiredtrue
Uniquefalse
Read-onlyfalse
AI agent enabledtrue
Options
{
"max": 32
}

Periods​

Links to the collection of budget periods defining when and how budget value is allocated over time.

PropertyValue
NamePeriods
Codeattributes_budgetsPeriods
TypeLink
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledtrue
Links toBudget Periods
Options
{
"code": "designs_budgetPeriods",
"graph": "Budget"
}

Sub Budget​

Reference to a parent budget, allowing nested sub-budget structures.

PropertyValue
NameSub Budget
Codeattributes_budgetsSubBudget
TypeLink
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledtrue
Links toBudgets
Options
{
"code": "designs_budgets",
"graph": "Budget"
}

Standard paths​

This design doesn't have any standard paths of its own. However, it may inherit standard paths from any of the interfaces it implements.

Permissions​

This design defines the following permissions.

User groupAllowed
Budget ViewersRead
Budget ManagersRead, Create, Edit, Delete

Default attribute permissions​

This design applies the following default permissions to all attributes for the following user groups.

AllowedUser groupCode
ReadOnlyBudget ViewersuserGroups_budgetViewers
ReadWriteBudget ManagersuserGroups_budgetManagers