Class BillingInvoiceProperties

An invoice.

Inheritance
System.Object
BillingInvoiceProperties
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.Billing.dll
Syntax
public class BillingInvoiceProperties : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Billing.Models.BillingInvoiceProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Billing.Models.BillingInvoiceProperties>

Constructors

BillingInvoiceProperties()

Initializes a new instance of BillingInvoiceProperties.

Declaration
public BillingInvoiceProperties ();

Properties

AmountDue

The amount due as of now.

Declaration
public Azure.ResourceManager.Billing.Models.BillingAmount AmountDue { get; }
Property Value
BillingAmount

AzurePrepaymentApplied

The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Declaration
public Azure.ResourceManager.Billing.Models.BillingAmount AzurePrepaymentApplied { get; }
Property Value
BillingAmount

BilledAmount

The total charges for the invoice billing period.

Declaration
public Azure.ResourceManager.Billing.Models.BillingAmount BilledAmount { get; }
Property Value
BillingAmount

BilledDocumentId

The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only.

Declaration
public string BilledDocumentId { get; }
Property Value
System.String

BillingProfileDisplayName

The name of the billing profile for which the invoice is generated.

Declaration
public string BillingProfileDisplayName { get; }
Property Value
System.String

BillingProfileId

The ID of the billing profile for which the invoice is generated.

Declaration
public Azure.Core.ResourceIdentifier BillingProfileId { get; }
Property Value
Azure.Core.ResourceIdentifier

CreditAmount

The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Declaration
public Azure.ResourceManager.Billing.Models.BillingAmount CreditAmount { get; }
Property Value
BillingAmount

CreditForDocumentId

The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only.

Declaration
public string CreditForDocumentId { get; }
Property Value
System.String

Documents

List of documents available to download and view such as invoice, credit note, or tax receipt.

Declaration
public System.Collections.Generic.IReadOnlyList<Azure.ResourceManager.Billing.Models.InvoiceDocument> Documents { get; }
Property Value
System.Collections.Generic.IReadOnlyList<InvoiceDocument>

DocumentType

The type of the document.

Declaration
public Nullable<Azure.ResourceManager.Billing.Models.InvoiceDocumentType> DocumentType { get; }
Property Value
System.Nullable<InvoiceDocumentType>

DueOn

The due date for the invoice.

Declaration
public Nullable<DateTimeOffset> DueOn { get; }
Property Value
System.Nullable<System.DateTimeOffset>

FailedPayments

List of failed payments.

Declaration
public System.Collections.Generic.IReadOnlyList<Azure.ResourceManager.Billing.Models.BillingInvoiceFailedPayment> FailedPayments { get; }
Property Value
System.Collections.Generic.IReadOnlyList<BillingInvoiceFailedPayment>

FreeAzureCreditApplied

The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Declaration
public Azure.ResourceManager.Billing.Models.BillingAmount FreeAzureCreditApplied { get; }
Property Value
BillingAmount

InvoiceOn

The date when the invoice was generated.

Declaration
public Nullable<DateTimeOffset> InvoiceOn { get; }
Property Value
System.Nullable<System.DateTimeOffset>

InvoicePeriodEndOn

The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.

Declaration
public Nullable<DateTimeOffset> InvoicePeriodEndOn { get; }
Property Value
System.Nullable<System.DateTimeOffset>

InvoicePeriodStartOn

The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.

Declaration
public Nullable<DateTimeOffset> InvoicePeriodStartOn { get; }
Property Value
System.Nullable<System.DateTimeOffset>

InvoiceType

Invoice type.

Declaration
public Nullable<Azure.ResourceManager.Billing.Models.BillingInvoiceType> InvoiceType { get; }
Property Value
System.Nullable<BillingInvoiceType>

IsMonthlyInvoice

Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Declaration
public Nullable<bool> IsMonthlyInvoice { get; }
Property Value
System.Nullable<System.Boolean>

Payments

List of payments.

Declaration
public System.Collections.Generic.IReadOnlyList<Azure.ResourceManager.Billing.Models.BillingInvoicePayment> Payments { get; }
Property Value
System.Collections.Generic.IReadOnlyList<BillingInvoicePayment>

PurchaseOrderNumber

An optional purchase order number for the invoice.

Declaration
public string PurchaseOrderNumber { get; }
Property Value
System.String

RebillDetails

Rebill details for an invoice.

Declaration
public Azure.ResourceManager.Billing.Models.RebillDetails RebillDetails { get; }
Property Value
RebillDetails

RefundDetails

The details of a refund request.

Declaration
public Azure.ResourceManager.Billing.Models.RefundDetailsSummary RefundDetails { get; set; }
Property Value
RefundDetailsSummary

SpecialTaxationType

Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic.

Declaration
public Nullable<Azure.ResourceManager.Billing.Models.SpecialTaxationType> SpecialTaxationType { get; }
Property Value
System.Nullable<SpecialTaxationType>

Status

The current status of the invoice.

Declaration
public Nullable<Azure.ResourceManager.Billing.Models.BillingInvoiceStatus> Status { get; }
Property Value
System.Nullable<BillingInvoiceStatus>

SubscriptionDisplayName

The name of the billing subscription for which the invoice is generated.

Declaration
public string SubscriptionDisplayName { get; }
Property Value
System.String

SubscriptionId

The ID of the subscription for which the invoice is generated.

Declaration
public string SubscriptionId { get; }
Property Value
System.String

SubTotal

The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Declaration
public Azure.ResourceManager.Billing.Models.BillingAmount SubTotal { get; }
Property Value
BillingAmount

TaxAmount

The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Declaration
public Azure.ResourceManager.Billing.Models.BillingAmount TaxAmount { get; }
Property Value
BillingAmount

TotalAmount

The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Declaration
public Azure.ResourceManager.Billing.Models.BillingAmount TotalAmount { get; }
Property Value
BillingAmount

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration
protected virtual void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The JSON writer.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The client options for reading and writing models.

Explicit Interface Implementations

IJsonModel<BillingInvoiceProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

Declaration
Azure.ResourceManager.Billing.Models.BillingInvoiceProperties IJsonModel<BillingInvoiceProperties>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonReader reader

The System.Text.Json.Utf8JsonReader to read.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
BillingInvoiceProperties

A T representation of the JSON value.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<BillingInvoiceProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration
void IJsonModel<BillingInvoiceProperties>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The System.Text.Json.Utf8JsonWriter to write into.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<BillingInvoiceProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration
Azure.ResourceManager.Billing.Models.BillingInvoiceProperties IPersistableModel<BillingInvoiceProperties>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.BinaryData data

The System.BinaryData to parse.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
BillingInvoiceProperties

A T representation of the data.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<BillingInvoiceProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration
string IPersistableModel<BillingInvoiceProperties>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.
Returns
System.String

The format that the model uses when communicating with the serivce.

IPersistableModel<BillingInvoiceProperties>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<BillingInvoiceProperties>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
System.BinaryData

A binary representation of the written model.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.