InvoiceProperties interface

Package:
@azure/arm-billing

An invoice.

Properties

amountDue

The amount due as of now.
azurePrepaymentApplied

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

The total charges for the invoice billing period.
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.
billingProfileDisplayName

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

The ID of the billing profile for which the invoice is generated.
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.
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.
documents

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

The type of the document.
dueDate

The due date for the invoice.
failedPayments

List of failed payments.
freeAzureCreditApplied

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

The date when the invoice was generated.
invoicePeriodEndDate

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

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

Invoice type.
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.
payments

List of payments.
purchaseOrderNumber

An optional purchase order number for the invoice.
rebillDetails

Rebill details for an invoice.
refundDetails

The details of a refund request.
specialTaxationType

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

The current status of the invoice.
subscriptionDisplayName

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

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

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

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

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

Property Details

amountDue

The amount due as of now.

amountDue?: InvoicePropertiesAmountDue

Property Value

InvoicePropertiesAmountDue

azurePrepaymentApplied

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

azurePrepaymentApplied?: InvoicePropertiesAzurePrepaymentApplied

Property Value

InvoicePropertiesAzurePrepaymentApplied

billedAmount

The total charges for the invoice billing period.

billedAmount?: InvoicePropertiesBilledAmount

Property Value

InvoicePropertiesBilledAmount

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.

billedDocumentId?: string

Property Value

string

billingProfileDisplayName

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

billingProfileDisplayName?: string

Property Value

string

billingProfileId

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

billingProfileId?: string

Property Value

string

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.

creditAmount?: InvoicePropertiesCreditAmount

Property Value

InvoicePropertiesCreditAmount

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.

creditForDocumentId?: string

Property Value

string

documents

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

documents?: InvoiceDocument[]

Property Value

InvoiceDocument[]

documentType

The type of the document.

documentType?: string

Property Value

string

dueDate

The due date for the invoice.

dueDate?: Date

Property Value

Date

failedPayments

List of failed payments.

failedPayments?: FailedPayment[]

Property Value

FailedPayment[]

freeAzureCreditApplied

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

freeAzureCreditApplied?: InvoicePropertiesFreeAzureCreditApplied

Property Value

InvoicePropertiesFreeAzureCreditApplied

invoiceDate

The date when the invoice was generated.

invoiceDate?: Date

Property Value

Date

invoicePeriodEndDate

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

invoicePeriodEndDate?: Date

Property Value

Date

invoicePeriodStartDate

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

invoicePeriodStartDate?: Date

Property Value

Date

invoiceType

Invoice type.

invoiceType?: string

Property Value

string

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.

isMonthlyInvoice?: boolean

Property Value

boolean

payments

List of payments.

payments?: Payment[]

Property Value

Payment[]

purchaseOrderNumber

An optional purchase order number for the invoice.

purchaseOrderNumber?: string

Property Value

string

rebillDetails

Rebill details for an invoice.

rebillDetails?: InvoicePropertiesRebillDetails

Property Value

InvoicePropertiesRebillDetails

refundDetails

The details of a refund request.

refundDetails?: InvoicePropertiesRefundDetails

Property Value

InvoicePropertiesRefundDetails

specialTaxationType

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

specialTaxationType?: string

Property Value

string

status

The current status of the invoice.

status?: string

Property Value

string

subscriptionDisplayName

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

subscriptionDisplayName?: string

Property Value

string

subscriptionId

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

subscriptionId?: string

Property Value

string

subTotal

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

subTotal?: InvoicePropertiesSubTotal

Property Value

InvoicePropertiesSubTotal

taxAmount

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

taxAmount?: InvoicePropertiesTaxAmount

Property Value

InvoicePropertiesTaxAmount

totalAmount

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

totalAmount?: InvoicePropertiesTotalAmount

Property Value

InvoicePropertiesTotalAmount