Invoices - Get By Subscription And Invoice Id

リファレンス

Service:: Billing

API Version:: 2020-05-01

サブスクリプション ID と請求書 ID で請求書を取得します。

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}?api-version=2020-05-01

URI パラメーター

名前	/	必須	型	説明
invoiceName	path	True	string	請求書を一意に識別する ID。
subscriptionId	path	True	string	Azure サブスクリプションを一意に識別する ID。
api-version	query	True	string	クライアント要求で使用される API のバージョン。現在のバージョンは 2020-05-01 です。

応答

名前	型	説明
200 OK	Invoice	OK です。要求は成功しました。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

BillingSubscriptionsListByBillingAccount

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}?api-version=2020-05-01

/** Samples for Invoices GetBySubscriptionAndInvoiceId. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoice.json
     */
    /**
     * Sample code: BillingSubscriptionsListByBillingAccount.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void billingSubscriptionsListByBillingAccount(
        com.azure.resourcemanager.billing.BillingManager manager) {
        manager.invoices().getBySubscriptionAndInvoiceIdWithResponse("{invoiceName}", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armbilling_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billing/armbilling"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoice.json
func ExampleInvoicesClient_GetBySubscriptionAndInvoiceID() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbilling.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewInvoicesClient().GetBySubscriptionAndInvoiceID(ctx, "{invoiceName}", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Invoice = armbilling.Invoice{
	// 	Name: to.Ptr("1383724"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/billingSubscriptions/invoices"),
	// 	ID: to.Ptr("providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383724"),
	// 	Properties: &armbilling.InvoiceProperties{
	// 		AmountDue: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](2000),
	// 		},
	// 		BilledAmount: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](2000),
	// 		},
	// 		BillingProfileDisplayName: to.Ptr("Contoso Operations Billing"),
	// 		BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000"),
	// 		Documents: []*armbilling.Document{
	// 			{
	// 				Kind: to.Ptr(armbilling.DocumentTypeInvoice),
	// 				Source: to.Ptr(armbilling.DocumentSourceDRS),
	// 				URL: to.Ptr("https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383724/download"),
	// 		}},
	// 		DueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-01T17:32:28.000Z"); return t}()),
	// 		InvoiceDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-01T17:32:28.000Z"); return t}()),
	// 		InvoicePeriodEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-02T17:32:28.000Z"); return t}()),
	// 		InvoicePeriodStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-01T17:32:28.000Z"); return t}()),
	// 		InvoiceType: to.Ptr(armbilling.InvoiceTypeAzureMarketplace),
	// 		Payments: []*armbilling.PaymentProperties{
	// 			{
	// 				Amount: &armbilling.Amount{
	// 					Currency: to.Ptr("USD"),
	// 					Value: to.Ptr[float32](2000),
	// 				},
	// 				Date: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-14T17:32:28.000Z"); return t}()),
	// 				PaymentMethodFamily: to.Ptr(armbilling.PaymentMethodFamilyCreditCard),
	// 				PaymentMethodType: to.Ptr("visa"),
	// 				PaymentType: to.Ptr("credited"),
	// 		}},
	// 		PurchaseOrderNumber: to.Ptr("123456"),
	// 		Status: to.Ptr(armbilling.InvoiceStatusPaid),
	// 		SubscriptionID: to.Ptr("55000000-0000-0000-0000-000000000011"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets an invoice by subscription ID and invoice ID.
 *
 * @summary Gets an invoice by subscription ID and invoice ID.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoice.json
 */
async function billingSubscriptionsListByBillingAccount() {
  const subscriptionId = "{subscriptionId}";
  const invoiceName = "{invoiceName}";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const result = await client.invoices.getBySubscriptionAndInvoiceId(invoiceName);
  console.log(result);
}

billingSubscriptionsListByBillingAccount().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383724",
  "name": "1383724",
  "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices",
  "properties": {
    "dueDate": "2022-03-01T17:32:28Z",
    "invoiceDate": "2022-01-01T17:32:28Z",
    "status": "Paid",
    "amountDue": {
      "currency": "USD",
      "value": 2000
    },
    "billedAmount": {
      "currency": "USD",
      "value": 2000
    },
    "invoicePeriodStartDate": "2022-01-01T17:32:28Z",
    "invoicePeriodEndDate": "2022-01-30T17:32:28Z",
    "invoiceType": "AzureMarketplace",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
    "billingProfileDisplayName": "Contoso Operations Billing",
    "purchaseOrderNumber": "123456",
    "documents": [
      {
        "kind": "Invoice",
        "url": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383724/download",
        "source": "DRS"
      }
    ],
    "payments": [
      {
        "date": "2018-01-14T17:32:28Z",
        "paymentType": "credited",
        "amount": {
          "currency": "USD",
          "value": 2000
        },
        "paymentMethodFamily": "CreditCard",
        "paymentMethodType": "visa"
      }
    ],
    "subscriptionId": "55000000-0000-0000-0000-000000000011"
  }
}

定義

名前	説明
Amount	金額。
Document	ドキュメントのプロパティ。
DocumentSource	ドキュメントのソース。ブラジル向け ENF と世界の他の地域の DRS。
DocumentType	ドキュメントの種類。
ErrorDetails	エラーの詳細。
ErrorResponse	エラー応答は、サービスが受信要求を処理できないことを示します。理由は、エラーメッセージに表示されます。
ErrorSubDetails
Invoice	請求書。
InvoiceDocumentType	ドキュメントの種類。
InvoiceStatus	請求書の現在の状態。
InvoiceType	請求書の種類。
PaymentMethodFamily	支払い方法のファミリ。
PaymentProperties	支払いのプロパティ。
RebillDetails	請求書のリビルの詳細。

Amount

金額。

名前	型	説明
currency	string	金額値の通貨。
value	number	金額の値。

Document

ドキュメントのプロパティ。

名前	型	説明
kind	DocumentType	ドキュメントの種類。
source	DocumentSource	ドキュメントのソース。ブラジル向け 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	ErrorSubDetails[]	エラーのサブ詳細。
message	string	操作が失敗した理由を示すエラーメッセージ。
target	string	特定のエラーのターゲット。

ErrorResponse

エラー応答は、サービスが受信要求を処理できないことを示します。理由は、エラーメッセージに表示されます。

名前	型	説明
error	ErrorDetails	エラーの詳細。

ErrorSubDetails

名前	型	説明
code	string	エラーコード。
message	string	操作が失敗した理由を示すエラーメッセージ。
target	string	特定のエラーのターゲット。

Invoice

請求書。

名前	型	説明
id	string	リソース ID。
name	string	リソース名。
properties.amountDue	Amount	現在の期限の金額。
properties.azurePrepaymentApplied	Amount	料金に適用される Azure 前払いの金額。このフィールドは、契約の種類がMicrosoft 顧客契約の課金アカウントに適用されます。
properties.billedAmount	Amount	請求書の請求期間の合計料金。
properties.billedDocumentId	string	この請求書が無効になった後に最初に請求されるアクティブな請求書の ID。このフィールドは、無効な請求書にのみ適用されます。
properties.billingProfileDisplayName	string	請求書が生成される課金プロファイルの名前。
properties.billingProfileId	string	請求書が生成される課金プロファイルの ID。
properties.creditAmount	Amount	請求書の請求期間中の返品とキャンセルの合計払い戻し。このフィールドは、契約の種類がMicrosoft 顧客契約の課金アカウントに適用されます。
properties.creditForDocumentId	string	無効になった請求書の ID と、このクレジットノートが結果として発行されました。このフィールドは、貸方票にのみ適用されます。
properties.documentType	InvoiceDocumentType	ドキュメントの種類。
properties.documents	Document[]	請求書や領収書など、ダウンロードできるドキュメントの一覧。
properties.dueDate	string	請求書の期限。
properties.freeAzureCreditApplied	Amount	料金に適用される無料の Azure クレジットの量。このフィールドは、契約の種類がMicrosoft 顧客契約の課金アカウントに適用されます。
properties.invoiceDate	string	請求書が生成された日付。
properties.invoicePeriodEndDate	string	請求書が生成される請求期間の終了日。
properties.invoicePeriodStartDate	string	請求書が生成される請求期間の開始日。
properties.invoiceType	InvoiceType	請求書の種類。
properties.isMonthlyInvoice	boolean	請求書が月次請求サイクルの一部として生成されるかどうかを指定します。このフィールドは、契約の種類がMicrosoft 顧客契約の課金アカウントに適用されます。
properties.payments	PaymentProperties[]	支払いの一覧。
properties.purchaseOrderNumber	string	請求書のオプションの発注書番号。
properties.rebillDetails	<string, RebillDetails>	請求書の詳細を再請求します。
properties.status	InvoiceStatus	請求書の現在の状態。
properties.subTotal	Amount	税引き前の金額。このフィールドは、契約の種類がMicrosoft 顧客契約の課金アカウントに適用されます。
properties.subscriptionId	string	請求書が生成されるサブスクリプションの ID。
properties.taxAmount	Amount	請求期間に請求される税金の金額。このフィールドは、契約の種類がMicrosoft 顧客契約の課金アカウントに適用されます。
properties.totalAmount	Amount	請求書が生成されたときに支払われる金額。このフィールドは、契約の種類が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	Amount	支払額。
date	string	支払いが行われた日付。
paymentMethodFamily	PaymentMethodFamily	支払い方法のファミリ。
paymentMethodType	string	支払い方法の種類。
paymentType	string	支払いの種類。

RebillDetails

請求書のリビルの詳細。

名前	型	説明
creditNoteDocumentId	string	クレジットノートの ID。
invoiceDocumentId	string	請求書の ID。
rebillDetails	<string, RebillDetails>	請求書の詳細を再請求します。

次の方法で共有

Invoices - Get By Subscription And Invoice Id

URI パラメーター

応答

セキュリティ

azure_auth

Scopes

例

BillingSubscriptionsListByBillingAccount

Sample Request

Sample Response

定義

Amount

Document

DocumentSource

DocumentType

ErrorDetails

ErrorResponse

ErrorSubDetails

Invoice

InvoiceDocumentType

InvoiceStatus

InvoiceType

PaymentMethodFamily

PaymentProperties

RebillDetails

その他のリソース