Skip to main content

Update a budget task

PATCH 
/api/budget-tasks/{id}

Required permissions:

  • budget.edit: allows edit resources of projects where the user is the PM or the Account.
  • budget.edit_other: allows edit 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 task 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

    name string

    Possible values: <= 255 characters

    The name of the task

    external_cost float

    The external costs of the task

    markup integer

    The markup to apply to external costs of the task

    notes string

    Possible values: <= 255 characters

    The notes of the task

    quantity integer

    The quantity related to the task. This is only used if the task is of type 'CONTINGENCY', 'DISCOUNT', 'CREATIVITY' or 'PRODUCT'

Responses​

Returns the budget task updated.

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

    uid stringrequired

    The unique identifier of the task

    name stringrequired

    Possible values: <= 255 characters

    The name of the task

    currency string

    The currency code of the task

    external_cost floatrequired

    The external costs of the task

    markup integerrequired

    The markup to apply to external costs of the task

    total_cost floatrequired

    The total cost of the task

    total_price floatrequired

    The total price of the task

    total_days floatrequired

    The total days of the task

    type stringrequired

    Possible values: [DEFAULT, DISCOUNT, CONTINGENCY, TRAVEL, EXPENSE, CREATIVITY, PRODUCT, PM]

    The type of the task.
    The type of percentage task in Contingency & Discount area is CREATIVITY.
    The type of normal task in user created area is DEFAULT

    is_deleted booleanrequired

    Whether the task is deleted

    notes stringrequired

    The notes of the task

    product_id integer

    Possible values: >= 1

    The ID of the product linked to this task. This is only used if the task is of type 'PRODUCT'

    quantity integer

    The quantity related to the task. This is only used if the task is of type 'CONTINGENCY', 'DISCOUNT', 'CREATIVITY' or 'PRODUCT'

    budget_area_id integerrequired

    Possible values: >= 1

    The ID of the budget area this task belongs to

Loading...