Skip to main content

List budgets

GET 
/api/budgets

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​

Query Parameters

    limit integer

    Possible values: <= 100

    Default value: 100

    The number of items to include in the response.

    offset integer

    Default value: 0

    The offset of the first returned item.

    updated_at date-time

    Filter items by the updated_at field. This is in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    Examples:

    Filter items updated on a date.

    Example: 2024-01-01T20:00:00%2B02:00

    project_id integer

    The id of the project to filter the results on.

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Responses​

Returns the list of budgets.

Schema

  • Array [

    • id integerrequired

    Possible values: >= 1

    created_at date-timerequired
    updated_at date-timerequired
    version integerrequired

    The version of the budget

    status stringrequired

    Possible values: [DRAFT, SUBMITTED, APPROVED]

    The status of the budget

    final_net_price floatrequired

    The final net price of the budget

    total_external_cost floatrequired

    The total external costs of the budget

    total_cost floatrequired

    The total cost of the budget

    total_price floatrequired

    The total price of the budget

    total_days floatrequired

    The total days of the budget

    is_baseline booleanrequired

    Whether this version should consider the "baseline" version

    notes stringrequired

    The budget notes

    currency string

    The currency code

    is_currency_enabled booleanrequired

    Whether custom currency is enabled

    project_id integerrequired

    Possible values: >= 1

    The ID of the project this budget belongs to

    price_list_id integerrequired

    Possible values: >= 1

    The ID of the price list this budget belongs to

  • ]

Loading...