Skip to main content

Update a budget

PATCH 

/api/budgets/{id}

Required permissions:

  • budget.edit: allows editing budgets where the user is the PM or the Account.
  • budget.edit_other: allows editing budgets 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 to update

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Body

    price_list_id integer

    The ID of the price list to associate with this budget

    final_net_price number

    The final net price of the budget in the master currency

    final_net_price_currency number

    The final net price of the budget in the budget currency

    currency_enabled boolean

    Whether multicurrency is enabled for the budget

    currency string

    The currency code for the budget

    notes string

    Notes about the budget

Responses

Returns the updated budget.

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

    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

    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 in the master currency

    final_net_price_currency float

    The final net price of the budget in the budget currency

    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 budget version is the baseline

    notes stringrequired

    The budget notes

    currency string

    The currency code

    is_currency_enabled booleanrequired

    Whether custom currency is enabled

Loading...