Get a budget area

GET 
/api/budget-areas/: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

id stringrequired

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

Responses

200

Returns the requested budget area.

application/json

Schema

Schema

id integerrequired

Possible values: >= 1

created_at date-timerequired
updated_at date-timerequired
name stringrequired
is_enabled booleanrequired
type stringrequired
total_external_cost floatrequired
total_cost floatrequired
total_price floatrequired
total_days floatrequired
budget_id integerrequired

Possible values: >= 1

ID of the budget to which this area belongs

Example (from schema)

{
  "id": 1,
  "created_at": "2024-09-05T08:23:05.839Z",
  "updated_at": "2024-09-05T08:23:05.839Z",
  "name": "string",
  "is_enabled": true,
  "type": "string",
  "total_external_cost": 3.2,
  "total_cost": 50.2,
  "total_price": 100.5,
  "total_days": 3.14,
  "budget_id": 1
}

403

Forbidden

404

Not found

Loading...