Skip to content

Asana: Budgets schemas

17 Asana schemas with complete fields and constraints.

← Budgets operations · All schemas

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 / 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 / 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

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

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

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 / 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

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 / 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

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`.
Known values: 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`.
Known values: 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.

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

Get a budget — response body — data data actual, estimate, parent, total total enabled, units, value 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.
valueJSONOptional
value (anyOf 1)numberAlternativeThe 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.
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

FieldTypePresenceDescription and constraints
$objectRootRepresents the configured total portion of a budget. The total value is user-defined and may differ for each budget_type. When budget_type is time, it is expressed in minutes; when budget_type is cost, it is expressed in the domain’s ISO 4217 currency code. When enabled is false, both value and units will be null.
unitsstringOptionalThe units of the total 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 `enabled` is `false`, this field will be `null`.
Read only: true

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 data — sdk__Budget Response

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *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
estimateobjectOptionalDefines 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.Defines 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.
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.
estimate.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`.
Known values: billable, non_billable, any
estimate.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`.
Known values: none, tasks, capacity_plans
estimate.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.
estimate.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
estimate.valueJSONOptional
estimate.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
estimate.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
actualobjectOptionalDefines 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.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.
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.
actual.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
actual.valueJSONOptional
actual.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
actual.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
actual.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
totalobjectOptionalDefines 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.Defines 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.
Represents the configured total portion of a budget. The total value is user-defined and may differ for each budget_type. When budget_type is time, it is expressed in minutes; when budget_type is cost, it is expressed in the domain’s ISO 4217 currency code. When enabled is false, both value and units will be null.
total.enabledbooleanOptionalIndicates whether the total value is active and should be displayed in the budget. This flag primarily affects UI presentation and the response payload.
total.valueJSONOptional
total.value (anyOf 1)numberAlternativeThe 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.
total.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total.unitsstringOptionalThe units of the total 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 `enabled` is `false`, this field will be `null`.
Read only: true
parentModelOptionalExpand Get a rate — response body — data data parent

Referenced models: Get a rate — response body — data data parent

Get all budgets — response body — data, next page

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get a budget — response body — data data — sdk__Budget Response
next_pageModelOptionalExpand Get goals — response body — data, next page next page

Referenced models: Get goals — response body — data, next page next page, Get a budget — response body — data data — sdk__Budget Response

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.