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

Possible values: Value must match regular expression [0-9]+

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

The unique identifier of the resource

created_at date-timerequired

The date and time when the resource was created

updated_at date-timerequired

The date and time when the resource was last updated

name stringrequired

The name of the budget area

is_enabled booleanrequired

Whether the budget area is enabled

type stringrequired

Possible values: [DEFAULT, CONTINGENCY-DISCOUNT, TRAVEL-CORE-COST-EXPENSES, PM]

The type of the budget area

total_external_cost floatrequired

The total external cost of the budget area

total_cost floatrequired

The total cost of the budget area

total_price floatrequired

The total price of the budget area

total_days floatrequired

The total days of the budget area

budget_id integerrequired

Possible values: >= 1

The ID of the budget to which this area belongs

price_list_id integerrequired

Possible values: >= 1

ID of the price list associated with this budget area

Example (from schema)

{
  "id": 1,
  "created_at": "2025-06-06T13:37:10.488Z",
  "updated_at": "2025-06-06T13:37:10.488Z",
  "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
}

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...