BudgetsReference
Reference
Complete reference for budget fields, enums, and settings
Budget Reference
This section provides quick-reference documentation for all budget-related fields, enum values, and configuration options.
Reference Topics
Enforcement Modes
Complete reference for TRACK_ONLY, WARN_WHEN_EXCEEDED, REQUIRE_APPROVAL_WHEN_EXCEEDED, and BLOCK_WHEN_EXCEEDED.
Allocation Types
Complete reference for PER_USER and SHARED_POOL allocation types.
Transaction Types
Complete reference for BOOKING_PENDING, BOOKING_COMPLETED, BOOKING_CANCELLED, REFUND, ROLLOVER_IN, and ROLLOVER_OUT.
Field Definitions
All fields for Budget, BudgetPeriod, UserBudgetPeriod, CostCenter, and assignment entities.
Company Settings
All company-level budget settings with defaults and valid values.
Quick Reference Tables
Enforcement Modes
| Mode | Enum Value | When Exceeded |
|---|---|---|
| Track Only | TRACK_ONLY | Allow (no restriction) |
| Warn | WARN_WHEN_EXCEEDED | Warn then allow |
| Require Approval | REQUIRE_APPROVAL_WHEN_EXCEEDED | Create booking request |
| Block | BLOCK_WHEN_EXCEEDED | Prevent booking |
Allocation Types
| Type | Enum Value | Distribution |
|---|---|---|
| Per User | PER_USER | Each user gets full amount |
| Shared Pool | SHARED_POOL | All users share one pool |
Period Types
| Type | Enum Value | Duration |
|---|---|---|
| Monthly | MONTHLY | 1 month |
| Quarterly | QUARTERLY | 3 months |
| Yearly | YEARLY | 12 months |
Rollover Policies
| Policy | Enum Value | Behavior |
|---|---|---|
| None | NONE | Unused expires |
| Partial | PARTIAL | Percentage carries over |
| Full | FULL | All carries over |
Transaction Types
| Type | Enum Value | Impact |
|---|---|---|
| Pending | BOOKING_PENDING | +pending, -remaining |
| Completed | BOOKING_COMPLETED | +spent, -pending |
| Cancelled | BOOKING_CANCELLED | -pending, +remaining |
| Refund | REFUND | -spent, +remaining |
| Rollover In | ROLLOVER_IN | +rollover in new period |
| Rollover Out | ROLLOVER_OUT | Documents outgoing rollover |
Related Documentation
- Concepts - Understand how these work
- Admin Guide - Configure budgets
- Troubleshooting - Resolve issues