Invoices - Download Documents By Billing Account

サービス:

Billing

API バージョン:

2024-04-01

複数の請求書ドキュメント (請求書 pdf、税金受領書、クレジット ノート) を zip ファイルとしてダウンロードする URL を取得します。 この操作は、契約の種類が Microsoft Partner Agreement または Microsoft 顧客契約の課金アカウントでサポートされています。

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

URI パラメーター

名前	/	必須	型	説明
billingAccountName	path	True	string	課金アカウントを一意に識別する ID。 正規表現パターン: ^([0-9]+|([Pp][Cc][Nn]\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$
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	操作が失敗した理由を説明するエラー応答。

例

InvoicesDownloadDocumentsByBillingAccount

要求のサンプル

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/downloadDocuments?api-version=2024-04-01

[
  {
    "documentName": "12345678",
    "invoiceName": "G123456789"
  },
  {
    "documentName": "12345678",
    "invoiceName": "G987654321"
  }
]

応答のサンプル

状態コード:

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/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/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	請求書ドキュメントを一意に識別する ID。 この ID は、請求書 PDF、クレジット ノート、または税金受領書の識別子である場合があります。 省略すると、請求書の最新の請求書 PDF が返されます。
invoiceName	string	請求書を一意に識別する ID。

DocumentDownloadResult

URL の有効期限が切れるまでエンティティをダウンロードするために使用できるセキュリティで保護された URL。

名前	型	説明
expiryTime	string	ダウンロード URL の有効期限が切れる UTC 時刻。
url	string	PDF または .zip ファイルの URL。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。