Budgets
An approved financial plan for one company, fiscal year, and scenario.
- API name:
accountingbudgets - Domain: Accounting
- Modules: Finance analytics, Finances
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | label | Text I18n | ||
| Fiscal year | accountingfiscalyearId | Reference | Yes | |
| Source budget | accountingbudgetIdSource | Reference | ||
| Scenario | scenario | Constant | Yes | Fixed option from the allowed set for this field. |
| Version | version | Whole Number | Yes | Whole number without fractional part. |
| Total | total | Currency | Yes | Document total after discounts, tax, and withholding in document currency. |
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Approved by | approvedBy | User | ||
| Approved at | approvedAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Fiscal year accountingfiscalyearId | Fiscal years | reference |
Source budget accountingbudgetIdSource | Budgets | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event accountingbudgets.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new budget. | App · API · MCP · CLI |
| Edit | update | Save changes to this budget. | App · API · MCP · CLI |
| Approve | approve | Approve this budget so the next step can run. | App · API · MCP · CLI |
| Revise | revise | Open a new revision of this budget. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this budget. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this budget again. | App · API · MCP · CLI |
| Archive | archive | Retire this budget from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · API · MCP · CLI |
| Restore | unarchive | Return this budget to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this budget and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.