Condividi tramite

Invoices - Download Documents By Billing Subscription

  • Riferimento
Servizio:
Billing
Versione API:
2024-04-01

Ottiene un URL per scaricare più documenti di fattura (pdf fattura, ricevute fiscali, note di credito) come file ZIP.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
subscriptionId
 path True

string

ID che identifica in modo univoco una sottoscrizione di fatturazione.

Criterio di espressione regolare: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version
 query True

string

Versione dell'API da usare con la richiesta client. La versione corrente è 2024-04-01.

Corpo della richiesta

Nome Tipo Descrizione
parameters

DocumentDownloadRequest[]

Elenco dei dettagli di download per i singoli documenti.

Risposte

Nome Tipo Descrizione
200 OK

DocumentDownloadResult

URL sicuro che può essere usato per scaricare un'entità fino alla scadenza dell'URL.
202 Accepted

Risultato accettato dell'operazione che restituisce un'intestazione 'Location' di cui il client può eseguire il polling per visualizzare il risultato dell'operazione.

Intestazioni

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

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

InvoicesDownloadDocumentsByBillingSubscription

Esempio di richiesta

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"
  }
]

Risposta di esempio

Codice di stato:
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"
}
Codice di stato:
202 
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

Definizioni

Nome Descrizione
DocumentDownloadRequest

Elenco dei dettagli di download per i singoli documenti.
DocumentDownloadResult

URL sicuro che può essere usato per scaricare un'entità fino alla scadenza dell'URL.
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore

DocumentDownloadRequest

Elenco dei dettagli di download per i singoli documenti.

Nome Tipo Descrizione
documentName

string

ID che identifica in modo univoco un documento di fattura. Questo ID può essere un identificatore per un PDF della fattura, una nota di credito o una ricevuta fiscale. Se omesso, verrà restituito il PDF della fattura più recente per la fattura.
invoiceName

string

ID che identifica in modo univoco una fattura.

DocumentDownloadResult

URL sicuro che può essere usato per scaricare un'entità fino alla scadenza dell'URL.

Nome Tipo Descrizione
expiryTime

string

Ora in formato UTC alla scadenza dell'URL di download.
url

string

URL del file PDF o .zip.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.
type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.
code

string

Codice di errore.
details

ErrorDetail[]

Dettagli dell'errore.
message

string

Messaggio di errore.
target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.