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 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string	可唯一識別計費訂用帳戶的標識碼。 Regex 模式: ^[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。

要求本文

名稱	類型	Description
parameters	DocumentDownloadRequest[]	個別檔的下載詳細數據清單。

回應

名稱	類型	Description
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

定義

名稱	Description
DocumentDownloadRequest	個別檔的下載詳細數據清單。
DocumentDownloadResult	安全 URL，可用來下載實體，直到 URL 到期為止。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應

DocumentDownloadRequest

個別檔的下載詳細數據清單。

名稱	類型	Description
documentName	string	可唯一識別發票文件的標識碼。 此標識碼可能是發票 PDF、點數附註或稅務收據的標識碼。 如果省略，則會傳回發票的最新發票 PDF。
invoiceName	string	可唯一識別發票的標識碼。

DocumentDownloadResult

安全 URL，可用來下載實體，直到 URL 到期為止。

名稱	類型	Description
expiryTime	string	下載 URL 到期的 UTC 時間。
url	string	PDF 或 .zip 檔案的 URL。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。