Get a budget task
GET/api/budget-tasks/:id
Required permissions:
- budget.view: allows view resources of projects where the user is the PM or the Account.
- budget.view_other: allows view resources of projects where the user is not the PM nor the Account.
Here the dedicated support page.
Request
Path Parameters
The ID of the budget task to view
Header Parameters
The company you want to interact with
The API version you want to use
Responses
- 200
- 400
- 401
- 403
- 404
Returns the requested budget task.
- application/json
- Schema
- Example (from schema)
Schema
Possible values: >= 1
The unique identifier of the task
Possible values: <= 255 characters
The task name
The currency code
The external costs of the task
The markup to apply to external cost
The total cost of the task
The total price of the task
The total days of the task
Possible values: [DEFAULT
, DISCOUNT
, CONTINGENCY
, TRAVEL
, EXPENSE
, PRODUCT
, PM
]
The type of the task
Whether the task is deleted
The task notes
Possible values: >= 1
The ID of the product linked to this task. This is only used if the task is of type "PRODUCT"
The quantity of product to add to the task. This is only used if the task is of type "PRODUCT"
Possible values: >= 1
The ID of the budget area this task belongs to
{
"id": 1,
"created_at": "2025-04-22T10:10:02.236Z",
"updated_at": "2025-04-22T10:10:02.236Z",
"uid": "uid_01a2bcd3e4f56",
"name": "Development",
"currency": "EUR",
"external_cost": 1000,
"markup": 20,
"total_cost": 1200,
"total_price": 1440,
"total_days": 5.5,
"type": "DEFAULT",
"is_deleted": false,
"notes": "Important task",
"product_id": 1,
"product_quantity": 1,
"budget_area_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"
}
Not found
- application/json
- Schema
- Example (from schema)
Schema
Error unique key
Human-readable message describing the error
{
"key": "not_found",
"message": "string"
}