Budget
/api/v1/finance/budgetsA budget envelope for a period and owner.
listgetcreateupdateSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| name | string | Descriptive name for this budget (e.g. 'Engineering Q1 2026'). |
| fiscal_year | string | Fiscal year label (e.g. '2026' or 'FY2026'). |
| period | string | Budget period granularity. |
| cost_center_id | uuid | UUID of the CostCenter this budget belongs to. Null for company-wide budgets. |
| owner_id | uuid | UUID of the Person responsible for this budget. |
| total_amount | number | Total budget amount allocated for this period. |
| currency | string | ISO 4217 three-character currency code. |
| status | string | Lifecycle status of the budget. |
| notes | string | Free-form notes about this budget. |
| amount | number | Total budgeted amount. |
| start_date | date-time | ISO 8601 start date of the budget period. |
| end_date | date-time | ISO 8601 end date of the budget period. |
| tags | json | Free-form tags for grouping and filtering. |
API
client.finance.budgets.*Loading manifest…