Create a budget
POST/api/budgets
Required permissions:
- budget.create: allows creating a budget for a project where the user is the PM or 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
ID of the project for which to create a budget
ID of the price list for this budget.
ID of the budget template used to create the budget.
Final net price of the budget. If not provided, it will be calculated based on the project estimate
Additional notes about the budget
Responses
- 201
- 400
- 401
- 403
Returns the created budget.
- 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
Possible values: >= 1
The ID of the project this budget belongs to
Possible values: >= 1
The ID of the price list this budget belongs to
The version of the budget
Possible values: [DRAFT
, SUBMITTED
, APPROVED
]
The status of the budget
The final net price of the budget in the master currency
The final net price of the budget in the budget currency
The total external costs of the budget
The total cost of the budget
The total price of the budget
The total days of the budget
Whether this budget version is the baseline
The budget notes
The currency code
Whether custom currency is enabled
{
"id": 1,
"created_at": "2025-06-06T13:37:10.526Z",
"updated_at": "2025-06-06T13:37:10.526Z",
"project_id": 1,
"price_list_id": 1,
"version": 1,
"status": "APPROVED",
"final_net_price": 12000,
"final_net_price_currency": 12000,
"total_external_cost": 14400,
"total_cost": 10000,
"total_price": 15000,
"total_days": 20.5,
"is_baseline": false,
"notes": "Important budget",
"currency": "EUR",
"is_currency_enabled": false
}
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"
}