InvoicesOperations interface

Package:
@azure/arm-billing

Interface representing a Invoices operations.

Properties

amend

Regenerate an invoice by billing account name and invoice name. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
beginAmend
beginAmendAndWait
beginDownloadByBillingAccount
beginDownloadByBillingAccountAndWait
beginDownloadByBillingSubscription
beginDownloadByBillingSubscriptionAndWait
beginDownloadDocumentsByBillingAccount
beginDownloadDocumentsByBillingAccountAndWait
beginDownloadDocumentsByBillingSubscription
beginDownloadDocumentsByBillingSubscriptionAndWait
beginDownloadSummaryByBillingAccount
beginDownloadSummaryByBillingAccountAndWait
downloadByBillingAccount

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

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

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

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

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

Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
getByBillingAccount

Gets an invoice by billing account name and ID. The operation is supported for all billing account types.
getByBillingSubscription

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

Lists the invoices for a billing account for a given start date and end date. The operation is supported for all billing account types.
listByBillingProfile

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

Lists the invoices for a subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

Property Details

amend

Regenerate an invoice by billing account name and invoice name. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

amend: (billingAccountName: string, invoiceName: string, options?: InvoicesAmendOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(billingAccountName: string, invoiceName: string, options?: InvoicesAmendOptionalParams) => PollerLike<OperationState<void>, void>

beginAmend

Warning

This API is now deprecated.

use amend instead

beginAmend: (billingAccountName: string, invoiceName: string, options?: InvoicesAmendOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(billingAccountName: string, invoiceName: string, options?: InvoicesAmendOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginAmendAndWait

Warning

This API is now deprecated.

use amend instead

beginAmendAndWait: (billingAccountName: string, invoiceName: string, options?: InvoicesAmendOptionalParams) => Promise<void>

Property Value

(billingAccountName: string, invoiceName: string, options?: InvoicesAmendOptionalParams) => Promise<void>

beginDownloadByBillingAccount

Warning

This API is now deprecated.

use downloadByBillingAccount instead

beginDownloadByBillingAccount: (billingAccountName: string, invoiceName: string, options?: InvoicesDownloadByBillingAccountOptionalParams) => Promise<SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>

Property Value

(billingAccountName: string, invoiceName: string, options?: InvoicesDownloadByBillingAccountOptionalParams) => Promise<SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>

beginDownloadByBillingAccountAndWait

Warning

This API is now deprecated.

use downloadByBillingAccount instead

beginDownloadByBillingAccountAndWait: (billingAccountName: string, invoiceName: string, options?: InvoicesDownloadByBillingAccountOptionalParams) => Promise<DocumentDownloadResult>

Property Value

(billingAccountName: string, invoiceName: string, options?: InvoicesDownloadByBillingAccountOptionalParams) => Promise<DocumentDownloadResult>

beginDownloadByBillingSubscription

Warning

This API is now deprecated.

use downloadByBillingSubscription instead

beginDownloadByBillingSubscription: (invoiceName: string, options?: InvoicesDownloadByBillingSubscriptionOptionalParams) => Promise<SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>

Property Value

(invoiceName: string, options?: InvoicesDownloadByBillingSubscriptionOptionalParams) => Promise<SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>

beginDownloadByBillingSubscriptionAndWait

Warning

This API is now deprecated.

use downloadByBillingSubscription instead

beginDownloadByBillingSubscriptionAndWait: (invoiceName: string, options?: InvoicesDownloadByBillingSubscriptionOptionalParams) => Promise<DocumentDownloadResult>

Property Value

(invoiceName: string, options?: InvoicesDownloadByBillingSubscriptionOptionalParams) => Promise<DocumentDownloadResult>

beginDownloadDocumentsByBillingAccount

Warning

This API is now deprecated.

use downloadDocumentsByBillingAccount instead

beginDownloadDocumentsByBillingAccount: (billingAccountName: string, parameters: DocumentDownloadRequest[], options?: InvoicesDownloadDocumentsByBillingAccountOptionalParams) => Promise<SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>

Property Value

(billingAccountName: string, parameters: DocumentDownloadRequest[], options?: InvoicesDownloadDocumentsByBillingAccountOptionalParams) => Promise<SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>

beginDownloadDocumentsByBillingAccountAndWait

Warning

This API is now deprecated.

use downloadDocumentsByBillingAccount instead

beginDownloadDocumentsByBillingAccountAndWait: (billingAccountName: string, parameters: DocumentDownloadRequest[], options?: InvoicesDownloadDocumentsByBillingAccountOptionalParams) => Promise<DocumentDownloadResult>

Property Value

(billingAccountName: string, parameters: DocumentDownloadRequest[], options?: InvoicesDownloadDocumentsByBillingAccountOptionalParams) => Promise<DocumentDownloadResult>

beginDownloadDocumentsByBillingSubscription

Warning

This API is now deprecated.

use downloadDocumentsByBillingSubscription instead

beginDownloadDocumentsByBillingSubscription: (parameters: DocumentDownloadRequest[], options?: InvoicesDownloadDocumentsByBillingSubscriptionOptionalParams) => Promise<SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>

Property Value

(parameters: DocumentDownloadRequest[], options?: InvoicesDownloadDocumentsByBillingSubscriptionOptionalParams) => Promise<SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>

beginDownloadDocumentsByBillingSubscriptionAndWait

Warning

This API is now deprecated.

use downloadDocumentsByBillingSubscription instead

beginDownloadDocumentsByBillingSubscriptionAndWait: (parameters: DocumentDownloadRequest[], options?: InvoicesDownloadDocumentsByBillingSubscriptionOptionalParams) => Promise<DocumentDownloadResult>

Property Value

(parameters: DocumentDownloadRequest[], options?: InvoicesDownloadDocumentsByBillingSubscriptionOptionalParams) => Promise<DocumentDownloadResult>

beginDownloadSummaryByBillingAccount

Warning

This API is now deprecated.

use downloadSummaryByBillingAccount instead

beginDownloadSummaryByBillingAccount: (billingAccountName: string, invoiceName: string, options?: InvoicesDownloadSummaryByBillingAccountOptionalParams) => Promise<SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>

Property Value

(billingAccountName: string, invoiceName: string, options?: InvoicesDownloadSummaryByBillingAccountOptionalParams) => Promise<SimplePollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>>

beginDownloadSummaryByBillingAccountAndWait

Warning

This API is now deprecated.

use downloadSummaryByBillingAccount instead

beginDownloadSummaryByBillingAccountAndWait: (billingAccountName: string, invoiceName: string, options?: InvoicesDownloadSummaryByBillingAccountOptionalParams) => Promise<DocumentDownloadResult>

Property Value

(billingAccountName: string, invoiceName: string, options?: InvoicesDownloadSummaryByBillingAccountOptionalParams) => Promise<DocumentDownloadResult>

downloadByBillingAccount

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.

downloadByBillingAccount: (billingAccountName: string, invoiceName: string, options?: InvoicesDownloadByBillingAccountOptionalParams) => PollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>

Property Value

(billingAccountName: string, invoiceName: string, options?: InvoicesDownloadByBillingAccountOptionalParams) => PollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>

downloadByBillingSubscription

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.

downloadByBillingSubscription: (invoiceName: string, options?: InvoicesDownloadByBillingSubscriptionOptionalParams) => PollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>

Property Value

(invoiceName: string, options?: InvoicesDownloadByBillingSubscriptionOptionalParams) => PollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>

downloadDocumentsByBillingAccount

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.

downloadDocumentsByBillingAccount: (billingAccountName: string, parameters: DocumentDownloadRequest[], options?: InvoicesDownloadDocumentsByBillingAccountOptionalParams) => PollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>

Property Value

(billingAccountName: string, parameters: DocumentDownloadRequest[], options?: InvoicesDownloadDocumentsByBillingAccountOptionalParams) => PollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>

downloadDocumentsByBillingSubscription

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.

downloadDocumentsByBillingSubscription: (parameters: DocumentDownloadRequest[], options?: InvoicesDownloadDocumentsByBillingSubscriptionOptionalParams) => PollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>

Property Value

(parameters: DocumentDownloadRequest[], options?: InvoicesDownloadDocumentsByBillingSubscriptionOptionalParams) => PollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>

downloadSummaryByBillingAccount

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

downloadSummaryByBillingAccount: (billingAccountName: string, invoiceName: string, options?: InvoicesDownloadSummaryByBillingAccountOptionalParams) => PollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>

Property Value

(billingAccountName: string, invoiceName: string, options?: InvoicesDownloadSummaryByBillingAccountOptionalParams) => PollerLike<OperationState<DocumentDownloadResult>, DocumentDownloadResult>

get

Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

get: (invoiceName: string, options?: InvoicesGetOptionalParams) => Promise<Invoice>

Property Value

(invoiceName: string, options?: InvoicesGetOptionalParams) => Promise<Invoice>

getByBillingAccount

Gets an invoice by billing account name and ID. The operation is supported for all billing account types.

getByBillingAccount: (billingAccountName: string, invoiceName: string, options?: InvoicesGetByBillingAccountOptionalParams) => Promise<Invoice>

Property Value

(billingAccountName: string, invoiceName: string, options?: InvoicesGetByBillingAccountOptionalParams) => Promise<Invoice>

getByBillingSubscription

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.

getByBillingSubscription: (invoiceName: string, options?: InvoicesGetByBillingSubscriptionOptionalParams) => Promise<Invoice>

Property Value

(invoiceName: string, options?: InvoicesGetByBillingSubscriptionOptionalParams) => Promise<Invoice>

listByBillingAccount

Lists the invoices for a billing account for a given start date and end date. The operation is supported for all billing account types.

listByBillingAccount: (billingAccountName: string, options?: InvoicesListByBillingAccountOptionalParams) => PagedAsyncIterableIterator<Invoice, Invoice[], PageSettings>

Property Value

(billingAccountName: string, options?: InvoicesListByBillingAccountOptionalParams) => PagedAsyncIterableIterator<Invoice, Invoice[], PageSettings>

listByBillingProfile

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.

listByBillingProfile: (billingAccountName: string, billingProfileName: string, options?: InvoicesListByBillingProfileOptionalParams) => PagedAsyncIterableIterator<Invoice, Invoice[], PageSettings>

Property Value

(billingAccountName: string, billingProfileName: string, options?: InvoicesListByBillingProfileOptionalParams) => PagedAsyncIterableIterator<Invoice, Invoice[], PageSettings>

listByBillingSubscription

Lists the invoices for a subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

listByBillingSubscription: (options?: InvoicesListByBillingSubscriptionOptionalParams) => PagedAsyncIterableIterator<Invoice, Invoice[], PageSettings>

Property Value

(options?: InvoicesListByBillingSubscriptionOptionalParams) => PagedAsyncIterableIterator<Invoice, Invoice[], PageSettings>