Invoices - Download Documents By Billing Subscription

Služba:

Billing

Verze rozhraní API:

2024-04-01

Získá adresu URL pro stažení více faktur dokumentů (faktura PDF, daňové doklady, dobropisy) jako soubor ZIP.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string	ID, které jednoznačně identifikuje fakturační předplatné. Vzor regulárního výrazu: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta. Aktuální verze je 2024-04-01.

Text požadavku

Name	Typ	Description
parameters	DocumentDownloadRequest[]	Seznam podrobností o stažení jednotlivých dokumentů

Odpovědi

Name	Typ	Description
200 OK	DocumentDownloadResult	Zabezpečená adresa URL, kterou lze použít ke stažení entity, dokud nevyprší platnost adresy URL.
202 Accepted		Operace přijala výsledek, který vrací hlavičku Location,kterou klient může dotazovat, aby zobrazil výsledek operace. Hlavičky Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Příklady

InvoicesDownloadDocumentsByBillingSubscription

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

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

Definice

Name	Description
DocumentDownloadRequest	Seznam podrobností o stažení jednotlivých dokumentů
DocumentDownloadResult	Zabezpečená adresa URL, kterou lze použít ke stažení entity, dokud nevyprší platnost adresy URL.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď

DocumentDownloadRequest

Seznam podrobností o stažení jednotlivých dokumentů

Name	Typ	Description
documentName	string	ID, které jednoznačně identifikuje dokument faktury. Toto ID může být identifikátor faktury VE FORMÁTU PDF, dobropisu nebo daňového potvrzení. Pokud tento parametr vynecháte, vrátí se poslední faktura VE FORMÁTU PDF faktury.
invoiceName	string	ID, které jednoznačně identifikuje fakturu.

DocumentDownloadResult

Zabezpečená adresa URL, kterou lze použít ke stažení entity, dokud nevyprší platnost adresy URL.

Name	Typ	Description
expiryTime	string	Čas ve standardu UTC, kdy vyprší platnost adresy URL pro stažení.
url	string	Adresa URL souboru PDF nebo .zip.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.