TransactionsOperations Class

Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:transactions> attribute.

Inheritance: builtins.object

TransactionsOperations

Constructor

TransactionsOperations(*args, **kwargs)

Methods

begin_transactions_download_by_invoice	Gets a URL to download the transactions document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement.
get_transaction_summary_by_invoice	Gets the transaction summary for an invoice. Transactions include purchases, refunds and Azure usage charges.
list_by_billing_profile	Lists the billed or unbilled transactions by billing profile name for given start and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.
list_by_customer	Lists the billed or unbilled transactions by customer id for given start date and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.
list_by_invoice	Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges.
list_by_invoice_section	Lists the billed or unbilled transactions by invoice section name for given start date and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.

begin_transactions_download_by_invoice

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

begin_transactions_download_by_invoice(billing_account_name: str, invoice_name: str, **kwargs: Any) -> LROPoller[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
LROPoller[DocumentDownloadResult]	An instance of LROPoller 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_transaction_summary_by_invoice

Gets the transaction summary for an invoice. Transactions include purchases, refunds and Azure usage charges.

get_transaction_summary_by_invoice(billing_account_name: str, invoice_name: str, filter: str | None = None, search: str | None = None, **kwargs: Any) -> TransactionSummary

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.
filter Required	str The filter query option allows clients to filter the line items that are aggregated to create the line item summary. Default value is None.
search Required	str The search query option allows clients to filter the line items that are aggregated to create the line item summary. Default value is None.

Returns

Type	Description
TransactionSummary	TransactionSummary 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 billed or unbilled transactions by billing profile name for given start and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.

list_by_billing_profile(billing_account_name: str, billing_profile_name: str, period_start_date: date, period_end_date: date, type: str | TransactionType, 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) -> Iterable[Transaction]

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 to fetch the transactions. The date should be specified in MM-DD-YYYY format. Required.
period_end_date Required	date The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. Required.
type Required	str or TransactionType The type of transaction. Known values are: "Other", "Billed", and "Unbilled". Required.
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
ItemPaged[Transaction]	An iterator like instance of either Transaction or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

list_by_customer

Lists the billed or unbilled transactions by customer id for given start date and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.

list_by_customer(billing_account_name: str, billing_profile_name: str, customer_name: str, period_start_date: date, period_end_date: date, type: str | TransactionType, 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) -> Iterable[Transaction]

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.
customer_name Required	str The ID that uniquely identifies a customer. Required.
period_start_date Required	date The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. Required.
period_end_date Required	date The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. Required.
type Required	str or TransactionType The type of transaction. Known values are: "Other", "Billed", and "Unbilled". Required.
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
ItemPaged[Transaction]	An iterator like instance of either Transaction or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

list_by_invoice

Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges.

list_by_invoice(billing_account_name: str, invoice_name: str, 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) -> Iterable[Transaction]

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.
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
ItemPaged[Transaction]	An iterator like instance of either Transaction or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

list_by_invoice_section

Lists the billed or unbilled transactions by invoice section name for given start date and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.

list_by_invoice_section(billing_account_name: str, billing_profile_name: str, invoice_section_name: str, period_start_date: date, period_end_date: date, type: str | TransactionType, 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) -> Iterable[Transaction]

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.
invoice_section_name Required	str The ID that uniquely identifies an invoice section. Required.
period_start_date Required	date The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. Required.
period_end_date Required	date The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. Required.
type Required	str or TransactionType The type of transaction. Known values are: "Other", "Billed", and "Unbilled". Required.
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
ItemPaged[Transaction]	An iterator like instance of either Transaction 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'>

Share via

TransactionsOperations Class

Constructor

Methods

begin_transactions_download_by_invoice

Parameters

Returns

Exceptions

get_transaction_summary_by_invoice

Parameters

Returns

Exceptions

list_by_billing_profile

Parameters

Returns

Exceptions

list_by_customer

Parameters

Returns

Exceptions

list_by_invoice

Parameters

Returns

Exceptions

list_by_invoice_section

Parameters

Returns

Exceptions

Attributes

models

Additional resources