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

The list of invoices.

Name	Datatype	Description
properties	object	An invoice.
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 < > % & \ ? /

get_by_billing_account

The list of invoices.

Name	Datatype	Description
properties	object	An invoice.
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 < > % & \ ? /

get_by_billing_subscription

An invoice.

Name	Datatype	Description
properties	object	An invoice.
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 < > % & \ ? /

list_by_billing_account

The list of invoices.

Name	Datatype	Description
properties	object	An invoice.
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 < > % & \ ? /

list_by_billing_subscription

The list of invoices.

Name	Datatype	Description
properties	object	An invoice.
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 < > % & \ ? /

get

An invoice.

Name	Datatype	Description
properties	object	An invoice.
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 < > % & \ ? /

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_billing_profile	select	billingAccountName, billingProfileName	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	billingAccountName, invoiceName		Gets an invoice by billing account name and ID. The operation is supported for all billing account types.
get_by_billing_subscription	select	subscriptionId, invoiceName		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.
list_by_billing_account	select	billingAccountName	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	subscriptionId	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.
get	select	invoiceName		Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
download_documents_by_billing_account	exec	billingAccountName		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.
amend	exec	billingAccountName, invoiceName		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	billingAccountName, invoiceName	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	billingAccountName, invoiceName		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_subscription	exec	subscriptionId		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	subscriptionId, invoiceName	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.

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
billingAccountName	string	The ID that uniquely identifies a billing account.
billingProfileName	string	The ID that uniquely identifies a billing profile.
invoiceName	string	The ID that uniquely identifies an invoice.
subscriptionId	string	The ID that uniquely identifies a billing subscription.
count	boolean	The count query option allows clients to request a count of the matching resources included with the resources in the response.
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.
filter	string	The filter query option allows clients to filter a collection of resources that are addressed by a request URL.
orderBy	string	The orderby query option allows clients to request resources in a particular order.
periodEndDate	string (date)	The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.
periodStartDate	string (date)	The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.
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.
skip	integer (int64)	The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.
top	integer (int64)	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.

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
properties,
tags
FROM azure.billing.invoices
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- 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
properties,
tags
FROM azure.billing.invoices
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND invoiceName = '{{ invoiceName }}' -- 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
properties,
tags
FROM azure.billing.invoices
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND invoiceName = '{{ invoiceName }}' -- 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
properties,
tags
FROM azure.billing.invoices
WHERE billingAccountName = '{{ billingAccountName }}' -- 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
properties,
tags
FROM azure.billing.invoices
WHERE subscriptionId = '{{ subscriptionId }}' -- 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

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

SELECT
properties,
tags
FROM azure.billing.invoices
WHERE invoiceName = '{{ invoiceName }}' -- required
;

Lifecycle Methods

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 
@billingAccountName='{{ billingAccountName }}' --required
;

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 
@billingAccountName='{{ billingAccountName }}' --required, 
@invoiceName='{{ invoiceName }}' --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 
@billingAccountName='{{ billingAccountName }}' --required, 
@invoiceName='{{ invoiceName }}' --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 
@billingAccountName='{{ billingAccountName }}' --required, 
@invoiceName='{{ invoiceName }}' --required
;

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 
@subscriptionId='{{ subscriptionId }}' --required
;

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 
@subscriptionId='{{ subscriptionId }}' --required, 
@invoiceName='{{ invoiceName }}' --required, 
@documentName='{{ documentName }}'
;