Partager via

Invoices - Download Documents By Billing Subscription

  • Référence
Service:
Billing
Version d'API:
2024-04-01

Obtient une URL pour télécharger plusieurs documents de facture (pdf de facture, reçus fiscaux, notes de crédit) sous forme de fichier zip.

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

Paramètres URI

Nom Dans Obligatoire Type Description
subscriptionId
 path True

string

ID qui identifie de façon unique un abonnement de facturation.

Modèle d’expression régulière: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version
 query True

string

Version de l’API à utiliser avec la demande cliente. La version actuelle est 2024-04-01.

Corps de la demande

Nom Type Description
parameters

DocumentDownloadRequest[]

Liste des détails de téléchargement pour les documents individuels.

Réponses

Nom Type Description
200 OK

DocumentDownloadResult

URL sécurisée qui peut être utilisée pour télécharger une entité jusqu’à l’expiration de l’URL.
202 Accepted

Une opération a accepté le résultat qui retourne un en-tête « Location » que le client peut interroger pour afficher le résultat de l’opération.

En-têtes

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

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Exemples

InvoicesDownloadDocumentsByBillingSubscription

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
}
Code d’état:
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

Définitions

Nom Description
DocumentDownloadRequest

Liste des détails de téléchargement pour les documents individuels.
DocumentDownloadResult

URL sécurisée qui peut être utilisée pour télécharger une entité jusqu’à l’expiration de l’URL.
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail

Détail de l’erreur.
ErrorResponse

Réponse d’erreur

DocumentDownloadRequest

Liste des détails de téléchargement pour les documents individuels.

Nom Type Description
documentName

string

ID qui identifie de façon unique un document de facture. Cet ID peut être un identificateur d’une facture PDF, d’une note de crédit ou d’un reçu fiscal. S’il est omis, la facture PDF la plus récente pour la facture est retournée.
invoiceName

string

ID qui identifie de façon unique une facture.

DocumentDownloadResult

URL sécurisée qui peut être utilisée pour télécharger une entité jusqu’à l’expiration de l’URL.

Nom Type Description
expiryTime

string

Heure UTC à laquelle l’URL de téléchargement expire.
url

string

URL du fichier PDF ou .zip.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.
type

string

Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d’erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.