Invoices - Get By Id
ID で請求書を取得します。 この操作は、契約の種類がMicrosoft Partner AgreementまたはMicrosoft 顧客契約の課金アカウントでサポートされています。
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/invoices/{invoiceName}?api-version=2020-05-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
invoice
|
path | True |
string |
請求書を一意に識別する ID。 |
api-version
|
query | True |
string |
クライアント要求で使用される API のバージョン。 現在のバージョンは 2020-05-01 です。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK です。 要求は成功しました。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
Invoice
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/invoices/{invoiceName}?api-version=2020-05-01
Sample Response
{
"id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}",
"name": "{invoiceName}",
"type": "Microsoft.Billing/billingAccounts/invoices",
"properties": {
"dueDate": "2018-01-16T17:32:28Z",
"invoiceDate": "2018-01-01T17:32:28Z",
"status": "Due",
"amountDue": {
"currency": "USD",
"value": 16.53
},
"billedAmount": {
"currency": "USD",
"value": 33.99
},
"azurePrepaymentApplied": {
"currency": "USD",
"value": 15.46
},
"creditAmount": {
"currency": "USD",
"value": 2
},
"freeAzureCreditApplied": {
"currency": "USD",
"value": 0
},
"subTotal": {
"currency": "USD",
"value": 33.99
},
"taxAmount": {
"currency": "USD",
"value": 0
},
"totalAmount": {
"currency": "USD",
"value": 16.53
},
"invoicePeriodStartDate": "2018-01-01T17:32:28Z",
"invoicePeriodEndDate": "2018-01-15T17:32:28Z",
"isMonthlyInvoice": false,
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
"billingProfileDisplayName": "Contoso Operations Billing",
"purchaseOrderNumber": "123456",
"documents": [
{
"kind": "Invoice",
"url": "https://microsoft.com/invoice.pdf",
"source": "DRS"
},
{
"kind": "TaxReceipt",
"url": "https://microsoft.com/taxDoc.pdf",
"source": "DRS"
}
],
"payments": [
{
"date": "2018-01-14T17:32:28Z",
"paymentType": "credited",
"amount": {
"currency": "USD",
"value": 2
},
"paymentMethodFamily": "CreditCard",
"paymentMethodType": "visa"
}
]
}
}
定義
名前 | 説明 |
---|---|
Amount |
金額。 |
Document |
ドキュメントのプロパティ。 |
Document |
ドキュメントのソース。 ブラジル向け ENF と世界の他の地域の DRS。 |
Document |
ドキュメントの種類。 |
Error |
エラーの詳細。 |
Error |
エラー応答は、サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに示されています。 |
Error |
|
Invoice |
請求書。 |
Invoice |
ドキュメントの種類。 |
Invoice |
請求書の現在の状態。 |
Invoice |
請求書の種類。 |
Payment |
支払い方法のファミリ。 |
Payment |
支払いのプロパティ。 |
Rebill |
請求書のリビルの詳細。 |
Amount
金額。
名前 | 型 | 説明 |
---|---|---|
currency |
string |
金額値の通貨。 |
value |
number |
金額の値。 |
Document
ドキュメントのプロパティ。
名前 | 型 | 説明 |
---|---|---|
kind |
ドキュメントの種類。 |
|
source |
ドキュメントのソース。 ブラジル向け ENF と世界の他の地域の DRS。 |
|
url |
string |
ドキュメント URL。 |
DocumentSource
ドキュメントのソース。 ブラジル向け ENF と世界の他の地域の DRS。
名前 | 型 | 説明 |
---|---|---|
DRS |
string |
|
ENF |
string |
DocumentType
ドキュメントの種類。
名前 | 型 | 説明 |
---|---|---|
CreditNote |
string |
|
Invoice |
string |
|
TaxReceipt |
string |
|
VoidNote |
string |
ErrorDetails
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
details |
エラーのサブ詳細。 |
|
message |
string |
操作が失敗した理由を示すエラー メッセージ。 |
target |
string |
特定のエラーのターゲット。 |
ErrorResponse
エラー応答は、サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに示されています。
名前 | 型 | 説明 |
---|---|---|
error |
エラーの詳細。 |
ErrorSubDetails
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
message |
string |
操作が失敗した理由を示すエラー メッセージ。 |
target |
string |
特定のエラーのターゲット。 |
Invoice
請求書。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソース ID。 |
name |
string |
リソース名。 |
properties.amountDue |
現在の期限の金額。 |
|
properties.azurePrepaymentApplied |
料金に適用される Azure 前払いの金額。 このフィールドは、契約の種類がMicrosoft 顧客契約の課金アカウントに適用されます。 |
|
properties.billedAmount |
請求書の請求期間の合計料金。 |
|
properties.billedDocumentId |
string |
この請求書が無効になった後に最初に請求されたアクティブな請求書の ID。 このフィールドは、無効な請求書にのみ適用されます。 |
properties.billingProfileDisplayName |
string |
請求書が生成される課金プロファイルの名前。 |
properties.billingProfileId |
string |
請求書が生成される課金プロファイルの ID。 |
properties.creditAmount |
請求書の請求期間中の返品とキャンセルの合計払い戻し。 このフィールドは、契約の種類がMicrosoft 顧客契約の課金アカウントに適用されます。 |
|
properties.creditForDocumentId |
string |
無効になった請求書の ID と、その結果、このクレジット ノートが発行されました。 このフィールドは、与信票にのみ適用されます。 |
properties.documentType |
ドキュメントの種類。 |
|
properties.documents |
Document[] |
請求書や税金受領書など、ダウンロードできるドキュメントの一覧。 |
properties.dueDate |
string |
請求書の期限。 |
properties.freeAzureCreditApplied |
料金に適用される無料の Azure クレジットの量。 このフィールドは、契約の種類がMicrosoft 顧客契約の課金アカウントに適用されます。 |
|
properties.invoiceDate |
string |
請求書が生成された日付。 |
properties.invoicePeriodEndDate |
string |
請求書が生成される請求期間の終了日。 |
properties.invoicePeriodStartDate |
string |
請求書が生成される請求期間の開始日。 |
properties.invoiceType |
請求書の種類。 |
|
properties.isMonthlyInvoice |
boolean |
請求書が月次請求サイクルの一部として生成されるかどうかを指定します。 このフィールドは、契約の種類がMicrosoft 顧客契約の課金アカウントに適用されます。 |
properties.payments |
支払いの一覧。 |
|
properties.purchaseOrderNumber |
string |
請求書のオプションの発注書番号。 |
properties.rebillDetails |
<string,
Rebill |
請求書の詳細をリビルします。 |
properties.status |
請求書の現在の状態。 |
|
properties.subTotal |
税引前の金額。 このフィールドは、契約の種類がMicrosoft 顧客契約の課金アカウントに適用されます。 |
|
properties.subscriptionId |
string |
請求書が生成されるサブスクリプションの ID。 |
properties.taxAmount |
請求期間に請求される税の金額。 このフィールドは、契約の種類がMicrosoft 顧客契約の課金アカウントに適用されます。 |
|
properties.totalAmount |
請求書が生成されたときに支払われる金額。 このフィールドは、契約の種類がMicrosoft 顧客契約の課金アカウントに適用されます。 |
|
type |
string |
リソースの種類。 |
InvoiceDocumentType
ドキュメントの種類。
名前 | 型 | 説明 |
---|---|---|
CreditNote |
string |
|
Invoice |
string |
InvoiceStatus
請求書の現在の状態。
名前 | 型 | 説明 |
---|---|---|
Due |
string |
|
OverDue |
string |
|
Paid |
string |
|
Void |
string |
InvoiceType
請求書の種類。
名前 | 型 | 説明 |
---|---|---|
AzureMarketplace |
string |
|
AzureService |
string |
|
AzureSupport |
string |
PaymentMethodFamily
支払い方法のファミリ。
名前 | 型 | 説明 |
---|---|---|
CheckWire |
string |
|
CreditCard |
string |
|
Credits |
string |
|
None |
string |
PaymentProperties
支払いのプロパティ。
名前 | 型 | 説明 |
---|---|---|
amount |
支払額。 |
|
date |
string |
支払いが行われた日付。 |
paymentMethodFamily |
支払い方法のファミリ。 |
|
paymentMethodType |
string |
支払い方法の種類。 |
paymentType |
string |
支払いの種類。 |
RebillDetails
請求書のリビルの詳細。
名前 | 型 | 説明 |
---|---|---|
creditNoteDocumentId |
string |
クレジット ノートの ID。 |
invoiceDocumentId |
string |
請求書の ID。 |
rebillDetails |
<string,
Rebill |
請求書の詳細をリビルします。 |