InvoiceProperties Class

An invoice.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

azure.mgmt.billing._serialization.Model

InvoiceProperties

Constructor

InvoiceProperties(*, amount_due: _models.InvoicePropertiesAmountDue | None = None, azure_prepayment_applied: _models.InvoicePropertiesAzurePrepaymentApplied | None = None, billed_amount: _models.InvoicePropertiesBilledAmount | None = None, credit_amount: _models.InvoicePropertiesCreditAmount | None = None, free_azure_credit_applied: _models.InvoicePropertiesFreeAzureCreditApplied | None = None, rebill_details: _models.InvoicePropertiesRebillDetails | None = None, sub_total: _models.InvoicePropertiesSubTotal | None = None, tax_amount: _models.InvoicePropertiesTaxAmount | None = None, total_amount: _models.InvoicePropertiesTotalAmount | None = None, refund_details: _models.InvoicePropertiesRefundDetails | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
amount_due	InvoicePropertiesAmountDue The amount due as of now.
azure_prepayment_applied	InvoicePropertiesAzurePrepaymentApplied The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
billed_amount	InvoicePropertiesBilledAmount The total charges for the invoice billing period.
credit_amount	InvoicePropertiesCreditAmount 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.
free_azure_credit_applied	InvoicePropertiesFreeAzureCreditApplied The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
rebill_details	InvoicePropertiesRebillDetails Rebill details for an invoice.
sub_total	InvoicePropertiesSubTotal The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
tax_amount	InvoicePropertiesTaxAmount The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
total_amount	InvoicePropertiesTotalAmount The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
refund_details	InvoicePropertiesRefundDetails The details of a refund request.

Variables

Name	Description
amount_due	InvoicePropertiesAmountDue The amount due as of now.
azure_prepayment_applied	InvoicePropertiesAzurePrepaymentApplied The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
billed_amount	InvoicePropertiesBilledAmount The total charges for the invoice billing period.
billed_document_id	str The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only.
billing_profile_display_name	str The name of the billing profile for which the invoice is generated.
billing_profile_id	str The ID of the billing profile for which the invoice is generated.
credit_amount	InvoicePropertiesCreditAmount 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.
credit_for_document_id	str 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.
documents	list[InvoiceDocument] List of documents available to download and view such as invoice, credit note, or tax receipt.
document_type	str or InvoiceDocumentType The type of the document. Known values are: "Other", "Invoice", "VoidNote", "TaxReceipt", "CreditNote", "Summary", and "Transactions".
due_date	datetime The due date for the invoice.
failed_payments	list[FailedPayment] List of failed payments.
free_azure_credit_applied	InvoicePropertiesFreeAzureCreditApplied The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
invoice_date	datetime The date when the invoice was generated.
invoice_period_end_date	datetime The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.
invoice_period_start_date	datetime The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.
invoice_type	str or InvoiceType Invoice type. Known values are: "Other", "AzureServices", "AzureMarketplace", and "AzureSupport".
is_monthly_invoice	bool 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.
payments	list[Payment] List of payments.
purchase_order_number	str An optional purchase order number for the invoice.
rebill_details	InvoicePropertiesRebillDetails Rebill details for an invoice.
status	str or InvoiceStatus The current status of the invoice. Known values are: "Other", "Due", "OverDue", "Paid", "Void", and "Locked".
subscription_display_name	str The name of the billing subscription for which the invoice is generated.
subscription_id	str The ID of the subscription for which the invoice is generated.
special_taxation_type	str or SpecialTaxationType Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. Known values are: "SubtotalLevel" and "InvoiceLevel".
sub_total	InvoicePropertiesSubTotal The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
tax_amount	InvoicePropertiesTaxAmount The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
total_amount	InvoicePropertiesTotalAmount The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
refund_details	InvoicePropertiesRefundDetails The details of a refund request.