Deprecated
November 3rd, 2026
10 days ago
Breaking change: Budget unit_type output values are changing
unit_type output values are changingEffective date: December 3, 2026
The unit_type response property is changing across the Budgets and Budget Changes endpoints. Instead of returning the measurement system (e.g. imperial, metric, volume, or power) or a display label (e.g. Square Feet), the API will return the actual unit of measure (e.g. square-feet).
What changes:
Budget Change unit_type values today | Budget unit_type values today | New unit_type values (from December 3) |
|---|---|---|
Lump Sum | null | lump-sum |
Square Feet | imperial | square-feet |
Square Meters | metric | square-meters |
Gross Square Feet | imperial | gross-square-feet |
Gross Square Meters | metric | gross-square-meters |
Rentable Square Feet | imperial | rentable-square-feet |
Rentable Square Meters | metric | rentable-square-meters |
Usable Square Feet | imperial | useable-square-feet |
Usable Square Meters | metric | useable-square-meters |
Hours | null | hours |
Days | null | days |
Inches | imperial | inches |
Each | null | each |
Yards | imperial | yards |
Meters | metric | meters |
Tons | null | tons |
Linear Feet | imperial | linear-feet |
Linear Meters | metric | linear-meters |
Cubic Yards | volume | cyds |
Cubic Meters | volume | cubic-meters |
Cubic Feet Per Minute | volume | cubic-feet-per-minute |
Cubic Meters Per Minute | volume | cubic-meters-per-minute |
Allowance | null | allowance |
% of lump sum | null | percent |
% of dependency | null | percent-of-dependency |
$/KwH | power | kwh |
Acres | imperial | acres |
Hectares | metric | hectares |
Watts | power | watts |
Bags | null | bags |
What remains unchanged:
- The
unit_typefield name. - The data type.
- The response structure.
Action required: If your integration uses the unit_type property, be aware that its values will change on December 3, 2026. Review how your integration handles this property and plan for the new unit-of-measure values (e.g. square-feet) instead of the current measurement system values or display labels. Ensure you are prepared for this change before it takes effect.
GET: /api/v2/pub/budgets
Change
- from December 3rd, 2026, the 'items/items/tasks/unit_type' response property for the response status '200' returns the unit of measure (e.g. 'square-feet') instead of the measurement system ('imperial', 'metric', 'volume', 'power' or null)
GET: /api/v2/pub/budgets/{id}
Change
- from December 3rd, 2026, the 'items/tasks/unit_type' response property for the response status '200' returns the unit of measure (e.g. 'square-feet') instead of the measurement system ('imperial', 'metric', 'volume', 'power' or null)
GET: /api/v2/pub/budget-changes
Change
- from December 3rd, 2026, the 'items/items/lines/unit_type' response property for the response status '200' returns the unit of measure (e.g. 'square-feet') instead of the display label (e.g. 'Square Feet')
GET: /api/v2/pub/budget-changes/{id}
Change
- from December 3rd, 2026, the 'items/lines/unit_type' response property for the response status '200' returns the unit of measure (e.g. 'square-feet') instead of the display label (e.g. 'Square Feet')