Overview

The Budgets Data Model represents a planned allocation of amounts for a defined period, broken down into budget lines against accounts, projects, items, or tracking categories. This unified model standardises budget information across accounting platforms.

Unified budget properties: Essential budget details, such as name, type, status, currency, and the start and end dates of the budget period, are standardised across different accounting platforms
Budget lines: The budget_lines property includes an array of related budget lines, each carrying the amount planned for one account, project, or item on a given date

Attributes

Budgets Attributes

Property	Type	Description
`rootfi_id`	integer	Unique identifier assigned by Commenda for this budget
`rootfi_created_at`	string	Timestamp when this record was created in Commenda’s system (ISO 8601)
`rootfi_updated_at`	string	Timestamp when this record was last updated in Commenda’s system (ISO 8601)
`rootfi_integration_type`	enum
`platform_id`	string	Unique identifier for this budget in the source accounting platform
`name`	string	The name of the budget
`budget_type`	enum	The type of the budget
`status`	enum	The status of the budget
`currency_id`	enum	ISO 4217 currency code
`start_date`	string	The first day of the budget period
`end_date`	string	The last day of the budget period
`updated_at`	string	The date and time the budget was last updated

Budget Type Enum Values

Value	Description
`PROJECT`	Budget is planned against a project
`GENERAL_LEDGER`	Budget is planned against general ledger accounts
`UNKNOWN`	Budget type could not be determined

Status Enum Values

Value	Description
`ACTIVE`	Budget is in use
`ARCHIVED`	Budget is no longer in use
`UNKNOWN`	Budget status could not be determined

Budget Lines Attributes

Property	Type	Description
`rootfi_id`	integer	Unique identifier assigned by Commenda for this budget line
`rootfi_created_at`	string	Timestamp when this record was created in Commenda’s system (ISO 8601)
`rootfi_updated_at`	string	Timestamp when this record was last updated in Commenda’s system (ISO 8601)
`rootfi_integration_type`	enum
`platform_id`	string	Unique identifier for this budget line in the source accounting platform
`budget_id`	string	The budget this line belongs to
`account_id`	string	The account the line is planned against
`project_id`	string	The project the line is planned against
`item_id`	string	The item the line is planned against
`tracking_category_ids`	array	Tracking categories applied to the line
`description`	string	The description of the budget line
`quantity`	double	The planned quantity
`unit_amount`	double	The planned amount per unit
`total_amount`	double	The planned total amount
`date`	string	The date the line is planned for
`updated_at`	string	The date and time the budget line was last updated

Expandable Attributes

Use the expand query parameter to include related objects:

expand=budget_lines — includes the related Budget Lines object(s).

Properties Supported

Fields accepted when creating or updating a record:

Property	Type	Description
`platform_id`	string	Unique identifier for this budget in the source accounting platform
`name`	string	The name of the budget
`budget_type`	enum	The type of the budget
`status`	enum	The status of the budget
`currency_id`	enum	ISO 4217 currency code
`start_date`	string	The first day of the budget period
`end_date`	string	The last day of the budget period
`updated_at`	string	The date and time the budget was last updated
`budget_lines`	array	Budget lines to create or update with the budget

General

Server Side SDKs

Core

Unified API

Attributes

Budgets Attributes

Budget Type Enum Values

Status Enum Values

Budget Lines Attributes

Expandable Attributes

Properties Supported

​Attributes

​Budgets Attributes

​Budget Type Enum Values

​Status Enum Values

​Budget Lines Attributes

​Expandable Attributes

​Properties Supported

Attributes

Budgets Attributes

Budget Type Enum Values

Status Enum Values

Budget Lines Attributes

Expandable Attributes

Properties Supported