InvoicesOperations Class
InvoicesOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectInvoicesOperations
Constructor
InvoicesOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
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[_models.DownloadUrl]Parameters
- 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
Pass in True if you'd like the ARMPolling polling method, False for no polling, or 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
An instance of LROPoller that returns either DownloadUrl or the result of cls(response)
Return type
Exceptions
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[_models.DownloadUrl]Parameters
- 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
Pass in True if you'd like the ARMPolling polling method, False for no polling, or 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
An instance of LROPoller that returns either DownloadUrl or the result of cls(response)
Return type
Exceptions
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], **kwargs: Any) -> LROPoller[_models.DownloadUrl]Parameters
- 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
Pass in True if you'd like the ARMPolling polling method, False for no polling, or 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
An instance of LROPoller that returns either DownloadUrl or the result of cls(response)
Return type
Exceptions
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], **kwargs: Any) -> LROPoller[_models.DownloadUrl]Parameters
- 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
Pass in True if you'd like the ARMPolling polling method, False for no polling, or 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
An instance of LROPoller that returns either DownloadUrl or the result of cls(response)
Return type
Exceptions
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) -> _models.InvoiceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Invoice, or the result of cls(response)
Return type
Exceptions
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) -> _models.InvoiceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Invoice, or the result of cls(response)
Return type
Exceptions
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) -> _models.InvoiceParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Invoice, or the result of cls(response)
Return type
Exceptions
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[_models.InvoiceListResult]Parameters
- period_start_date
- str
The start date to fetch the invoices. The date should be specified in MM-DD-YYYY format.
- period_end_date
- str
The end date to fetch the invoices. The date should be specified in MM-DD-YYYY format.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either InvoiceListResult or the result of cls(response)
Return type
Exceptions
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[_models.InvoiceListResult]Parameters
- period_start_date
- str
The start date to fetch the invoices. The date should be specified in MM-DD-YYYY format.
- period_end_date
- str
The end date to fetch the invoices. The date should be specified in MM-DD-YYYY format.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either InvoiceListResult or the result of cls(response)
Return type
Exceptions
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[_models.InvoiceListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either InvoiceListResult or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.billing.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\billing\\models\\__init__.py'>Feedback
Submit and view feedback for