InvoicesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BillingManagementClient's

<xref:invoices> attribute.

Inheritance

builtins.object

InvoicesOperations

Constructor

InvoicesOperations(*args, **kwargs)

Methods

begin_amend	Regenerate an invoice by billing account name and invoice name. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
begin_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.
begin_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.
begin_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.
begin_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.
begin_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.
get	Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
get_by_billing_account	Gets an invoice by billing account name and ID. The operation is supported for all billing account types.
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.
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.
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.
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.

begin_amend

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

async begin_amend(billing_account_name: str, invoice_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
invoice_name Required	str The ID that uniquely identifies an invoice. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

begin_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.

async begin_download_by_billing_account(billing_account_name: str, invoice_name: str, document_name: str | None = None, **kwargs: Any) -> AsyncLROPoller[DocumentDownloadResult]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
invoice_name Required	str The ID that uniquely identifies an invoice. Required.
document_name Required	str 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.

Returns

Type	Description
AsyncLROPoller[DocumentDownloadResult]	An instance of AsyncLROPoller that returns either DocumentDownloadResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

begin_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.

async begin_download_by_billing_subscription(invoice_name: str, document_name: str | None = None, **kwargs: Any) -> AsyncLROPoller[DocumentDownloadResult]

Parameters

Name	Description
invoice_name Required	str The ID that uniquely identifies an invoice. Required.
document_name Required	str 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.

Returns

Type	Description
AsyncLROPoller[DocumentDownloadResult]	An instance of AsyncLROPoller that returns either DocumentDownloadResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

begin_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.

async begin_download_documents_by_billing_account(billing_account_name: str, parameters: List[_models.DocumentDownloadRequest], *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.DocumentDownloadResult]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
parameters Required	list[DocumentDownloadRequest] or IO[bytes] A list of download details for individual documents. Is either a [DocumentDownloadRequest] type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[DocumentDownloadResult]	An instance of AsyncLROPoller that returns either DocumentDownloadResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

begin_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.

async begin_download_documents_by_billing_subscription(parameters: List[_models.DocumentDownloadRequest], *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.DocumentDownloadResult]

Parameters

Name	Description
parameters Required	list[DocumentDownloadRequest] or IO[bytes] A list of download details for individual documents. Is either a [DocumentDownloadRequest] type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[DocumentDownloadResult]	An instance of AsyncLROPoller that returns either DocumentDownloadResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

begin_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.

async begin_download_summary_by_billing_account(billing_account_name: str, invoice_name: str, **kwargs: Any) -> AsyncLROPoller[DocumentDownloadResult]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
invoice_name Required	str The ID that uniquely identifies an invoice. Required.

Returns

Type	Description
AsyncLROPoller[DocumentDownloadResult]	An instance of AsyncLROPoller that returns either DocumentDownloadResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

get

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

async get(invoice_name: str, **kwargs: Any) -> Invoice

Parameters

Name	Description
invoice_name Required	str The ID that uniquely identifies an invoice. Required.

Returns

Type	Description
Invoice	Invoice or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

get_by_billing_account

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

async get_by_billing_account(billing_account_name: str, invoice_name: str, **kwargs: Any) -> Invoice

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
invoice_name Required	str The ID that uniquely identifies an invoice. Required.

Returns

Type	Description
Invoice	Invoice or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

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.

async get_by_billing_subscription(invoice_name: str, **kwargs: Any) -> Invoice

Parameters

Name	Description
invoice_name Required	str The ID that uniquely identifies an invoice. Required.

Returns

Type	Description
Invoice	Invoice or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

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.

list_by_billing_account(billing_account_name: str, period_start_date: date | None = None, period_end_date: date | None = None, filter: str | None = None, order_by: str | None = None, top: int | None = None, skip: int | None = None, count: bool | None = None, search: str | None = None, **kwargs: Any) -> AsyncIterable[Invoice]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
period_start_date Required	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.
period_end_date Required	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.
filter Required	str The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None.
order_by Required	str The orderby query option allows clients to request resources in a particular order. Default value is None.
top Required	int 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.
skip Required	int 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.
count Required	bool 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.
search Required	str 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.

Returns

Type	Description
AsyncItemPaged[Invoice]	An iterator like instance of either Invoice or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

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.

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, period_start_date: date | None = None, period_end_date: date | None = None, filter: str | None = None, order_by: str | None = None, top: int | None = None, skip: int | None = None, count: bool | None = None, search: str | None = None, **kwargs: Any) -> AsyncIterable[Invoice]

Parameters

Name	Description
billing_account_name Required	str The ID that uniquely identifies a billing account. Required.
billing_profile_name Required	str The ID that uniquely identifies a billing profile. Required.
period_start_date Required	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.
period_end_date Required	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.
filter Required	str The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None.
order_by Required	str The orderby query option allows clients to request resources in a particular order. Default value is None.
top Required	int 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.
skip Required	int 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.
count Required	bool 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.
search Required	str 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.

Returns

Type	Description
AsyncItemPaged[Invoice]	An iterator like instance of either Invoice or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

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.

list_by_billing_subscription(period_start_date: date | None = None, period_end_date: date | None = None, filter: str | None = None, order_by: str | None = None, top: int | None = None, skip: int | None = None, count: bool | None = None, search: str | None = None, **kwargs: Any) -> AsyncIterable[Invoice]

Parameters

Name	Description
period_start_date Required	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.
period_end_date Required	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.
filter Required	str The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None.
order_by Required	str The orderby query option allows clients to request resources in a particular order. Default value is None.
top Required	int 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.
skip Required	int 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.
count Required	bool 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.
search Required	str 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.

Returns

Type	Description
AsyncItemPaged[Invoice]	An iterator like instance of either Invoice or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://docs.microsoft.com/en-us/rest/api/billing/

Attributes

models

models = <module 'azure.mgmt.billing.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\billing\\models\\__init__.py'>