Skip to main content

List budget tasks

GET 
/api/budget-tasks

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

    budget_area_id integer

    The id of the budget area 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 budget tasks.

Schema

  • Array [

    • id integerrequired

    Possible values: >= 1

    created_at date-timerequired
    updated_at date-timerequired
    uid stringrequired

    The unique identifier of the task

    name stringrequired

    Possible values: <= 255 characters

    The task name

    currency string

    The currency code

    external_cost floatrequired

    The external costs of the task

    markup integerrequired

    The markup to apply to external cost

    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, PRODUCT, PM]

    The type of the task

    is_deleted booleanrequired

    Whether the task is deleted

    notes stringrequired

    The task notes

    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"

    product_quantity integer

    The quantity of product to add to the task. This is only used if the task is of type "PRODUCT"

    budget_area_id integerrequired

    Possible values: >= 1

    The ID of the budget area this task belongs to

  • ]

Loading...