Invoices interface
Interface representing a Invoices.
Methods
| begin |
Regenerate an invoice by billing account name and invoice name. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement. |
| begin |
Regenerate an invoice by billing account name and invoice name. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement. |
| begin |
Gets a URL to download an invoice document. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement. |
| begin |
Gets a URL to download an invoice document. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement. |
| begin |
Gets a URL to download an invoice by billing subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement. |
| begin |
Gets a URL to download an invoice by billing subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement. |
| begin |
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 |
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 |
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 |
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 |
Gets a URL to download the summary document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement. |
| begin |
Gets a URL to download the summary document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement. |
| get(string, Invoices |
Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement. |
| get |
Gets an invoice by billing account name and ID. The operation is supported for all billing account types. |
| get |
Gets an invoice by subscription ID and invoice ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement. |
| list |
Lists the invoices for a billing account for a given start date and end date. The operation is supported for all billing account types. |
| list |
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 |
Lists the invoices for a subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement. |
Method Details
beginAmend(string, string, InvoicesAmendOptionalParams)
Regenerate an invoice by billing account name and invoice name. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
function beginAmend(billingAccountName: string, invoiceName: string, options?: InvoicesAmendOptionalParams): Promise<SimplePollerLike<OperationState<InvoicesAmendHeaders>, InvoicesAmendHeaders>>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- invoiceName
-
string
The ID that uniquely identifies an invoice.
- options
- InvoicesAmendOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<InvoicesAmendHeaders>, InvoicesAmendHeaders>>
beginAmendAndWait(string, string, InvoicesAmendOptionalParams)
Regenerate an invoice by billing account name and invoice name. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
function beginAmendAndWait(billingAccountName: string, invoiceName: string, options?: InvoicesAmendOptionalParams): Promise<InvoicesAmendHeaders>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- invoiceName
-
string
The ID that uniquely identifies an invoice.
- options
- InvoicesAmendOptionalParams
The options parameters.
Returns
Promise<InvoicesAmendHeaders>
beginDownloadByBillingAccount(string, string, InvoicesDownloadByBillingAccountOptionalParams)
Gets a URL to download an invoice document. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
function beginDownloadByBillingAccount(billingAccountName: string, invoiceName: string, options?: InvoicesDownloadByBillingAccountOptionalParams): 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>>
beginDownloadByBillingAccountAndWait(string, string, InvoicesDownloadByBillingAccountOptionalParams)
Gets a URL to download an invoice document. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
function beginDownloadByBillingAccountAndWait(billingAccountName: string, invoiceName: string, options?: InvoicesDownloadByBillingAccountOptionalParams): 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>
beginDownloadByBillingSubscription(string, InvoicesDownloadByBillingSubscriptionOptionalParams)
Gets a URL to download an invoice by billing subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
function beginDownloadByBillingSubscription(invoiceName: string, options?: InvoicesDownloadByBillingSubscriptionOptionalParams): Promise<SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>Parameters
- invoiceName
-
string
The ID that uniquely identifies an invoice.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>
beginDownloadByBillingSubscriptionAndWait(string, InvoicesDownloadByBillingSubscriptionOptionalParams)
Gets a URL to download an invoice by billing subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
function beginDownloadByBillingSubscriptionAndWait(invoiceName: string, options?: InvoicesDownloadByBillingSubscriptionOptionalParams): Promise<DocumentDownloadResult>Parameters
- invoiceName
-
string
The ID that uniquely identifies an invoice.
The options parameters.
Returns
Promise<DocumentDownloadResult>
beginDownloadDocumentsByBillingAccount(string, DocumentDownloadRequest[], InvoicesDownloadDocumentsByBillingAccountOptionalParams)
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.
function beginDownloadDocumentsByBillingAccount(billingAccountName: string, parameters: DocumentDownloadRequest[], options?: InvoicesDownloadDocumentsByBillingAccountOptionalParams): Promise<SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- parameters
A list of download details for individual documents.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>
beginDownloadDocumentsByBillingAccountAndWait(string, DocumentDownloadRequest[], InvoicesDownloadDocumentsByBillingAccountOptionalParams)
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.
function beginDownloadDocumentsByBillingAccountAndWait(billingAccountName: string, parameters: DocumentDownloadRequest[], options?: InvoicesDownloadDocumentsByBillingAccountOptionalParams): Promise<DocumentDownloadResult>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- parameters
A list of download details for individual documents.
The options parameters.
Returns
Promise<DocumentDownloadResult>
beginDownloadDocumentsByBillingSubscription(DocumentDownloadRequest[], InvoicesDownloadDocumentsByBillingSubscriptionOptionalParams)
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.
function beginDownloadDocumentsByBillingSubscription(parameters: DocumentDownloadRequest[], options?: InvoicesDownloadDocumentsByBillingSubscriptionOptionalParams): Promise<SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>Parameters
- parameters
A list of download details for individual documents.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>
beginDownloadDocumentsByBillingSubscriptionAndWait(DocumentDownloadRequest[], InvoicesDownloadDocumentsByBillingSubscriptionOptionalParams)
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.
function beginDownloadDocumentsByBillingSubscriptionAndWait(parameters: DocumentDownloadRequest[], options?: InvoicesDownloadDocumentsByBillingSubscriptionOptionalParams): Promise<DocumentDownloadResult>Parameters
- parameters
A list of download details for individual documents.
The options parameters.
Returns
Promise<DocumentDownloadResult>
beginDownloadSummaryByBillingAccount(string, string, InvoicesDownloadSummaryByBillingAccountOptionalParams)
Gets a URL to download the summary document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement.
function beginDownloadSummaryByBillingAccount(billingAccountName: string, invoiceName: string, options?: InvoicesDownloadSummaryByBillingAccountOptionalParams): 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>>
beginDownloadSummaryByBillingAccountAndWait(string, string, InvoicesDownloadSummaryByBillingAccountOptionalParams)
Gets a URL to download the summary document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement.
function beginDownloadSummaryByBillingAccountAndWait(billingAccountName: string, invoiceName: string, options?: InvoicesDownloadSummaryByBillingAccountOptionalParams): 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>
get(string, InvoicesGetOptionalParams)
Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
function get(invoiceName: string, options?: InvoicesGetOptionalParams): Promise<Invoice>Parameters
- invoiceName
-
string
The ID that uniquely identifies an invoice.
- options
- InvoicesGetOptionalParams
The options parameters.
Returns
Promise<Invoice>
getByBillingAccount(string, string, InvoicesGetByBillingAccountOptionalParams)
Gets an invoice by billing account name and ID. The operation is supported for all billing account types.
function getByBillingAccount(billingAccountName: string, invoiceName: string, options?: InvoicesGetByBillingAccountOptionalParams): Promise<Invoice>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<Invoice>
getByBillingSubscription(string, InvoicesGetByBillingSubscriptionOptionalParams)
Gets an invoice by subscription ID and invoice ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
function getByBillingSubscription(invoiceName: string, options?: InvoicesGetByBillingSubscriptionOptionalParams): Promise<Invoice>Parameters
- invoiceName
-
string
The ID that uniquely identifies an invoice.
The options parameters.
Returns
Promise<Invoice>
listByBillingAccount(string, InvoicesListByBillingAccountOptionalParams)
Lists the invoices for a billing account for a given start date and end date. The operation is supported for all billing account types.
function listByBillingAccount(billingAccountName: string, options?: InvoicesListByBillingAccountOptionalParams): PagedAsyncIterableIterator<Invoice, Invoice[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
The options parameters.
Returns
listByBillingProfile(string, string, InvoicesListByBillingProfileOptionalParams)
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.
function listByBillingProfile(billingAccountName: string, billingProfileName: string, options?: InvoicesListByBillingProfileOptionalParams): PagedAsyncIterableIterator<Invoice, Invoice[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingProfileName
-
string
The ID that uniquely identifies a billing profile.
The options parameters.
Returns
listByBillingSubscription(InvoicesListByBillingSubscriptionOptionalParams)
Lists the invoices for a subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
function listByBillingSubscription(options?: InvoicesListByBillingSubscriptionOptionalParams): PagedAsyncIterableIterator<Invoice, Invoice[], PageSettings>Parameters
The options parameters.