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 integerrequired

The ID of the budget area to view

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": "2025-04-22T10:10:02.184Z",
  "updated_at": "2025-04-22T10:10:02.184Z",
  "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
}

400

Validation failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

failures

object[]

List of validation errors

Array [

field string

Name of the field causing the error

message string

Human-readable description of the error

]

Example (from schema)

{
  "key": "invalid_data",
  "message": "You provided invalid data. Check 'failures' for details.",
  "failures": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

403

Forbidden

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

404

Not found

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "not_found",
  "message": "string"
}

Loading...