invoices

Creates, updates, deletes, gets or lists an invoices resource.

Overview

Name	invoices
Type	Resource
Id	azure.billing.invoices

Fields

The following fields are returned by SELECT queries:

list_by_billing_profile

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
amountDue	object	The amount due as of now.
azurePrepaymentApplied	object	The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
billedAmount	object	The total charges for the invoice billing period.
billedDocumentId	string	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	string	The name of the billing profile for which the invoice is generated.
billingProfileId	string	The ID of the billing profile for which the invoice is generated.
creditAmount	object	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	string	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.
documentType	string	The type of the document. Known values are: "Other", "Invoice", "VoidNote", "TaxReceipt", "CreditNote", "Summary", and "Transactions". (Other, Invoice, VoidNote, TaxReceipt, CreditNote, Summary, Transactions)
documents	array	List of documents available to download and view such as invoice, credit note, or tax receipt.
dueDate	string (date-time)	The due date for the invoice.
failedPayments	array	List of failed payments.
freeAzureCreditApplied	object	The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
invoiceDate	string (date-time)	The date when the invoice was generated.
invoicePeriodEndDate	string (date-time)	The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.
invoicePeriodStartDate	string (date-time)	The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.
invoiceType	string	Invoice type. Known values are: "Other", "AzureServices", "AzureMarketplace", and "AzureSupport". (Other, AzureServices, AzureMarketplace, AzureSupport)
isMonthlyInvoice	boolean	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	array	List of payments.
purchaseOrderNumber	string	An optional purchase order number for the invoice.
rebillDetails	object	Rebill details for an invoice.
refundDetails	object	The details of a refund request.
specialTaxationType	string	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". (SubtotalLevel, InvoiceLevel)
status	string	The current status of the invoice. Known values are: "Other", "Due", "OverDue", "Paid", "Void", and "Locked". (Other, Due, OverDue, Paid, Void, Locked)
subTotal	object	The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
subscriptionDisplayName	string	The name of the billing subscription for which the invoice is generated.
subscriptionId	string	The ID of the subscription for which the invoice is generated.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
taxAmount	object	The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
totalAmount	object	The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_by_billing_account

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
amountDue	object	The amount due as of now.
azurePrepaymentApplied	object	The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
billedAmount	object	The total charges for the invoice billing period.
billedDocumentId	string	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	string	The name of the billing profile for which the invoice is generated.
billingProfileId	string	The ID of the billing profile for which the invoice is generated.
creditAmount	object	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	string	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.
documentType	string	The type of the document. Known values are: "Other", "Invoice", "VoidNote", "TaxReceipt", "CreditNote", "Summary", and "Transactions". (Other, Invoice, VoidNote, TaxReceipt, CreditNote, Summary, Transactions)
documents	array	List of documents available to download and view such as invoice, credit note, or tax receipt.
dueDate	string (date-time)	The due date for the invoice.
failedPayments	array	List of failed payments.
freeAzureCreditApplied	object	The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
invoiceDate	string (date-time)	The date when the invoice was generated.
invoicePeriodEndDate	string (date-time)	The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.
invoicePeriodStartDate	string (date-time)	The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.
invoiceType	string	Invoice type. Known values are: "Other", "AzureServices", "AzureMarketplace", and "AzureSupport". (Other, AzureServices, AzureMarketplace, AzureSupport)
isMonthlyInvoice	boolean	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	array	List of payments.
purchaseOrderNumber	string	An optional purchase order number for the invoice.
rebillDetails	object	Rebill details for an invoice.
refundDetails	object	The details of a refund request.
specialTaxationType	string	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". (SubtotalLevel, InvoiceLevel)
status	string	The current status of the invoice. Known values are: "Other", "Due", "OverDue", "Paid", "Void", and "Locked". (Other, Due, OverDue, Paid, Void, Locked)
subTotal	object	The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
subscriptionDisplayName	string	The name of the billing subscription for which the invoice is generated.
subscriptionId	string	The ID of the subscription for which the invoice is generated.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
taxAmount	object	The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
totalAmount	object	The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_by_billing_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
amountDue	object	The amount due as of now.
azurePrepaymentApplied	object	The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
billedAmount	object	The total charges for the invoice billing period.
billedDocumentId	string	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	string	The name of the billing profile for which the invoice is generated.
billingProfileId	string	The ID of the billing profile for which the invoice is generated.
creditAmount	object	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	string	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.
documentType	string	The type of the document. Known values are: "Other", "Invoice", "VoidNote", "TaxReceipt", "CreditNote", "Summary", and "Transactions". (Other, Invoice, VoidNote, TaxReceipt, CreditNote, Summary, Transactions)
documents	array	List of documents available to download and view such as invoice, credit note, or tax receipt.
dueDate	string (date-time)	The due date for the invoice.
failedPayments	array	List of failed payments.
freeAzureCreditApplied	object	The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
invoiceDate	string (date-time)	The date when the invoice was generated.
invoicePeriodEndDate	string (date-time)	The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.
invoicePeriodStartDate	string (date-time)	The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.
invoiceType	string	Invoice type. Known values are: "Other", "AzureServices", "AzureMarketplace", and "AzureSupport". (Other, AzureServices, AzureMarketplace, AzureSupport)
isMonthlyInvoice	boolean	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	array	List of payments.
purchaseOrderNumber	string	An optional purchase order number for the invoice.
rebillDetails	object	Rebill details for an invoice.
refundDetails	object	The details of a refund request.
specialTaxationType	string	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". (SubtotalLevel, InvoiceLevel)
status	string	The current status of the invoice. Known values are: "Other", "Due", "OverDue", "Paid", "Void", and "Locked". (Other, Due, OverDue, Paid, Void, Locked)
subTotal	object	The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
subscriptionDisplayName	string	The name of the billing subscription for which the invoice is generated.
subscriptionId	string	The ID of the subscription for which the invoice is generated.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
taxAmount	object	The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
totalAmount	object	The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
amountDue	object	The amount due as of now.
azurePrepaymentApplied	object	The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
billedAmount	object	The total charges for the invoice billing period.
billedDocumentId	string	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	string	The name of the billing profile for which the invoice is generated.
billingProfileId	string	The ID of the billing profile for which the invoice is generated.
creditAmount	object	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	string	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.
documentType	string	The type of the document. Known values are: "Other", "Invoice", "VoidNote", "TaxReceipt", "CreditNote", "Summary", and "Transactions". (Other, Invoice, VoidNote, TaxReceipt, CreditNote, Summary, Transactions)
documents	array	List of documents available to download and view such as invoice, credit note, or tax receipt.
dueDate	string (date-time)	The due date for the invoice.
failedPayments	array	List of failed payments.
freeAzureCreditApplied	object	The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
invoiceDate	string (date-time)	The date when the invoice was generated.
invoicePeriodEndDate	string (date-time)	The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.
invoicePeriodStartDate	string (date-time)	The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.
invoiceType	string	Invoice type. Known values are: "Other", "AzureServices", "AzureMarketplace", and "AzureSupport". (Other, AzureServices, AzureMarketplace, AzureSupport)
isMonthlyInvoice	boolean	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	array	List of payments.
purchaseOrderNumber	string	An optional purchase order number for the invoice.
rebillDetails	object	Rebill details for an invoice.
refundDetails	object	The details of a refund request.
specialTaxationType	string	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". (SubtotalLevel, InvoiceLevel)
status	string	The current status of the invoice. Known values are: "Other", "Due", "OverDue", "Paid", "Void", and "Locked". (Other, Due, OverDue, Paid, Void, Locked)
subTotal	object	The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
subscriptionDisplayName	string	The name of the billing subscription for which the invoice is generated.
subscriptionId	string	The ID of the subscription for which the invoice is generated.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
taxAmount	object	The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
totalAmount	object	The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_billing_account

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
amountDue	object	The amount due as of now.
azurePrepaymentApplied	object	The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
billedAmount	object	The total charges for the invoice billing period.
billedDocumentId	string	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	string	The name of the billing profile for which the invoice is generated.
billingProfileId	string	The ID of the billing profile for which the invoice is generated.
creditAmount	object	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	string	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.
documentType	string	The type of the document. Known values are: "Other", "Invoice", "VoidNote", "TaxReceipt", "CreditNote", "Summary", and "Transactions". (Other, Invoice, VoidNote, TaxReceipt, CreditNote, Summary, Transactions)
documents	array	List of documents available to download and view such as invoice, credit note, or tax receipt.
dueDate	string (date-time)	The due date for the invoice.
failedPayments	array	List of failed payments.
freeAzureCreditApplied	object	The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
invoiceDate	string (date-time)	The date when the invoice was generated.
invoicePeriodEndDate	string (date-time)	The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.
invoicePeriodStartDate	string (date-time)	The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.
invoiceType	string	Invoice type. Known values are: "Other", "AzureServices", "AzureMarketplace", and "AzureSupport". (Other, AzureServices, AzureMarketplace, AzureSupport)
isMonthlyInvoice	boolean	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	array	List of payments.
purchaseOrderNumber	string	An optional purchase order number for the invoice.
rebillDetails	object	Rebill details for an invoice.
refundDetails	object	The details of a refund request.
specialTaxationType	string	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". (SubtotalLevel, InvoiceLevel)
status	string	The current status of the invoice. Known values are: "Other", "Due", "OverDue", "Paid", "Void", and "Locked". (Other, Due, OverDue, Paid, Void, Locked)
subTotal	object	The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
subscriptionDisplayName	string	The name of the billing subscription for which the invoice is generated.
subscriptionId	string	The ID of the subscription for which the invoice is generated.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
taxAmount	object	The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
totalAmount	object	The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_billing_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
amountDue	object	The amount due as of now.
azurePrepaymentApplied	object	The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
billedAmount	object	The total charges for the invoice billing period.
billedDocumentId	string	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	string	The name of the billing profile for which the invoice is generated.
billingProfileId	string	The ID of the billing profile for which the invoice is generated.
creditAmount	object	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	string	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.
documentType	string	The type of the document. Known values are: "Other", "Invoice", "VoidNote", "TaxReceipt", "CreditNote", "Summary", and "Transactions". (Other, Invoice, VoidNote, TaxReceipt, CreditNote, Summary, Transactions)
documents	array	List of documents available to download and view such as invoice, credit note, or tax receipt.
dueDate	string (date-time)	The due date for the invoice.
failedPayments	array	List of failed payments.
freeAzureCreditApplied	object	The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
invoiceDate	string (date-time)	The date when the invoice was generated.
invoicePeriodEndDate	string (date-time)	The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.
invoicePeriodStartDate	string (date-time)	The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.
invoiceType	string	Invoice type. Known values are: "Other", "AzureServices", "AzureMarketplace", and "AzureSupport". (Other, AzureServices, AzureMarketplace, AzureSupport)
isMonthlyInvoice	boolean	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	array	List of payments.
purchaseOrderNumber	string	An optional purchase order number for the invoice.
rebillDetails	object	Rebill details for an invoice.
refundDetails	object	The details of a refund request.
specialTaxationType	string	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". (SubtotalLevel, InvoiceLevel)
status	string	The current status of the invoice. Known values are: "Other", "Due", "OverDue", "Paid", "Void", and "Locked". (Other, Due, OverDue, Paid, Void, Locked)
subTotal	object	The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
subscriptionDisplayName	string	The name of the billing subscription for which the invoice is generated.
subscriptionId	string	The ID of the subscription for which the invoice is generated.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
taxAmount	object	The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
totalAmount	object	The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_billing_profile	select	billing_account_name, billing_profile_name	periodStartDate, periodEndDate, filter, orderBy, top, skip, count, search	Lists the invoices for a billing profile for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
get_by_billing_account	select	billing_account_name, invoice_name		Gets an invoice by billing account name and ID. The operation is supported for all billing account types.
get_by_billing_subscription	select	invoice_name, subscription_id		Gets an invoice by subscription ID and invoice ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
get	select	invoice_name		Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
list_by_billing_account	select	billing_account_name	periodStartDate, periodEndDate, filter, orderBy, top, skip, count, search	Lists the invoices for a billing account for a given start date and end date. The operation is supported for all billing account types.
list_by_billing_subscription	select	subscription_id	periodStartDate, periodEndDate, filter, orderBy, top, skip, count, search	Lists the invoices for a subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
amend	exec	billing_account_name, invoice_name		Regenerate an invoice by billing account name and invoice name. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
download_by_billing_account	exec	billing_account_name, invoice_name	documentName	Gets a URL to download an invoice document. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
download_summary_by_billing_account	exec	billing_account_name, invoice_name		Gets a URL to download the summary document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement.
download_documents_by_billing_account	exec	billing_account_name		Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
download_by_billing_subscription	exec	invoice_name, subscription_id	documentName	Gets a URL to download an invoice by billing subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
download_documents_by_billing_subscription	exec	subscription_id		Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
billing_account_name	string	The ID that uniquely identifies a billing account. Required.
billing_profile_name	string	The ID that uniquely identifies a billing profile. Required.
invoice_name	string	The ID that uniquely identifies an invoice. Required.
subscription_id	string
count	boolean	The count query option allows clients to request a count of the matching resources included with the resources in the response. Default value is None.
documentName	string	The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. Default value is None.
filter	string	The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None.
orderBy	string	The orderby query option allows clients to request resources in a particular order. Default value is None.
periodEndDate	string (date)	The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. Default value is None.
periodStartDate	string (date)	The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. Default value is None.
search	string	The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. Default value is None.
skip	integer	The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. Default value is None.
top	integer	The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. Default value is None.

SELECT examples

list_by_billing_profile

Lists the invoices for a billing profile for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

SELECT
id,
name,
amountDue,
azurePrepaymentApplied,
billedAmount,
billedDocumentId,
billingProfileDisplayName,
billingProfileId,
creditAmount,
creditForDocumentId,
documentType,
documents,
dueDate,
failedPayments,
freeAzureCreditApplied,
invoiceDate,
invoicePeriodEndDate,
invoicePeriodStartDate,
invoiceType,
isMonthlyInvoice,
payments,
purchaseOrderNumber,
rebillDetails,
refundDetails,
specialTaxationType,
status,
subTotal,
subscriptionDisplayName,
subscriptionId,
systemData,
tags,
taxAmount,
totalAmount,
type
FROM azure.billing.invoices
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND periodStartDate = '{{ periodStartDate }}'
AND periodEndDate = '{{ periodEndDate }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

get_by_billing_account

Gets an invoice by billing account name and ID. The operation is supported for all billing account types.

SELECT
id,
name,
amountDue,
azurePrepaymentApplied,
billedAmount,
billedDocumentId,
billingProfileDisplayName,
billingProfileId,
creditAmount,
creditForDocumentId,
documentType,
documents,
dueDate,
failedPayments,
freeAzureCreditApplied,
invoiceDate,
invoicePeriodEndDate,
invoicePeriodStartDate,
invoiceType,
isMonthlyInvoice,
payments,
purchaseOrderNumber,
rebillDetails,
refundDetails,
specialTaxationType,
status,
subTotal,
subscriptionDisplayName,
subscriptionId,
systemData,
tags,
taxAmount,
totalAmount,
type
FROM azure.billing.invoices
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND invoice_name = '{{ invoice_name }}' -- required
;

get_by_billing_subscription

Gets an invoice by subscription ID and invoice ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

SELECT
id,
name,
amountDue,
azurePrepaymentApplied,
billedAmount,
billedDocumentId,
billingProfileDisplayName,
billingProfileId,
creditAmount,
creditForDocumentId,
documentType,
documents,
dueDate,
failedPayments,
freeAzureCreditApplied,
invoiceDate,
invoicePeriodEndDate,
invoicePeriodStartDate,
invoiceType,
isMonthlyInvoice,
payments,
purchaseOrderNumber,
rebillDetails,
refundDetails,
specialTaxationType,
status,
subTotal,
subscriptionDisplayName,
subscriptionId,
systemData,
tags,
taxAmount,
totalAmount,
type
FROM azure.billing.invoices
WHERE invoice_name = '{{ invoice_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

SELECT
id,
name,
amountDue,
azurePrepaymentApplied,
billedAmount,
billedDocumentId,
billingProfileDisplayName,
billingProfileId,
creditAmount,
creditForDocumentId,
documentType,
documents,
dueDate,
failedPayments,
freeAzureCreditApplied,
invoiceDate,
invoicePeriodEndDate,
invoicePeriodStartDate,
invoiceType,
isMonthlyInvoice,
payments,
purchaseOrderNumber,
rebillDetails,
refundDetails,
specialTaxationType,
status,
subTotal,
subscriptionDisplayName,
subscriptionId,
systemData,
tags,
taxAmount,
totalAmount,
type
FROM azure.billing.invoices
WHERE invoice_name = '{{ invoice_name }}' -- required
;

list_by_billing_account

Lists the invoices for a billing account for a given start date and end date. The operation is supported for all billing account types.

SELECT
id,
name,
amountDue,
azurePrepaymentApplied,
billedAmount,
billedDocumentId,
billingProfileDisplayName,
billingProfileId,
creditAmount,
creditForDocumentId,
documentType,
documents,
dueDate,
failedPayments,
freeAzureCreditApplied,
invoiceDate,
invoicePeriodEndDate,
invoicePeriodStartDate,
invoiceType,
isMonthlyInvoice,
payments,
purchaseOrderNumber,
rebillDetails,
refundDetails,
specialTaxationType,
status,
subTotal,
subscriptionDisplayName,
subscriptionId,
systemData,
tags,
taxAmount,
totalAmount,
type
FROM azure.billing.invoices
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND periodStartDate = '{{ periodStartDate }}'
AND periodEndDate = '{{ periodEndDate }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

list_by_billing_subscription

Lists the invoices for a subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

SELECT
id,
name,
amountDue,
azurePrepaymentApplied,
billedAmount,
billedDocumentId,
billingProfileDisplayName,
billingProfileId,
creditAmount,
creditForDocumentId,
documentType,
documents,
dueDate,
failedPayments,
freeAzureCreditApplied,
invoiceDate,
invoicePeriodEndDate,
invoicePeriodStartDate,
invoiceType,
isMonthlyInvoice,
payments,
purchaseOrderNumber,
rebillDetails,
refundDetails,
specialTaxationType,
status,
subTotal,
subscriptionDisplayName,
subscriptionId,
systemData,
tags,
taxAmount,
totalAmount,
type
FROM azure.billing.invoices
WHERE subscription_id = '{{ subscription_id }}' -- required
AND periodStartDate = '{{ periodStartDate }}'
AND periodEndDate = '{{ periodEndDate }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

Lifecycle Methods

amend

Regenerate an invoice by billing account name and invoice name. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

EXEC azure.billing.invoices.amend 
@billing_account_name='{{ billing_account_name }}' --required, 
@invoice_name='{{ invoice_name }}' --required
;

download_by_billing_account

Gets a URL to download an invoice document. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.

EXEC azure.billing.invoices.download_by_billing_account 
@billing_account_name='{{ billing_account_name }}' --required, 
@invoice_name='{{ invoice_name }}' --required, 
@documentName='{{ documentName }}'
;

download_summary_by_billing_account

Gets a URL to download the summary document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement.

EXEC azure.billing.invoices.download_summary_by_billing_account 
@billing_account_name='{{ billing_account_name }}' --required, 
@invoice_name='{{ invoice_name }}' --required
;

download_documents_by_billing_account

Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

EXEC azure.billing.invoices.download_documents_by_billing_account 
@billing_account_name='{{ billing_account_name }}' --required 
@@json=
'{
"documentName": "{{ documentName }}", 
"invoiceName": "{{ invoiceName }}"
}'
;

download_by_billing_subscription

Gets a URL to download an invoice by billing subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

EXEC azure.billing.invoices.download_by_billing_subscription 
@invoice_name='{{ invoice_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@documentName='{{ documentName }}'
;

download_documents_by_billing_subscription

Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

EXEC azure.billing.invoices.download_documents_by_billing_subscription 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"documentName": "{{ documentName }}", 
"invoiceName": "{{ invoiceName }}"
}'
;