Transactions - List By Invoice

リファレンス

Service:: Billing

API Version:: 2020-05-01

請求書のトランザクションを一覧表示します。トランザクションには、購入、払い戻し、Azure の使用料金が含まれます。

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

URI パラメーター

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

応答

名前	型	説明
200 OK	TransactionListResult	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	ユーザーアカウントの借用

例

TransactionsListByInvoice

Sample Request

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

/** Samples for Transactions ListByInvoice. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/TransactionsListByInvoice.json
     */
    /**
     * Sample code: TransactionsListByInvoice.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void transactionsListByInvoice(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.transactions().listByInvoice("{billingAccountName}", "{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

from azure.identity import DefaultAzureCredential
from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python transactions_list_by_invoice.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BillingManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.transactions.list_by_invoice(
        billing_account_name="{billingAccountName}",
        invoice_name="{invoiceName}",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/TransactionsListByInvoice.json
if __name__ == "__main__":
    main()

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/TransactionsListByInvoice.json
func ExampleTransactionsClient_NewListByInvoicePager() {
	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)
	}
	pager := clientFactory.NewTransactionsClient().NewListByInvoicePager("{billingAccountName}", "{invoiceName}", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.TransactionListResult = armbilling.TransactionListResult{
		// 	Value: []*armbilling.Transaction{
		// 		{
		// 			Name: to.Ptr("41000000-0000-0000-0000-000000000000"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/transactions"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/transactions/41000000-0000-0000-0000-000000000000"),
		// 			Properties: &armbilling.TransactionProperties{
		// 				AzureCreditApplied: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](2000),
		// 				},
		// 				AzurePlan: to.Ptr("Microsoft Azure Plan for DevTest"),
		// 				BillingCurrency: to.Ptr("USD"),
		// 				BillingProfileDisplayName: to.Ptr("Contoso operations billing"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}"),
		// 				Date: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-05-01T00:00:00.000Z"); return t}()),
		// 				Discount: to.Ptr[float32](0.1),
		// 				EffectivePrice: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](10),
		// 				},
		// 				ExchangeRate: to.Ptr[float32](1),
		// 				Invoice: to.Ptr("2344233"),
		// 				InvoiceID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/2344233"),
		// 				InvoiceSectionDisplayName: to.Ptr("Contoso operations invoiceSection"),
		// 				InvoiceSectionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000"),
		// 				Kind: to.Ptr(armbilling.TransactionTypeKindAll),
		// 				MarketPrice: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](20),
		// 				},
		// 				PricingCurrency: to.Ptr("USD"),
		// 				ProductDescription: to.Ptr("Standard D1, US West 3"),
		// 				ProductFamily: to.Ptr("Storage"),
		// 				ProductType: to.Ptr("VM Instance"),
		// 				ProductTypeID: to.Ptr("A12345"),
		// 				Quantity: to.Ptr[int32](1),
		// 				ServicePeriodEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-09-30T00:00:00.000Z"); return t}()),
		// 				ServicePeriodStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-05-01T00:00:00.000Z"); return t}()),
		// 				SubTotal: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](4500),
		// 				},
		// 				Tax: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](500),
		// 				},
		// 				TransactionAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](5000),
		// 				},
		// 				TransactionType: to.Ptr(armbilling.ReservationTypePurchase),
		// 				UnitOfMeasure: to.Ptr("1 Minute"),
		// 				UnitType: to.Ptr("1 Runtime Minute"),
		// 				Units: to.Ptr[float32](11.25),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("51000000-0000-0000-0000-000000000000"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/transactions"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/transactions/51000000-0000-0000-0000-000000000000"),
		// 			Properties: &armbilling.TransactionProperties{
		// 				AzureCreditApplied: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](20),
		// 				},
		// 				AzurePlan: to.Ptr("Microsoft Azure Plan for DevTest"),
		// 				BillingCurrency: to.Ptr("USD"),
		// 				BillingProfileDisplayName: to.Ptr("Contoso operations billing"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}"),
		// 				Date: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-01T00:00:00.000Z"); return t}()),
		// 				Discount: to.Ptr[float32](0.1),
		// 				EffectivePrice: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](10),
		// 				},
		// 				ExchangeRate: to.Ptr[float32](1),
		// 				Invoice: to.Ptr("pending"),
		// 				InvoiceSectionDisplayName: to.Ptr("Contoso operations invoiceSection"),
		// 				InvoiceSectionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000"),
		// 				Kind: to.Ptr(armbilling.TransactionTypeKindAll),
		// 				MarketPrice: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](20),
		// 				},
		// 				PricingCurrency: to.Ptr("USD"),
		// 				ProductDescription: to.Ptr("Standard Support"),
		// 				ProductFamily: to.Ptr("Storage"),
		// 				ProductType: to.Ptr("VM Instance"),
		// 				ProductTypeID: to.Ptr("A12345"),
		// 				Quantity: to.Ptr[int32](1),
		// 				ServicePeriodEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-09-30T00:00:00.000Z"); return t}()),
		// 				ServicePeriodStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-05-01T00:00:00.000Z"); return t}()),
		// 				SubTotal: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](45),
		// 				},
		// 				Tax: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](5),
		// 				},
		// 				TransactionAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](50),
		// 				},
		// 				TransactionType: to.Ptr(armbilling.ReservationType("Cancel")),
		// 				UnitOfMeasure: to.Ptr("1 Minute"),
		// 				UnitType: to.Ptr("1 Runtime Minute"),
		// 				Units: to.Ptr[float32](1.25),
		// 			},
		// 	}},
		// }
	}
}

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 Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges.
 *
 * @summary Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/TransactionsListByInvoice.json
 */
async function transactionsListByInvoice() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const invoiceName = "{invoiceName}";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.transactions.listByInvoice(billingAccountName, invoiceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

transactionsListByInvoice().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

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/transactions/41000000-0000-0000-0000-000000000000",
      "name": "41000000-0000-0000-0000-000000000000",
      "type": "Microsoft.Billing/billingAccounts/transactions",
      "properties": {
        "kind": "all",
        "date": "2018-05-01T00:00:00Z",
        "invoice": "2344233",
        "invoiceId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/2344233",
        "productFamily": "Storage",
        "productTypeId": "A12345",
        "productType": "VM Instance",
        "productDescription": "Standard D1, US West 3",
        "transactionType": "Purchase",
        "transactionAmount": {
          "currency": "USD",
          "value": 5000
        },
        "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
        "invoiceSectionDisplayName": "Contoso operations invoiceSection",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
        "billingProfileDisplayName": "Contoso operations billing",
        "azurePlan": "Microsoft Azure Plan for DevTest",
        "azureCreditApplied": {
          "currency": "USD",
          "value": 2000
        },
        "billingCurrency": "USD",
        "discount": 0.1,
        "effectivePrice": {
          "currency": "USD",
          "value": 10
        },
        "exchangeRate": 1,
        "marketPrice": {
          "currency": "USD",
          "value": 20
        },
        "pricingCurrency": "USD",
        "quantity": 1,
        "servicePeriodStartDate": "2018-05-01T00:00:00Z",
        "servicePeriodEndDate": "2018-09-30T00:00:00Z",
        "subTotal": {
          "currency": "USD",
          "value": 4500
        },
        "tax": {
          "currency": "USD",
          "value": 500
        },
        "unitOfMeasure": "1 Minute",
        "units": 11.25,
        "unitType": "1 Runtime Minute"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/transactions/51000000-0000-0000-0000-000000000000",
      "name": "51000000-0000-0000-0000-000000000000",
      "type": "Microsoft.Billing/billingAccounts/transactions",
      "properties": {
        "kind": "all",
        "date": "2018-04-01T00:00:00Z",
        "invoice": "pending",
        "productFamily": "Storage",
        "productTypeId": "A12345",
        "productType": "VM Instance",
        "productDescription": "Standard Support",
        "transactionType": "Cancel",
        "transactionAmount": {
          "currency": "USD",
          "value": 50
        },
        "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
        "invoiceSectionDisplayName": "Contoso operations invoiceSection",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
        "billingProfileDisplayName": "Contoso operations billing",
        "azurePlan": "Microsoft Azure Plan for DevTest",
        "azureCreditApplied": {
          "currency": "USD",
          "value": 20
        },
        "billingCurrency": "USD",
        "discount": 0.1,
        "effectivePrice": {
          "currency": "USD",
          "value": 10
        },
        "exchangeRate": 1,
        "marketPrice": {
          "currency": "USD",
          "value": 20
        },
        "pricingCurrency": "USD",
        "quantity": 1,
        "servicePeriodStartDate": "2018-05-01T00:00:00Z",
        "servicePeriodEndDate": "2018-09-30T00:00:00Z",
        "subTotal": {
          "currency": "USD",
          "value": 45
        },
        "tax": {
          "currency": "USD",
          "value": 5
        },
        "unitOfMeasure": "1 Minute",
        "units": 1.25,
        "unitType": "1 Runtime Minute"
      }
    }
  ]
}

定義

名前	説明
Amount	金額。
ErrorDetails	エラーの詳細。
ErrorResponse	エラー応答は、サービスが受信要求を処理できないことを示します。理由は、エラーメッセージに表示されます。
ErrorSubDetails
ReservationType	トランザクションの種類。
Transaction	トランザクションです。
TransactionListResult	トランザクションの一覧。
TransactionTypeKind	トランザクションの種類。オプションはすべてまたは予約です。

Amount

金額。

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

ErrorDetails

エラーの詳細。

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

ErrorResponse

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

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

ErrorSubDetails

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

ReservationType

トランザクションの種類。

名前	型	説明
Purchase	string
Usage Charge	string

Transaction

トランザクションです。

名前	型	説明
id	string	リソース ID。
name	string	リソース名。
properties.azureCreditApplied	Amount	このトランザクションに自動的に適用される Azure クレジットの量。
properties.azurePlan	string	トランザクションに使用されたサブスクリプションの Azure プランの種類。
properties.billingCurrency	string	このトランザクションが請求される通貨の ISO 4217 コード。
properties.billingProfileDisplayName	string	トランザクションに対して課金される課金プロファイルの名前。
properties.billingProfileId	string	トランザクションに対して課金される課金プロファイルの ID。
properties.customerDisplayName	string	トランザクションが実行された顧客の名前。このフィールドは、Microsoft Partner Agreement課金アカウントにのみ適用されます。
properties.customerId	string	トランザクションが行われた顧客の ID。このフィールドは、Microsoft Partner Agreement課金アカウントにのみ適用されます。
properties.date	string	トランザクションの日付。
properties.discount	number	このトランザクションに適用される割引率 (ある場合)。
properties.effectivePrice	Amount	割引を適用した後の製品の価格。
properties.exchangeRate	number	請求金額を請求通貨に変換するために使用される為替レート (該当する場合)。
properties.invoice	string	トランザクションが課金された請求書。トランザクションが課金されない場合は "保留中" です。
properties.invoiceId	string	トランザクションが請求された請求書の ID。このフィールドは、課金対象のトランザクションにのみ適用されます。
properties.invoiceSectionDisplayName	string	トランザクションに対して課金される請求書セクションの名前。
properties.invoiceSectionId	string	トランザクションに対して課金される請求書セクションの ID。
properties.kind	TransactionTypeKind	トランザクションの種類。オプションはすべてまたは予約です。
properties.marketPrice	Amount	製品の小売価格。
properties.orderId	string	予約の注文 ID。フィールドは、種類の予約のトランザクションにのみ適用されます。
properties.orderName	string	予約注文の名前。フィールドは、種類の予約のトランザクションにのみ適用されます。
properties.pricingCurrency	string	製品の価格が設定されている通貨の ISO 4217 コード。
properties.productDescription	string	トランザクションが実行された製品の説明。
properties.productFamily	string	トランザクションが行われた製品のファミリ。
properties.productType	string	トランザクションが実行された製品の種類。
properties.productTypeId	string	トランザクションが実行された製品の種類の ID。
properties.quantity	integer	トランザクションで購入された数量。
properties.servicePeriodEndDate	string	製品期間の終了日、または使用が終了した月の終了日。
properties.servicePeriodStartDate	string	製品の購入日、または使用が開始された月の開始日。
properties.subTotal	Amount	トランザクションの税引き前金額。
properties.subscriptionId	string	トランザクションに使用されたサブスクリプションの ID。フィールドは、種類の予約のトランザクションにのみ適用されます。
properties.subscriptionName	string	トランザクションに使用されたサブスクリプションの名前。フィールドは、種類の予約のトランザクションにのみ適用されます。
properties.tax	Amount	トランザクションに適用される税額。
properties.transactionAmount	Amount	トランザクションに関連付けられている料金。
properties.transactionType	ReservationType	トランザクションの種類。
properties.unitOfMeasure	string	製品の請求に使用される測定単位。たとえば、コンピューティングサービスは時間単位で課金されます。
properties.unitType	string	特定の製品の測定単位の説明。
properties.units	number	特定の製品に使用されるユニットの数。
type	string	リソースの種類。

TransactionListResult

トランザクションの一覧。

名前	型	説明
nextLink	string	結果の次のページへのリンク (URL)。
totalCount	number	レコードの総数。
value	Transaction[]	トランザクションの一覧。

TransactionTypeKind

トランザクションの種類。オプションはすべてまたは予約です。

名前	型	説明
all	string
reservation	string

Transactions - List By Invoice

URI パラメーター

応答

セキュリティ

azure_auth

Scopes

例

TransactionsListByInvoice

Sample Request

Sample Response

定義

Amount

ErrorDetails

ErrorResponse

ErrorSubDetails

ReservationType

Transaction

TransactionListResult

TransactionTypeKind

その他のリソース