Invoices - Download Documents By Billing Subscription

Service:

Billing

API-versie:

2024-04-01

Hiermee haalt u een URL op voor het downloaden van meerdere factuurdocumenten (pdf, belastingbevestigingen, creditnota's) als een zip-bestand.

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

URI-parameters

Name	In	Vereist	Type	Description
subscriptionId	path	True	string	De id waarmee een factureringsabonnement uniek wordt geïdentificeerd. Regex-patroon: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	De versie van de API die moet worden gebruikt met de clientaanvraag. De huidige versie is 2024-04-01.

Aanvraagbody

Name	Type	Description
parameters	DocumentDownloadRequest[]	Een lijst met downloaddetails voor afzonderlijke documenten.

Antwoorden

Name	Type	Description
200 OK	DocumentDownloadResult	Een beveiligde URL die kan worden gebruikt om een entiteit te downloaden totdat de URL verloopt.
202 Accepted		Een geaccepteerd resultaat dat een locatieheader retourneert die de client kan peilen om het resultaat van de bewerking weer te geven. Kopteksten Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

InvoicesDownloadDocumentsByBillingSubscription

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
DocumentDownloadRequest	Een lijst met downloaddetails voor afzonderlijke documenten.
DocumentDownloadResult	Een beveiligde URL die kan worden gebruikt om een entiteit te downloaden totdat de URL verloopt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie

DocumentDownloadRequest

Een lijst met downloaddetails voor afzonderlijke documenten.

Name	Type	Description
documentName	string	De id waarmee een factuurdocument uniek wordt geïdentificeerd. Deze id kan een id zijn voor een pdf-factuur, een creditnota of een btw-ontvangstbewijs. Als u dit weglaat, wordt de meest recente factuur-PDF voor de factuur geretourneerd.
invoiceName	string	De id waarmee een factuur uniek wordt geïdentificeerd.

DocumentDownloadResult

Een beveiligde URL die kan worden gebruikt om een entiteit te downloaden totdat de URL verloopt.

Name	Type	Description
expiryTime	string	De tijd in UTC waarop de download-URL verloopt.
url	string	De URL naar het PDF- of .zip-bestand.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.