Invoices - Download Documents By Billing Subscription

Dienst:

Billing

API-Version:

2024-04-01

Ruft eine URL zum Herunterladen mehrerer Rechnungsdokumente (Rechnung PDF, Steuerbestätigungen, Gutschriften) als ZIP-Datei ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Die ID, die ein Abrechnungsabonnement eindeutig identifiziert. RegEx-Muster: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	Die Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2024-04-01.

Anforderungstext

Name	Typ	Beschreibung
parameters	DocumentDownloadRequest[]	Eine Liste der Downloaddetails für einzelne Dokumente.

Antworten

Name	Typ	Beschreibung
200 OK	DocumentDownloadResult	Eine sichere URL, die zum Herunterladen einer Entität verwendet werden kann, bis die URL abläuft.
202 Accepted		Ein akzeptiertes Ergebnis des Vorgangs, der einen "Location"-Header zurückgibt, den der Client abrufen kann, um das Ergebnis des Vorgangs anzuzeigen. Header Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

InvoicesDownloadDocumentsByBillingSubscription

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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

Statuscode:

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

Definitionen

Name	Beschreibung
DocumentDownloadRequest	Eine Liste der Downloaddetails für einzelne Dokumente.
DocumentDownloadResult	Eine sichere URL, die zum Herunterladen einer Entität verwendet werden kann, bis die URL abläuft.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort

DocumentDownloadRequest

Eine Liste der Downloaddetails für einzelne Dokumente.

Name	Typ	Beschreibung
documentName	string	Die ID, die ein Rechnungsdokument eindeutig identifiziert. Diese ID kann ein Bezeichner für eine PDF-Rechnung, eine Gutschrift oder ein Steuerbeleg sein. Wenn sie weggelassen wird, wird die letzte Rechnung PDF für die Rechnung zurückgegeben.
invoiceName	string	Die ID, die eine Rechnung eindeutig identifiziert.

DocumentDownloadResult

Eine sichere URL, die zum Herunterladen einer Entität verwendet werden kann, bis die URL abläuft.

Name	Typ	Beschreibung
expiryTime	string	Die Zeit in UTC, zu der die Download-URL abläuft.
url	string	Die URL zur PDF- oder .zip-Datei.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.