Invoices - Download Documents By Billing Subscription

Servicio:

Billing

Versión de la API:

2024-04-01

Obtiene una dirección URL para descargar varios documentos de factura (pdf de factura, recibos fiscales, notas de crédito) como un archivo ZIP.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Identificador que identifica de forma única una suscripción de facturación. Patrón de Regex: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2024-04-01.

Cuerpo de la solicitud

Nombre	Tipo	Description
parameters	DocumentDownloadRequest[]	Lista de detalles de descarga de documentos individuales.

Respuestas

Nombre	Tipo	Description
200 OK	DocumentDownloadResult	Dirección URL segura que se puede usar para descargar una entidad hasta que expire la dirección URL.
202 Accepted		Resultado aceptado por una operación que devuelve un encabezado "Location" que el cliente puede sondear para ver el resultado de la operación. Encabezados Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Ejemplos

InvoicesDownloadDocumentsByBillingSubscription

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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

status code:

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

Definiciones

Nombre	Description
DocumentDownloadRequest	Lista de detalles de descarga de documentos individuales.
DocumentDownloadResult	Dirección URL segura que se puede usar para descargar una entidad hasta que expire la dirección URL.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error

DocumentDownloadRequest

Lista de detalles de descarga de documentos individuales.

Nombre	Tipo	Description
documentName	string	Identificador que identifica de forma única un documento de factura. Este identificador puede ser un identificador para un PDF de factura, una nota de crédito o un recibo fiscal. Si se omite, se devolverá el PDF de factura más reciente de la factura.
invoiceName	string	Identificador que identifica de forma única una factura.

DocumentDownloadResult

Dirección URL segura que se puede usar para descargar una entidad hasta que expire la dirección URL.

Nombre	Tipo	Description
expiryTime	string	Hora UTC en la que expirará la dirección URL de descarga.
url	string	Dirección URL del archivo PDF o .zip.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.