Class CreateBudgetDetails

The create budget details.
Clients should use 'targetType' and 'targets' to specify the target type and list of targets on which the budget is applied.
For backwards compatibility, 'targetCompartmentId' is still supported for all existing clients. This is considered deprecated, however, and all clients are upgraded to use 'targetType' and 'targets'.
Specifying both 'targetCompartmentId' and 'targets' causes a Bad Request.

Inheritance

object

CreateBudgetDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.BudgetService.Models

Assembly: OCI.DotNetSDK.Budget.dll

Syntax

public class CreateBudgetDetails

Properties

Amount

Declaration

[Required(ErrorMessage = "Amount is required.")]
[JsonProperty(PropertyName = "amount")]
public decimal? Amount { get; set; }

Property Value

Type	Description
decimal?	The amount of the budget expressed as a whole number in the currency of the customer's rate card.

Remarks

Required

BudgetProcessingPeriodStartOffset

Declaration

[JsonProperty(PropertyName = "budgetProcessingPeriodStartOffset")]
public int? BudgetProcessingPeriodStartOffset { get; set; }

Property Value

Type	Description
int?	The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	The description of the budget.

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The displayName of the budget. Avoid entering confidential information.

EndDate

Declaration

[JsonProperty(PropertyName = "endDate")]
public DateTime? EndDate { get; set; }

Property Value

Type	Description
DateTime?	The date when the one-time budget concludes. For example, `2023-03-23`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

ProcessingPeriodType

Declaration

[JsonProperty(PropertyName = "processingPeriodType")]
[JsonConverter(typeof(StringEnumConverter))]
public ProcessingPeriodType? ProcessingPeriodType { get; set; }

Property Value

Type	Description
ProcessingPeriodType?	The type of the budget processing period. Valid values are INVOICE, MONTH, and SINGLE_USE.

ResetPeriod

Declaration

[Required(ErrorMessage = "ResetPeriod is required.")]
[JsonProperty(PropertyName = "resetPeriod")]
[JsonConverter(typeof(StringEnumConverter))]
public ResetPeriod? ResetPeriod { get; set; }

Property Value

Type	Description
ResetPeriod?	The reset period for the budget.

Remarks

Required

StartDate

Declaration

[JsonProperty(PropertyName = "startDate")]
public DateTime? StartDate { get; set; }

Property Value

Type	Description
DateTime?	The date when the one-time budget begins. For example, `2023-03-23`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.

TargetCompartmentId

Declaration

[JsonProperty(PropertyName = "targetCompartmentId")]
public string TargetCompartmentId { get; set; }

Property Value

Type	Description
string	This is DEPRECATED. Set the target compartment ID in targets instead.

TargetType

Declaration

[JsonProperty(PropertyName = "targetType")]
[JsonConverter(typeof(StringEnumConverter))]
public TargetType? TargetType { get; set; }

Property Value

Type	Description
TargetType?	The type of target on which the budget is applied.

Targets

Declaration

[JsonProperty(PropertyName = "targets")]
public List<string> Targets { get; set; }

Property Value

Type	Description
List<string>	The list of targets on which the budget is applied. If targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}". Curerntly, the array should contain exactly one item.