BudgetProperties interface
The properties of the budget.
Properties
| amount | The total amount of cost to track with the budget |
| category | The category of the budget, whether the budget tracks cost or usage. |
| current |
The current amount of cost which is being tracked for a budget. |
| filter | May be used to filter budgets by user-specified dimensions and/or tags. |
| forecast |
The forecasted cost which is being tracked for a budget. |
| notifications | Dictionary of notifications associated with the budget. Budget can have up to five notifications. |
| time |
The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers |
| time |
Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date. |
Property Details
amount
The total amount of cost to track with the budget
amount: number
Property Value
number
category
The category of the budget, whether the budget tracks cost or usage.
category: string
Property Value
string
currentSpend
The current amount of cost which is being tracked for a budget.
currentSpend?: CurrentSpend
Property Value
filter
May be used to filter budgets by user-specified dimensions and/or tags.
filter?: BudgetFilter
Property Value
forecastSpend
The forecasted cost which is being tracked for a budget.
forecastSpend?: ForecastSpend
Property Value
notifications
Dictionary of notifications associated with the budget. Budget can have up to five notifications.
notifications?: Record<string, Notification>
Property Value
Record<string, Notification>
timeGrain
The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers
timeGrain: string
Property Value
string
timePeriod
Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.
timePeriod: BudgetTimePeriod