Skip to content

BudgetSummary

Source code in docs_src/capo_deadline/types/budget_summary.py
class BudgetSummary(TypedDict, closed=True):
    budget_id: "capo_deadline.types.budget_id.BudgetId"
    """<p>The budget ID.</p>"""
    usage_tracking_resource: (
        "capo_deadline.types.usage_tracking_resource.UsageTrackingResource"
    )
    """<p>The resource used to track expenditure in the budget.</p>"""
    status: "capo_deadline.types.budget_status.BudgetStatus"
    """<p>The status of the budget.</p> <ul> <li> <p> <code>ACTIVE</code>–The budget is being evaluated.</p> </li> <li> <p> <code>INACTIVE</code>–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.</p> </li> </ul>"""
    display_name: "capo_deadline.types.resource_name.ResourceName"
    """<p>The display name of the budget summary to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>"""
    approximate_dollar_limit: (
        "capo_deadline.types.consumed_usage_limit.ConsumedUsageLimit"
    )
    """<p>The approximate dollar limit of the budget.</p>"""
    usages: "capo_deadline.types.consumed_usages.ConsumedUsages"
    """<p>The consumed usage for the budget.</p>"""
    created_by: "capo_deadline.types.created_by.CreatedBy"
    """<p>The user or system that created this resource.</p>"""
    created_at: "capo_deadline.types.created_at.CreatedAt"
    """<p>The date and time the resource was created.</p>"""
    updated_by: NotRequired["capo_deadline.types.updated_by.UpdatedBy"]
    """<p>The user or system that updated this resource.</p>"""
    updated_at: NotRequired["capo_deadline.types.updated_at.UpdatedAt"]
    """<p>The date and time the resource was updated.</p>"""
    description: NotRequired["capo_deadline.types.description.Description"]
    """<p>The description of the budget summary.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>"""

approximate_dollar_limit instance-attribute

approximate_dollar_limit: ConsumedUsageLimit

The approximate dollar limit of the budget.

budget_id instance-attribute

budget_id: BudgetId

The budget ID.

created_at instance-attribute

created_at: CreatedAt

The date and time the resource was created.

created_by instance-attribute

created_by: CreatedBy

The user or system that created this resource.

description instance-attribute

description: NotRequired[Description]

The description of the budget summary.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

display_name instance-attribute

display_name: ResourceName

The display name of the budget summary to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

status instance-attribute

status: BudgetStatus

The status of the budget.

  • ACTIVE–The budget is being evaluated.

  • INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.

updated_at instance-attribute

updated_at: NotRequired[UpdatedAt]

The date and time the resource was updated.

updated_by instance-attribute

updated_by: NotRequired[UpdatedBy]

The user or system that updated this resource.

usage_tracking_resource instance-attribute

usage_tracking_resource: UsageTrackingResource

The resource used to track expenditure in the budget.

usages instance-attribute

The consumed usage for the budget.