Transactions interface
Interface representing a Transactions.
Methods
| begin |
Gets a URL to download the transactions document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement. |
| begin |
Gets a URL to download the transactions document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement. |
| get |
Gets the transaction summary for an invoice. Transactions include purchases, refunds and Azure usage charges. |
| list |
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 |
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 |
Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges. |
| list |
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. |
Method Details
beginTransactionsDownloadByInvoice(string, string, TransactionsTransactionsDownloadByInvoiceOptionalParams)
Gets a URL to download the transactions document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement.
function beginTransactionsDownloadByInvoice(billingAccountName: string, invoiceName: string, options?: TransactionsTransactionsDownloadByInvoiceOptionalParams): Promise<SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- invoiceName
-
string
The ID that uniquely identifies an invoice.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>
beginTransactionsDownloadByInvoiceAndWait(string, string, TransactionsTransactionsDownloadByInvoiceOptionalParams)
Gets a URL to download the transactions document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement.
function beginTransactionsDownloadByInvoiceAndWait(billingAccountName: string, invoiceName: string, options?: TransactionsTransactionsDownloadByInvoiceOptionalParams): Promise<DocumentDownloadResult>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- invoiceName
-
string
The ID that uniquely identifies an invoice.
The options parameters.
Returns
Promise<DocumentDownloadResult>
getTransactionSummaryByInvoice(string, string, TransactionsGetTransactionSummaryByInvoiceOptionalParams)
Gets the transaction summary for an invoice. Transactions include purchases, refunds and Azure usage charges.
function getTransactionSummaryByInvoice(billingAccountName: string, invoiceName: string, options?: TransactionsGetTransactionSummaryByInvoiceOptionalParams): Promise<TransactionSummary>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- invoiceName
-
string
The ID that uniquely identifies an invoice.
The options parameters.
Returns
Promise<TransactionSummary>
listByBillingProfile(string, string, Date, Date, string, TransactionsListByBillingProfileOptionalParams)
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.
function listByBillingProfile(billingAccountName: string, billingProfileName: string, periodStartDate: Date, periodEndDate: Date, typeParam: string, options?: TransactionsListByBillingProfileOptionalParams): PagedAsyncIterableIterator<Transaction, Transaction[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingProfileName
-
string
The ID that uniquely identifies a billing profile.
- periodStartDate
-
Date
The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.
- periodEndDate
-
Date
The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format.
- typeParam
-
string
The type of transaction.
The options parameters.
Returns
listByCustomer(string, string, string, Date, Date, string, TransactionsListByCustomerOptionalParams)
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.
function listByCustomer(billingAccountName: string, billingProfileName: string, customerName: string, periodStartDate: Date, periodEndDate: Date, typeParam: string, options?: TransactionsListByCustomerOptionalParams): PagedAsyncIterableIterator<Transaction, Transaction[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingProfileName
-
string
The ID that uniquely identifies a billing profile.
- customerName
-
string
The ID that uniquely identifies a customer.
- periodStartDate
-
Date
The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.
- periodEndDate
-
Date
The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format.
- typeParam
-
string
The type of transaction.
The options parameters.
Returns
listByInvoice(string, string, TransactionsListByInvoiceOptionalParams)
Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges.
function listByInvoice(billingAccountName: string, invoiceName: string, options?: TransactionsListByInvoiceOptionalParams): PagedAsyncIterableIterator<Transaction, Transaction[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- invoiceName
-
string
The ID that uniquely identifies an invoice.
The options parameters.
Returns
listByInvoiceSection(string, string, string, Date, Date, string, TransactionsListByInvoiceSectionOptionalParams)
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.
function listByInvoiceSection(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, periodStartDate: Date, periodEndDate: Date, typeParam: string, options?: TransactionsListByInvoiceSectionOptionalParams): PagedAsyncIterableIterator<Transaction, Transaction[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingProfileName
-
string
The ID that uniquely identifies a billing profile.
- invoiceSectionName
-
string
The ID that uniquely identifies an invoice section.
- periodStartDate
-
Date
The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format.
- periodEndDate
-
Date
The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format.
- typeParam
-
string
The type of transaction.
The options parameters.