Sdílet prostřednictvím

InvoicesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BillingManagementClient's

<xref:invoices> attribute.

Constructor

InvoicesOperations(*args, **kwargs)

Methods

begin_download_billing_subscription_invoice

Gets a URL to download an invoice.
begin_download_invoice

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

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_multiple_billing_subscription_invoices

Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file.
get

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

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

Gets an invoice by subscription ID and invoice ID.
list_by_billing_account

Lists the invoices for a billing account 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

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.

begin_download_billing_subscription_invoice

Gets a URL to download an invoice.

begin_download_billing_subscription_invoice(invoice_name: str, download_token: str, **kwargs: Any) -> LROPoller[DownloadUrl]

Parameters

Name Description
invoice_name
Required
str

The ID that uniquely identifies an invoice. Required.
download_token
Required
str

Download token with document source and document ID. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[DownloadUrl]

An instance of LROPoller that returns either DownloadUrl or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_download_invoice

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

begin_download_invoice(billing_account_name: str, invoice_name: str, download_token: str, **kwargs: Any) -> LROPoller[DownloadUrl]

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.
download_token
Required
str

Download token with document source and document ID. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[DownloadUrl]

An instance of LROPoller that returns either DownloadUrl or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_download_multiple_billing_profile_invoices

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_multiple_billing_profile_invoices(billing_account_name: str, download_urls: List[str], *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DownloadUrl]

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.
download_urls
Required
list[str] or IO

An array of download urls for individual documents. Is either a list type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[DownloadUrl]

An instance of LROPoller that returns either DownloadUrl or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_download_multiple_billing_subscription_invoices

Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file.

begin_download_multiple_billing_subscription_invoices(download_urls: List[str], *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DownloadUrl]

Parameters

Name Description
download_urls
Required
list[str] or IO

An array of download urls for individual documents. Is either a list type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[DownloadUrl]

An instance of LROPoller that returns either DownloadUrl or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

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

get(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.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
Invoice

Invoice or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_by_id

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

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

Parameters

Name Description
invoice_name
Required
str

The ID that uniquely identifies an invoice. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
Invoice

Invoice or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_by_subscription_and_invoice_id

Gets an invoice by subscription ID and invoice ID.

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

Parameters

Name Description
invoice_name
Required
str

The ID that uniquely identifies an invoice. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
Invoice

Invoice or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_billing_account

Lists the invoices for a billing account 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_account(billing_account_name: str, period_start_date: str, period_end_date: str, **kwargs: Any) -> Iterable[Invoice]

Parameters

Name Description
billing_account_name
Required
str

The ID that uniquely identifies a billing account. Required.
period_start_date
Required
str

The start date to fetch the invoices. The date should be specified in MM-DD-YYYY format. Required.
period_end_date
Required
str

The end date to fetch the invoices. The date should be specified in MM-DD-YYYY format. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[Invoice]

An iterator like instance of either Invoice or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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: str, period_end_date: str, **kwargs: Any) -> Iterable[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
str

The start date to fetch the invoices. The date should be specified in MM-DD-YYYY format. Required.
period_end_date
Required
str

The end date to fetch the invoices. The date should be specified in MM-DD-YYYY format. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[Invoice]

An iterator like instance of either Invoice or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_billing_subscription

Lists the invoices for a subscription.

list_by_billing_subscription(period_start_date: str, period_end_date: str, **kwargs: Any) -> Iterable[Invoice]

Parameters

Name Description
period_start_date
Required
str

Invoice period start date. Required.
period_end_date
Required
str

Invoice period end date. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[Invoice]

An iterator like instance of either Invoice or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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