TransactionsClient Interface

Package:

com.azure.resourcemanager.billing.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-billing:1.0.0

public interface TransactionsClient

An instance of this class provides access to all the operations defined in TransactionsClient.

Method Summary

Modifier and Type	Method and Description
abstract SyncPoller<PollResult<DocumentDownloadResultInner>,DocumentDownloadResultInner>	beginTransactionsDownloadByInvoice(String billingAccountName, String invoiceName) Gets a URL to download the transactions document for an invoice.
abstract SyncPoller<PollResult<DocumentDownloadResultInner>,DocumentDownloadResultInner>	beginTransactionsDownloadByInvoice(String billingAccountName, String invoiceName, Context context) Gets a URL to download the transactions document for an invoice.
abstract TransactionSummaryInner	getTransactionSummaryByInvoice(String billingAccountName, String invoiceName) Gets the transaction summary for an invoice.
abstract Response<TransactionSummaryInner>	getTransactionSummaryByInvoiceWithResponse(String billingAccountName, String invoiceName, String filter, String search, Context context) Gets the transaction summary for an invoice.
abstract PagedIterable<TransactionInner>	listByBillingProfile(String billingAccountName, String billingProfileName, LocalDate periodStartDate, LocalDate periodEndDate, TransactionType type) Lists the billed or unbilled transactions by billing profile name for given start and end date.
abstract PagedIterable<TransactionInner>	listByBillingProfile(String billingAccountName, String billingProfileName, LocalDate periodStartDate, LocalDate periodEndDate, TransactionType type, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context) Lists the billed or unbilled transactions by billing profile name for given start and end date.
abstract PagedIterable<TransactionInner>	listByCustomer(String billingAccountName, String billingProfileName, String customerName, LocalDate periodStartDate, LocalDate periodEndDate, TransactionType type) Lists the billed or unbilled transactions by customer id for given start date and end date.
abstract PagedIterable<TransactionInner>	listByCustomer(String billingAccountName, String billingProfileName, String customerName, LocalDate periodStartDate, LocalDate periodEndDate, TransactionType type, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context) Lists the billed or unbilled transactions by customer id for given start date and end date.
abstract PagedIterable<TransactionInner>	listByInvoice(String billingAccountName, String invoiceName) Lists the transactions for an invoice.
abstract PagedIterable<TransactionInner>	listByInvoice(String billingAccountName, String invoiceName, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context) Lists the transactions for an invoice.
abstract PagedIterable<TransactionInner>	listByInvoiceSection(String billingAccountName, String billingProfileName, String invoiceSectionName, LocalDate periodStartDate, LocalDate periodEndDate, TransactionType type) Lists the billed or unbilled transactions by invoice section name for given start date and end date.
abstract PagedIterable<TransactionInner>	listByInvoiceSection(String billingAccountName, String billingProfileName, String invoiceSectionName, LocalDate periodStartDate, LocalDate periodEndDate, TransactionType type, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context) Lists the billed or unbilled transactions by invoice section name for given start date and end date.
abstract DocumentDownloadResultInner	transactionsDownloadByInvoice(String billingAccountName, String invoiceName) Gets a URL to download the transactions document for an invoice.
abstract DocumentDownloadResultInner	transactionsDownloadByInvoice(String billingAccountName, String invoiceName, Context context) Gets a URL to download the transactions document for an invoice.

Method Details

beginTransactionsDownloadByInvoice

public abstract SyncPoller<PollResult<DocumentDownloadResultInner>,DocumentDownloadResultInner> beginTransactionsDownloadByInvoice(String billingAccountName, String invoiceName)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

invoiceName - The ID that uniquely identifies an invoice.

Returns:

the SyncPoller<T,U> for polling of a URL to download the transactions document for an invoice.

beginTransactionsDownloadByInvoice

public abstract SyncPoller<PollResult<DocumentDownloadResultInner>,DocumentDownloadResultInner> beginTransactionsDownloadByInvoice(String billingAccountName, String invoiceName, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

invoiceName - The ID that uniquely identifies an invoice.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of a URL to download the transactions document for an invoice.

getTransactionSummaryByInvoice

public abstract TransactionSummaryInner getTransactionSummaryByInvoice(String billingAccountName, String invoiceName)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

invoiceName - The ID that uniquely identifies an invoice.

Returns:

the transaction summary for an invoice.

getTransactionSummaryByInvoiceWithResponse

public abstract Response<TransactionSummaryInner> getTransactionSummaryByInvoiceWithResponse(String billingAccountName, String invoiceName, String filter, String search, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

invoiceName - The ID that uniquely identifies an invoice.

filter - The filter query option allows clients to filter the line items that are aggregated to create the line item summary.

search - The search query option allows clients to filter the line items that are aggregated to create the line item summary.

context - The context to associate with this operation.

Returns:

the transaction summary for an invoice along with Response<T>.

listByBillingProfile

public abstract PagedIterable<TransactionInner> listByBillingProfile(String billingAccountName, String billingProfileName, LocalDate periodStartDate, LocalDate periodEndDate, TransactionType type)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingProfileName - The ID that uniquely identifies a billing profile.

periodStartDate - The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.

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

type - The type of transaction.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByBillingProfile

public abstract PagedIterable<TransactionInner> listByBillingProfile(String billingAccountName, String billingProfileName, LocalDate periodStartDate, LocalDate periodEndDate, TransactionType type, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingProfileName - The ID that uniquely identifies a billing profile.

periodStartDate - The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.

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

type - The type of transaction.

filter - The filter query option allows clients to filter a collection of resources that are addressed by a request URL.

orderBy - The orderby query option allows clients to request resources in a particular order.

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

skip - The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

count - The count query option allows clients to request a count of the matching resources included with the resources in the response.

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

context - The context to associate with this operation.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByCustomer

public abstract PagedIterable<TransactionInner> listByCustomer(String billingAccountName, String billingProfileName, String customerName, LocalDate periodStartDate, LocalDate periodEndDate, TransactionType type)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingProfileName - The ID that uniquely identifies a billing profile.

customerName - The ID that uniquely identifies a customer.

periodStartDate - The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.

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

type - The type of transaction.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByCustomer

public abstract PagedIterable<TransactionInner> listByCustomer(String billingAccountName, String billingProfileName, String customerName, LocalDate periodStartDate, LocalDate periodEndDate, TransactionType type, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingProfileName - The ID that uniquely identifies a billing profile.

customerName - The ID that uniquely identifies a customer.

periodStartDate - The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.

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

type - The type of transaction.

filter - The filter query option allows clients to filter a collection of resources that are addressed by a request URL.

orderBy - The orderby query option allows clients to request resources in a particular order.

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

skip - The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

count - The count query option allows clients to request a count of the matching resources included with the resources in the response.

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

context - The context to associate with this operation.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByInvoice

public abstract PagedIterable<TransactionInner> listByInvoice(String billingAccountName, String invoiceName)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

invoiceName - The ID that uniquely identifies an invoice.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByInvoice

public abstract PagedIterable<TransactionInner> listByInvoice(String billingAccountName, String invoiceName, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

invoiceName - The ID that uniquely identifies an invoice.

filter - The filter query option allows clients to filter a collection of resources that are addressed by a request URL.

orderBy - The orderby query option allows clients to request resources in a particular order.

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

skip - The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

count - The count query option allows clients to request a count of the matching resources included with the resources in the response.

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

context - The context to associate with this operation.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByInvoiceSection

public abstract PagedIterable<TransactionInner> listByInvoiceSection(String billingAccountName, String billingProfileName, String invoiceSectionName, LocalDate periodStartDate, LocalDate periodEndDate, TransactionType type)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingProfileName - The ID that uniquely identifies a billing profile.

invoiceSectionName - The ID that uniquely identifies an invoice section.

periodStartDate - The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.

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

type - The type of transaction.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

listByInvoiceSection

public abstract PagedIterable<TransactionInner> listByInvoiceSection(String billingAccountName, String billingProfileName, String invoiceSectionName, LocalDate periodStartDate, LocalDate periodEndDate, TransactionType type, String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

billingProfileName - The ID that uniquely identifies a billing profile.

invoiceSectionName - The ID that uniquely identifies an invoice section.

periodStartDate - The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.

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

type - The type of transaction.

filter - The filter query option allows clients to filter a collection of resources that are addressed by a request URL.

orderBy - The orderby query option allows clients to request resources in a particular order.

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

skip - The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

count - The count query option allows clients to request a count of the matching resources included with the resources in the response.

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

context - The context to associate with this operation.

Returns:

a container for a list of resources as paginated response with PagedIterable<T>.

transactionsDownloadByInvoice

public abstract DocumentDownloadResultInner transactionsDownloadByInvoice(String billingAccountName, String invoiceName)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

invoiceName - The ID that uniquely identifies an invoice.

Returns:

a URL to download the transactions document for an invoice.

transactionsDownloadByInvoice

public abstract DocumentDownloadResultInner transactionsDownloadByInvoice(String billingAccountName, String invoiceName, Context context)

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

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

invoiceName - The ID that uniquely identifies an invoice.

context - The context to associate with this operation.

Returns:

a URL to download the transactions document for an invoice.