Compartilhar via


Invoices - Download Documents By Billing Subscription

Obtém uma URL para baixar vários documentos de fatura (pdf da fatura, recibos de impostos, notas de crédito) como um arquivo zip.

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/downloadDocuments?api-version=2024-04-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
subscriptionId
path True

string

A ID que identifica exclusivamente uma assinatura de cobrança.

Padrão Regex: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version
query True

string

A versão da API a ser usada com a solicitação do cliente. A versão atual é 2024-04-01.

Corpo da solicitação

Nome Tipo Description
parameters

DocumentDownloadRequest[]

Uma lista de detalhes de download para documentos individuais.

Respostas

Nome Tipo Description
200 OK

DocumentDownloadResult

Uma URL segura que pode ser usada para baixar uma entidade até que a URL expire.

202 Accepted

Um resultado aceito pela operação que retorna um cabeçalho 'Location' que o cliente pode sondar para exibir o resultado da operação.

Cabeçalhos

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Exemplos

InvoicesDownloadDocumentsByBillingSubscription

Solicitação de exemplo

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/00000000-0000-0000-0000-000000000000/downloadDocuments?api-version=2024-04-01

[
  {
    "documentName": "12345678",
    "invoiceName": "E123456789"
  },
  {
    "documentName": "12345678",
    "invoiceName": "E987654321"
  }
]

Resposta de exemplo

{
  "expiryTime": "2023-02-16T17:32:28Z",
  "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r"
}
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/00000000-0000-0000-0000-000000000000/operationResults/invoiceDownload_11111111-1111-1111-1111-111111111111?api-version=2024-04-01
Retry-After: 10

Definições

Nome Description
DocumentDownloadRequest

Uma lista de detalhes de download para documentos individuais.

DocumentDownloadResult

Uma URL segura que pode ser usada para baixar uma entidade até que a URL expire.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

DocumentDownloadRequest

Uma lista de detalhes de download para documentos individuais.

Nome Tipo Description
documentName

string

A ID que identifica exclusivamente um documento de fatura. Essa ID pode ser um identificador para um PDF de fatura, uma anotação de crédito ou um recibo de imposto. Se omitido, o PDF da fatura mais recente da fatura será retornado.

invoiceName

string

A ID que identifica exclusivamente uma fatura.

DocumentDownloadResult

Uma URL segura que pode ser usada para baixar uma entidade até que a URL expire.

Nome Tipo Description
expiryTime

string

A hora em UTC em que a URL de download expirará.

url

string

A URL para o arquivo PDF ou .zip.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.