Invoices - Download Documents By Billing Subscription

Служба:

Billing

Версия API:

2024-04-01

Получает URL-адрес для скачивания нескольких документов счета (счет pdf, налоговые квитанции, кредитные заметки) в виде ZIP-файла.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string	Идентификатор, который однозначно идентифицирует подписку на выставление счетов. Шаблон регулярного выражения: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	Версия API, используемая с клиентским запросом. Текущая версия — 2024-04-01.

Текст запроса

Имя	Тип	Описание
parameters	DocumentDownloadRequest[]	Список сведений о скачивании отдельных документов.

Ответы

Имя	Тип	Описание
200 OK	DocumentDownloadResult	Безопасный URL-адрес, который можно использовать для скачивания сущности до истечения срока действия URL-адреса.
202 Accepted		Результат операции, возвращающий заголовок Location, который клиент может опрашивать, чтобы просмотреть результат операции. Заголовки Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Примеры

InvoicesDownloadDocumentsByBillingSubscription

Образец запроса

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

Пример ответа

Код состояния:

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

Код состояния:

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

Определения

Имя	Описание
DocumentDownloadRequest	Список сведений о скачивании отдельных документов.
DocumentDownloadResult	Безопасный URL-адрес, который можно использовать для скачивания сущности до истечения срока действия URL-адреса.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку

DocumentDownloadRequest

Список сведений о скачивании отдельных документов.

Имя	Тип	Описание
documentName	string	Идентификатор, который однозначно идентифицирует документ счета. Этот идентификатор может быть идентификатором PDF-файла счета, кредитной заметки или налоговой квитанции. Если опущено, будет возвращен последний PDF-файл счета для счета.
invoiceName	string	Идентификатор, который однозначно идентифицирует счет.

DocumentDownloadResult

Безопасный URL-адрес, который можно использовать для скачивания сущности до истечения срока действия URL-адреса.

Имя	Тип	Описание
expiryTime	string	Время в формате UTC при истечении срока действия URL-адреса скачивания.
url	string	URL-адрес PDF-файла или .zip файла.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.