Invoices - Download Documents By Billing Account

Serviço:

Billing

Versão da API:

2024-04-01

Obtém uma URL para baixar vários documentos de fatura (pdf de fatura, recibos de impostos, notas de crédito) como um arquivo zip. A operação é suportada para contas de cobrança com tipo de contrato Contrato de Parceiro Microsoft ou Contrato de Cliente Microsoft.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
billingAccountName	path	True	string	O ID que identifica exclusivamente uma conta de cobrança. Padrão Regex: ^([0-9]+|([Pp][Cc][Nn]\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$
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 do Pedido

Name	Tipo	Description
parameters	DocumentDownloadRequest[]	Uma lista de detalhes de download para documentos individuais.

Respostas

Name	Tipo	Description
200 OK	DocumentDownloadResult	Um URL seguro que pode ser usado para baixar uma entidade até que o URL expire.
202 Accepted		Um resultado aceito da operação que retorna um cabeçalho 'Local' 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 descrevendo por que a operação falhou.

Exemplos

InvoicesDownloadDocumentsByBillingAccount

Pedido de amostra

HTTP

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

[
  {
    "documentName": "12345678",
    "invoiceName": "G123456789"
  },
  {
    "documentName": "12345678",
    "invoiceName": "G987654321"
  }
]

Resposta da amostra

Código de estado:

200

{
  "expiryTime": "2023-02-16T17:32:28Z",
  "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r"
}

Código de estado:

202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/invoiceDownload_11111111-1111-1111-1111-111111111111?api-version=2024-04-01
Retry-After: 10

Definições

Name	Description
DocumentDownloadRequest	Uma lista de detalhes de download para documentos individuais.
DocumentDownloadResult	Um URL seguro que pode ser usado para baixar uma entidade até que o URL expire.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro

DocumentDownloadRequest

Uma lista de detalhes de download para documentos individuais.

Name	Tipo	Description
documentName	string	O ID que identifica exclusivamente um documento de fatura. Esse ID pode ser um identificador para um PDF de fatura, uma nota de crédito ou um recibo de imposto. Se omitido, o PDF da fatura mais recente será devolvido.
invoiceName	string	O ID que identifica exclusivamente uma fatura.

DocumentDownloadResult

Um URL seguro que pode ser usado para baixar uma entidade até que o URL expire.

Name	Tipo	Description
expiryTime	string	A hora em UTC em que o URL de download expirará.
url	string	O URL para o ficheiro PDF ou .zip.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.