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