Skip to content

Asana: Update a budget

Asana budgets.updateBudget: arguments, response, policy and SDK examples.

← Budgets operations · Get started

Operation asana.updatebudget

Provider route: PUT /budgets/{budget_gid}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/asana with npm, or alter-sdk-asana with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AsanaIntegration } from "@alter-ai/asana";
async function execute(input: Parameters<AsanaIntegration["budgets"]["updateBudget"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new AsanaIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.budgets.updateBudget(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_asana import AsanaIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = AsanaIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.budgets.update_budget(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.budget_gidstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.opt_prettybooleanOptional
query.opt_fieldsarrayOptional
query.opt_fields[]stringEach itemOne of: actual, actual.billable_status_filter, actual.units, actual.value, budget_type, estimate, estimate.billable_status_filter, estimate.enabled, estimate.source, estimate.units, estimate.value, parent, parent.name, parent.resource_subtype, total, total.enabled, total.units, total.value
bodyobjectRequired within parent
body.dataModelOptionalExpand Create a budget — request body — body data

Referenced models: Create a budget — request body — body data

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)objectAll variants apply
$ (allOf 1).dataModelOptionalExpand Get a budget — response body — data data — Budget Response
$ (allOf 2)ModelAll variants applyExpand Get a budget — response body — data

Referenced models: Get a budget — response body — data data — Budget Response, Get a budget — response body — data

9 more schemas are linked from the tables above, on the schema pages.

Create a budget — request body — body data
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Create a budget — request body — body / data / budget_type: cost, time
$ (allOf 2)objectAll variants apply
$ (allOf 2).estimateJSONOptional
$ (allOf 2).estimate (allOf 1)ModelAll variants applyExpand Create a budget — request body — body / data / actual, estimate, parent, total / estimate / billable_status_filter: billable, non billable, any, source: none, tasks, capacity plans
$ (allOf 2).actualJSONOptional
$ (allOf 2).actual (allOf 1)ModelAll variants applyExpand Create a budget — request body — body / data / actual, estimate, parent, total / actual / billable_status_filter: billable, non billable, any
$ (allOf 2).totalJSONOptional
$ (allOf 2).total (allOf 1)ModelAll variants applyExpand Create a budget — request body — body data actual, estimate, parent, total total enabled, value
$ (allOf 2).parentstringOptionalGlobally unique ID of the parent object: project. Can only be set on create, immutable thereafter.

Referenced models: Create a budget — request body — body / data / actual, estimate, parent, total / actual / billable_status_filter: billable, non billable, any, Create a budget — request body — body / data / budget_type: cost, time, Create a budget — request body — body / data / actual, estimate, parent, total / estimate / billable_status_filter: billable, non billable, any, source: none, tasks, capacity plans, Create a budget — request body — body data actual, estimate, parent, total total enabled, value

Get a budget — response body — data data — Budget Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a budget — response body — data / data / budget_type: cost, time
$ (allOf 2)objectAll variants apply
$ (allOf 2).estimateJSONOptional
$ (allOf 2).estimate (allOf 1)ModelAll variants applyExpand Get a budget — response body — data / data / actual, estimate, parent, total / estimate / billable_status_filter: billable, non billable, any, source: none, tasks, capacity plans
$ (allOf 2).actualJSONOptional
$ (allOf 2).actual (allOf 1)ModelAll variants applyExpand Get a budget — response body — data / data / actual, estimate, parent, total / actual / billable_status_filter: billable, non billable, any
$ (allOf 2).totalJSONOptional
$ (allOf 2).total (allOf 1)ModelAll variants applyExpand Get a budget — response body — data data actual, estimate, parent, total total enabled, units, value
$ (allOf 2).parentJSONOptional
$ (allOf 2).parent (allOf 1)ModelAll variants applyExpand Search projects in a workspace — response body — data data item
$ (allOf 2).parent (allOf 2)objectAll variants apply

Referenced models: Get a budget — response body — data / data / actual, estimate, parent, total / actual / billable_status_filter: billable, non billable, any, Get a budget — response body — data / data / budget_type: cost, time, Get a budget — response body — data / data / actual, estimate, parent, total / estimate / billable_status_filter: billable, non billable, any, source: none, tasks, capacity plans, Get a budget — response body — data data actual, estimate, parent, total total enabled, units, value, Search projects in a workspace — response body — data data item

Get a budget — response body — data
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a budget — response body — data data — sdk__Budget Response

Referenced models: Get a budget — response body — data data — sdk__Budget Response

Create a budget — request body — body / data / actual, estimate, parent, total / actual / billable_status_filter: billable, non billable, any
FieldTypePresenceDescription and constraints
$objectRootDefines the configuration of the actual portion of a budget. The actual value represents aggregated time tracking data attributed to the budget’s parent. This object controls which time entries are included based on their billable status. When no entries match the selected filter, the value will be 0.
billable_status_filterstringOptionalBillable status filter applied to time tracking entries contributing to the actual value. Determines which entries are included in aggregation. When not provided, defaults to `billable`.
One of: billable, non_billable, any
Create a budget — request body — body / data / budget_type: cost, time
FieldTypePresenceDescription and constraints
$objectRootA *budget* object represents a budget for a given parent.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
budget_typestringOptionalThe type of the budget, in "cost" or "time". The value of this property will dictate how the corresponding values for actual, estimate, and total are interpreted.
One of: cost, time
Create a budget — request body — body / data / actual, estimate, parent, total / estimate / billable_status_filter: billable, non billable, any, source: none, tasks, capacity plans
FieldTypePresenceDescription and constraints
$objectRootDefines how the estimate portion of a budget is configured. This object controls whether the estimate is enabled, what data source it uses, and which tasks (by billable status) are included in calculating the estimate value. When disabled (enabled: false and source: none), the estimate is hidden and the API response will return `value: null` and `units: null` for this field.
billable_status_filterstringOptionalBillable status filter applied to the estimate when `source` is `tasks`. Ignored when `source` is `capacity_plans` or `none`. When not provided, defaults to `billable`.
One of: billable, non_billable, any
sourcestringOptionalThe data source for the estimate. `tasks`: use task-level estimated time attributed to the parent. `capacity_plans`: use capacity plan estimates attributed to the parent. `none`: disables the estimate; only valid when `enabled` is `false`. When `enabled` is `true`, `source` must not be `none`.
One of: none, tasks, capacity_plans
enabledbooleanOptionalControls whether the estimate is displayed in the budget. This flag primarily affects UI presentation and the response payload. When `false` (and `source` is `none`), the estimate is hidden and the API response will return `value: null` and `units: null` for this field.
Create a budget — request body — body data actual, estimate, parent, total total enabled, value
FieldTypePresenceDescription and constraints
$objectRootDefines how the total portion of a budget is configured. The total represents a user-defined target value, not an aggregated one. This object specifies whether the total is displayed and the current value for the selected budget_type.
enabledbooleanOptionalIndicates whether the total value is active and should be displayed in the budget. This flag primarily affects UI presentation and the response payload.
valuenumberOptionalThe user-set value for the total budget. When `budget_type` is `time`, represents minutes. When `budget_type` is `cost`, represents the monetary amount in the domain's currency. This value is stored separately for each `budget_type`, so switching between types preserves each value.
Get a budget — response body — data / data / budget_type: cost, time
FieldTypePresenceDescription and constraints
$objectRootA *budget* object represents a budget for a given parent.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
budget_typestringOptionalThe type of the budget, in "cost" or "time". The value of this property will dictate how the corresponding values for actual, estimate, and total are interpreted.
Known values: cost, time
Get a budget — response body — data data actual, estimate, parent, total total enabled, units, value
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a budget — response body — data data actual, estimate, parent, total total enabled, units, value enabled, value
$ (allOf 2)ModelAll variants applyExpand Get a budget — response body — data data actual, estimate, parent, total total enabled, units, value units

Referenced models: Get a budget — response body — data data actual, estimate, parent, total total enabled, units, value enabled, value, Get a budget — response body — data data actual, estimate, parent, total total enabled, units, value units

SDK function policy ID: asana.updatebudget. Catalog operation: asana:updateBudget. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.