Create a budget area
POST/api/budget-areas
Required permissions:
- budget.edit: allows edit resources of projects where the user is the PM or the Account.
- budget.edit_other: allows edit resources of projects where the user is not the PM nor the Account.
Here the dedicated support page.
Request
Header Parameters
The company you want to interact with
The API version you want to use
- application/json
Body
Possible values: <= 255 characters
The budget area name
The id of the budget where we want to create the budget area
Responses
- 201
- 400
- 401
- 403
Returns the created budget area.
- application/json
- Schema
- Example (from schema)
Schema
Possible values: >= 1
The unique identifier of the resource
The date and time when the resource was created
The date and time when the resource was last updated
The name of the budget area
Whether the budget area is enabled
Possible values: [DEFAULT
, CONTINGENCY-DISCOUNT
, TRAVEL-CORE-COST-EXPENSES
, PM
]
The type of the budget area
The total external cost of the budget area
The total cost of the budget area
The total price of the budget area
The total days of the budget area
Possible values: >= 1
The ID of the budget to which this area belongs
Possible values: >= 1
ID of the price list associated with this budget area
{
"id": 1,
"created_at": "2025-06-06T13:37:10.475Z",
"updated_at": "2025-06-06T13:37:10.475Z",
"name": "Marketing",
"is_enabled": true,
"type": "DEFAULT",
"total_external_cost": 3.2,
"total_cost": 50.2,
"total_price": 100.5,
"total_days": 3.5,
"budget_id": 1,
"price_list_id": 1
}
Validation failed
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Error unique key
Human-readable message describing the error
failures
object[]
List of validation errors
Name of the field causing the error
Human-readable description of the error
{
"key": "invalid_data",
"message": "You provided invalid data. Check 'failures' for details.",
"failures": [
{
"field": "string",
"message": "string"
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
Error unique key
Human-readable message describing the error
{
"key": "string",
"message": "string"
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Error unique key
Human-readable message describing the error
{
"key": "string",
"message": "string"
}