Skip to content

Asana: Get a budget

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

← Budgets operations · Get started

Operation asana.getbudget

Provider route: GET /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"]["getBudget"]>[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.getBudget(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.get_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

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

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

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

Get a budget — response body — data / data / actual, estimate, parent, total / actual / billable_status_filter: billable, non billable, any
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a budget — response body — data / data / actual, estimate, parent, total / actual / billable_status_filter: billable, non billable, any billable status filter: billable, non billable, any
$ (allOf 2)objectAll variants applyRepresents the computed actual portion of a budget. The actual value is derived from time tracking entries attributed to the budget’s parent, filtered according to the specified billable_status_filter. When budget_type is time, it represents minutes; when budget_type is cost, it represents total cost (actual time × resource rate). When no applicable entries exist, value will be 0.
$ (allOf 2).valueJSONOptional
$ (allOf 2).value (anyOf 1)numberAlternativeThe aggregated actual value for the budget. * When `budget_type` is `time`, represents the total actual minutes from time tracking entries. * When `budget_type` is `cost`, represents the total actual cost, computed as (actual time × resource rate).
Read only: true
$ (allOf 2).value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 2).unitsstringOptionalThe units of the actual value. * When `budget_type` is `time`, units are `"minutes"`. * When `budget_type` is `cost`, units are the ISO 4217 currency code configured at the domain level.
Read only: true

Referenced models: Get a budget — response body — data / data / actual, estimate, parent, total / actual / billable_status_filter: billable, non billable, any billable status filter: billable, non billable, any

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 / estimate / billable_status_filter: billable, non billable, any, source: none, tasks, capacity plans
FieldTypePresenceDescription and constraints
$JSONRoot
$ (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 billable status filter: billable, non billable, any, source: none, tasks, capacity plans
$ (allOf 2)objectAll variants applyRepresents the computed estimate portion of a budget. This object includes the calculated estimate value and its corresponding units. The estimate reflects aggregated data from the configured source, and when source is tasks, the specified billable_status_filter determines which tasks contribute. When disabled (enabled: false and source: none), both value and units will be null.
$ (allOf 2).unitsstringOptionalThe units of the estimate value. When `budget_type` is `time`, units are `"minutes"`. When `budget_type` is `cost`, units are the ISO 4217 currency code configured at the domain level. When `source` is `none` and `enabled` is `false`, this field will be `null`.
Read only: true
$ (allOf 2).valueJSONOptional
$ (allOf 2).value (anyOf 1)numberAlternativeThe aggregated estimate value for the budget. This value is computed based on the selected `source` and, when `source` is `tasks`, the specified `billable_status_filter`. When `budget_type` is `time`, represents the aggregated estimated minutes on the parent. When `budget_type` is `cost`, represents the aggregated estimated cost on the parent (estimated time x resource rate). When `source` is `none` and `enabled` is `false`, this field will be `null`.
Read only: true
$ (allOf 2).value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get a budget — response body — data / data / actual, estimate, parent, total / estimate / billable_status_filter: billable, non billable, any, source: none, tasks, capacity plans 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
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

Search projects in a workspace — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootA *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalName of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
resource_subtypestringOptionalThe subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning.
Known values: default_project, custom
Get a budget — response body — data / data / actual, estimate, parent, total / actual / billable_status_filter: billable, non billable, any 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`.
Known values: billable, non_billable, any

SDK function policy ID: asana.getbudget. Catalog operation: asana:getBudget. 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.