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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.budget_gid | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One 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
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 1).data | Model | Optional | Expand Get a budget — response body — data data — Budget Response |
$ (allOf 2) | Model | All variants apply | Expand Get a budget — response body — data |
Referenced models: Get a budget — response body — data data — Budget Response, Get a budget — response body — data
Schemas
Section titled “Schemas”5 more schemas are linked from the tables above, on the schema pages.
Get a budget — response body — data data — Budget Response
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand 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) | object | All variants apply | Represents 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).value | JSON | Optional | |
$ (allOf 2).value (anyOf 1) | number | Alternative | The 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).units | string | Optional | The 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 |
Get a budget — response body — data / data / budget_type: cost, time
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *budget* object represents a budget for a given parent. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
budget_type | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand 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) | object | All variants apply | Represents 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).units | string | Optional | The 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).value | JSON | Optional | |
$ (allOf 2).value (anyOf 1) | number | Alternative | The 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get a budget — response body — data data actual, estimate, parent, total total enabled, units, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a budget — response body — data data actual, estimate, parent, total total enabled, units, value enabled, value |
$ (allOf 2) | Model | All variants apply | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | Name 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_subtype | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines 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_filter | string | Optional | Billable 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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.