Invoices - List By Billing Profile

サービス:

Billing

API バージョン:

2024-04-01

特定の開始日と終了日の請求プロファイルの請求書を一覧表示します。 この操作は、契約の種類が Microsoft Partner Agreement または Microsoft 顧客契約の課金アカウントでサポートされています。

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices?api-version=2024-04-01

省略可能なパラメーターを含む:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices?periodStartDate={periodStartDate}&periodEndDate={periodEndDate}&api-version=2024-04-01&filter={filter}&orderBy={orderBy}&top={top}&skip={skip}&count={count}&search={search}

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})?)$
billingProfileName	path	True	string	課金プロファイルを一意に識別する ID。 正規表現パターン: ^[a-zA-Z\d-_]{1,128}$
api-version	query	True	string	クライアント要求で使用する API のバージョン。 現在のバージョンは 2024-04-01 です。
count	query		boolean	カウント クエリ オプションを使用すると、クライアントは、応答のリソースに含まれる一致するリソースの数を要求できます。
filter	query		string	フィルター クエリ オプションを使用すると、クライアントは要求 URL でアドレス指定されたリソースのコレクションをフィルター処理できます。
orderBy	query		string	orderby クエリ オプションを使用すると、クライアントは特定の順序でリソースを要求できます。
periodEndDate	query		string date	請求書が生成される請求期間の終了日。 日付は MM-DD-YYYY 形式です。
periodStartDate	query		string date	請求書が生成される請求期間の開始日。 日付は MM-DD-YYYY 形式です。
search	query		string	検索クエリ オプションを使用すると、クライアントは自由テキスト検索式に一致するコレクション内の項目を要求できます。 検索は、文字列フィールドでのみサポートされています。
skip	query		integer int64	skip クエリ オプションは、クエリ対象のコレクション内でスキップされ、結果に含まれない項目の数を要求します。
top	query		integer int64	上位のクエリ オプションは、クエリされたコレクション内のアイテムの数を結果に含めるよう要求します。 top でサポートされる最大値は 50 です。

応答

名前	型	説明
200 OK	InvoiceListResult	請求書の一覧。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

例

InvoicesListByBillingProfile

要求のサンプル

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoices?periodStartDate=2023-01-01&periodEndDate=2023-06-30&api-version=2024-04-01

Java

import java.time.LocalDate;

/**
 * Samples for Invoices ListByBillingProfile.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingProfile.
     * json
     */
    /**
     * Sample code: InvoicesListByBillingProfile.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void invoicesListByBillingProfile(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.invoices().listByBillingProfile(
            "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "xxxx-xxxx-xxx-xxx",
            LocalDate.parse("2023-01-01"), LocalDate.parse("2023-06-30"), null, null, null, null, null, null,
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python invoices_list_by_billing_profile.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.invoices.list_by_billing_profile(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        billing_profile_name="xxxx-xxxx-xxx-xxx",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingProfile.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

Go

package armbilling_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/c08ac9813477921ad8295b98ced8f82d11b8f913/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingProfile.json
func ExampleInvoicesClient_NewListByBillingProfilePager() {
	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.NewInvoicesClient().NewListByBillingProfilePager("00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "xxxx-xxxx-xxx-xxx", &armbilling.InvoicesClientListByBillingProfileOptions{PeriodStartDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-01-01"); return t }()),
		PeriodEndDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-06-30"); return t }()),
		Filter:        nil,
		OrderBy:       nil,
		Top:           nil,
		Skip:          nil,
		Count:         nil,
		Search:        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.InvoiceListResult = armbilling.InvoiceListResult{
		// 	Value: []*armbilling.Invoice{
		// 		{
		// 			Name: to.Ptr("G123456789"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/invoices"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789"),
		// 			Properties: &armbilling.InvoiceProperties{
		// 				AmountDue: &armbilling.InvoicePropertiesAmountDue{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](8.53),
		// 				},
		// 				AzurePrepaymentApplied: &armbilling.InvoicePropertiesAzurePrepaymentApplied{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](25.46),
		// 				},
		// 				BilledAmount: &armbilling.InvoicePropertiesBilledAmount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](33.99),
		// 				},
		// 				BillingProfileDisplayName: to.Ptr("Contoso Operations Billing"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx"),
		// 				CreditAmount: &armbilling.InvoicePropertiesCreditAmount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](0),
		// 				},
		// 				DocumentType: to.Ptr(armbilling.InvoiceDocumentTypeInvoice),
		// 				Documents: []*armbilling.InvoiceDocument{
		// 					{
		// 						Name: to.Ptr("12345678"),
		// 						Kind: to.Ptr(armbilling.InvoiceDocumentTypeInvoice),
		// 					},
		// 					{
		// 						Name: to.Ptr("22345678"),
		// 						Kind: to.Ptr(armbilling.InvoiceDocumentTypeTaxReceipt),
		// 				}},
		// 				DueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-16T17:32:28.000Z"); return t}()),
		// 				FreeAzureCreditApplied: &armbilling.InvoicePropertiesFreeAzureCreditApplied{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](0),
		// 				},
		// 				InvoiceDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-01T17:32:28.000Z"); return t}()),
		// 				InvoicePeriodEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-15T17:32:28.000Z"); return t}()),
		// 				InvoicePeriodStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-01T17:32:28.000Z"); return t}()),
		// 				IsMonthlyInvoice: to.Ptr(false),
		// 				PurchaseOrderNumber: to.Ptr("123456"),
		// 				RebillDetails: &armbilling.InvoicePropertiesRebillDetails{
		// 					CreditNoteDocumentID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2"),
		// 					InvoiceDocumentID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002"),
		// 					RebillDetails: &armbilling.RebillDetails{
		// 						CreditNoteDocumentID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote"),
		// 						InvoiceDocumentID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001"),
		// 					},
		// 				},
		// 				Status: to.Ptr(armbilling.InvoiceStatusDue),
		// 				SubTotal: &armbilling.InvoicePropertiesSubTotal{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](33.99),
		// 				},
		// 				TaxAmount: &armbilling.InvoicePropertiesTaxAmount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](1),
		// 				},
		// 				TotalAmount: &armbilling.InvoicePropertiesTotalAmount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](7.53),
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("G987654321"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/invoices"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321"),
		// 			Properties: &armbilling.InvoiceProperties{
		// 				AmountDue: &armbilling.InvoicePropertiesAmountDue{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](0),
		// 				},
		// 				AzurePrepaymentApplied: &armbilling.InvoicePropertiesAzurePrepaymentApplied{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](25.46),
		// 				},
		// 				BilledAmount: &armbilling.InvoicePropertiesBilledAmount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](33.99),
		// 				},
		// 				BillingProfileDisplayName: to.Ptr("Contoso Operations Billing"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx"),
		// 				CreditAmount: &armbilling.InvoicePropertiesCreditAmount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](0),
		// 				},
		// 				DocumentType: to.Ptr(armbilling.InvoiceDocumentTypeInvoice),
		// 				Documents: []*armbilling.InvoiceDocument{
		// 					{
		// 						Name: to.Ptr("12345678"),
		// 						Kind: to.Ptr(armbilling.InvoiceDocumentTypeInvoice),
		// 					},
		// 					{
		// 						Name: to.Ptr("22345678"),
		// 						Kind: to.Ptr(armbilling.InvoiceDocumentTypeTaxReceipt),
		// 				}},
		// 				DueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-16T17:32:28.000Z"); return t}()),
		// 				FreeAzureCreditApplied: &armbilling.InvoicePropertiesFreeAzureCreditApplied{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](0),
		// 				},
		// 				InvoiceDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-01T17:32:28.000Z"); return t}()),
		// 				InvoicePeriodEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-15T17:32:28.000Z"); return t}()),
		// 				InvoicePeriodStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-01T17:32:28.000Z"); return t}()),
		// 				IsMonthlyInvoice: to.Ptr(false),
		// 				Payments: []*armbilling.Payment{
		// 					{
		// 						Amount: &armbilling.PaymentAmount{
		// 							Currency: to.Ptr("USD"),
		// 							Value: to.Ptr[float32](33.99),
		// 						},
		// 						Date: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-14T17:32:28.000Z"); return t}()),
		// 						PaymentMethodFamily: to.Ptr(armbilling.PaymentMethodFamilyCreditCard),
		// 						PaymentMethodType: to.Ptr("visa"),
		// 						PaymentType: to.Ptr("debited"),
		// 				}},
		// 				PurchaseOrderNumber: to.Ptr("123455"),
		// 				RebillDetails: &armbilling.InvoicePropertiesRebillDetails{
		// 					CreditNoteDocumentID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2"),
		// 					InvoiceDocumentID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002"),
		// 					RebillDetails: &armbilling.RebillDetails{
		// 						CreditNoteDocumentID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote"),
		// 						InvoiceDocumentID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001"),
		// 					},
		// 				},
		// 				Status: to.Ptr(armbilling.InvoiceStatusPaid),
		// 				SubTotal: &armbilling.InvoicePropertiesSubTotal{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](33.99),
		// 				},
		// 				TaxAmount: &armbilling.InvoicePropertiesTaxAmount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](1),
		// 				},
		// 				TotalAmount: &armbilling.InvoicePropertiesTotalAmount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](7.53),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Lists the invoices for a billing profile for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
 *
 * @summary Lists the invoices for a billing profile for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingProfile.json
 */
async function invoicesListByBillingProfile() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
  const billingProfileName = "xxxx-xxxx-xxx-xxx";
  const periodStartDate = new Date("2023-01-01");
  const periodEndDate = new Date("2023-06-30");
  const options = {
    periodStartDate,
    periodEndDate,
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.invoices.listByBillingProfile(
    billingAccountName,
    billingProfileName,
    options,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Billing.Models;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/invoicesListByBillingProfile.json
// this example is just showing the usage of "Invoices_ListByBillingProfile" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BillingProfileResource created on azure
// for more information of creating BillingProfileResource, please refer to the document of BillingProfileResource
string billingAccountName = "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
string billingProfileName = "xxxx-xxxx-xxx-xxx";
ResourceIdentifier billingProfileResourceId = BillingProfileResource.CreateResourceIdentifier(billingAccountName, billingProfileName);
BillingProfileResource billingProfile = client.GetBillingProfileResource(billingProfileResourceId);

// invoke the operation and iterate over the result
BillingProfileResourceGetInvoicesOptions options = new BillingProfileResourceGetInvoicesOptions() { PeriodStartDate = DateTimeOffset.Parse("2023-01-01"), PeriodEndDate = DateTimeOffset.Parse("2023-06-30") };
await foreach (BillingInvoiceData item in billingProfile.GetInvoicesAsync(options))
{
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {item.Id}");
}

Console.WriteLine($"Succeeded");

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

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789",
      "name": "G123456789",
      "properties": {
        "amountDue": {
          "currency": "USD",
          "value": 8.53
        },
        "azurePrepaymentApplied": {
          "currency": "USD",
          "value": 25.46
        },
        "billedAmount": {
          "currency": "USD",
          "value": 33.99
        },
        "billingProfileDisplayName": "Contoso Operations Billing",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx",
        "creditAmount": {
          "currency": "USD",
          "value": 0
        },
        "documents": [
          {
            "kind": "Invoice",
            "name": "12345678"
          },
          {
            "kind": "TaxReceipt",
            "name": "22345678"
          }
        ],
        "documentType": "Invoice",
        "dueDate": "2023-02-16T17:32:28Z",
        "freeAzureCreditApplied": {
          "currency": "USD",
          "value": 0
        },
        "invoiceDate": "2023-02-01T17:32:28Z",
        "invoicePeriodEndDate": "2023-02-15T17:32:28Z",
        "invoicePeriodStartDate": "2023-02-01T17:32:28Z",
        "isMonthlyInvoice": false,
        "purchaseOrderNumber": "123456",
        "rebillDetails": {
          "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002",
          "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2",
          "rebillDetails": {
            "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001",
            "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote"
          }
        },
        "status": "Due",
        "subTotal": {
          "currency": "USD",
          "value": 33.99
        },
        "taxAmount": {
          "currency": "USD",
          "value": 1
        },
        "totalAmount": {
          "currency": "USD",
          "value": 7.53
        }
      },
      "type": "Microsoft.Billing/billingAccounts/invoices"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321",
      "name": "G987654321",
      "properties": {
        "amountDue": {
          "currency": "USD",
          "value": 0
        },
        "azurePrepaymentApplied": {
          "currency": "USD",
          "value": 25.46
        },
        "billedAmount": {
          "currency": "USD",
          "value": 33.99
        },
        "billingProfileDisplayName": "Contoso Operations Billing",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx",
        "creditAmount": {
          "currency": "USD",
          "value": 0
        },
        "documents": [
          {
            "kind": "Invoice",
            "name": "12345678"
          },
          {
            "kind": "TaxReceipt",
            "name": "22345678"
          }
        ],
        "documentType": "Invoice",
        "dueDate": "2023-01-16T17:32:28Z",
        "freeAzureCreditApplied": {
          "currency": "USD",
          "value": 0
        },
        "invoiceDate": "2023-01-01T17:32:28Z",
        "invoicePeriodEndDate": "2023-01-15T17:32:28Z",
        "invoicePeriodStartDate": "2023-01-01T17:32:28Z",
        "isMonthlyInvoice": false,
        "payments": [
          {
            "amount": {
              "currency": "USD",
              "value": 33.99
            },
            "date": "2023-01-14T17:32:28Z",
            "paymentMethodFamily": "CreditCard",
            "paymentMethodType": "visa",
            "paymentType": "debited"
          }
        ],
        "purchaseOrderNumber": "123455",
        "rebillDetails": {
          "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002",
          "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2",
          "rebillDetails": {
            "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001",
            "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote"
          }
        },
        "status": "Paid",
        "subTotal": {
          "currency": "USD",
          "value": 33.99
        },
        "taxAmount": {
          "currency": "USD",
          "value": 1
        },
        "totalAmount": {
          "currency": "USD",
          "value": 7.53
        }
      },
      "type": "Microsoft.Billing/billingAccounts/invoices"
    }
  ]
}

定義

名前	説明
Amount	金額。
AmountDue	現在の期限の金額。
AmountRefunded	払い戻しされた金額。
AmountRequested	要求された払い戻しの金額。
AzurePrepaymentApplied	料金に適用される Azure 前払いの金額。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。
BilledAmount	請求書請求期間の合計料金。
createdByType	リソースを作成した ID の種類。
CreditAmount	請求書請求期間中の返品と取り消しの合計払い戻し。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。
DocumentSource	ドキュメントのソース。 ブラジル向けの ENF と他の世界の DRS。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
FailedPayment	支払いが失敗しました。
FailedPaymentReason	支払いが失敗した理由。
FreeAzureCreditApplied	料金に適用される無料の Azure クレジットの量。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。
Invoice	請求書。
InvoiceDocument	ドキュメントのプロパティ。
InvoiceDocumentType	ドキュメントの種類。
InvoiceListResult	リソースの一覧のコンテナー
InvoiceProperties	請求書。
InvoiceStatus	請求書の現在の状態。
InvoiceType	請求書の種類。
Payment	請求書の支払い。
PaymentMethodFamily	支払い方法のファミリ。
RebillDetails	請求書のリビルの詳細。
RefundDetails	払い戻し要求の詳細。
RefundReasonCode	払い戻しの理由。
RefundStatus	払い戻し要求の状態。
SpecialTaxationType	請求書に使用される税計算の種類を識別します。 このフィールドは、特別な税計算ロジックを持つ請求書にのみ適用されます。
SubTotal	税引き前の金額。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。
systemData	リソースの作成と最後の変更に関連するメタデータ。
TaxAmount	請求期間に請求される税金の金額。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。
TotalAmount	請求書が生成された期限の金額。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。

Amount

金額。

名前	型	説明
currency	string	金額値の通貨。
value	number	金額の値。 たとえば、通貨が USD の場合、値 600 は $600.00 になります。

AmountDue

現在の期限の金額。

名前	型	説明
currency	string	金額値の通貨。
value	number	金額の値。 たとえば、通貨が USD の場合、値 600 は $600.00 になります。

AmountRefunded

払い戻しされた金額。

名前	型	説明
currency	string	金額値の通貨。
value	number	金額の値。 たとえば、通貨が USD の場合、値 600 は $600.00 になります。

AmountRequested

要求された払い戻しの金額。

名前	型	説明
currency	string	金額値の通貨。
value	number	金額の値。 たとえば、通貨が USD の場合、値 600 は $600.00 になります。

AzurePrepaymentApplied

料金に適用される Azure 前払いの金額。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。

名前	型	説明
currency	string	金額値の通貨。
value	number	金額の値。 たとえば、通貨が USD の場合、値 600 は $600.00 になります。

BilledAmount

請求書請求期間の合計料金。

名前	型	説明
currency	string	金額値の通貨。
value	number	金額の値。 たとえば、通貨が USD の場合、値 600 は $600.00 になります。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

CreditAmount

請求書請求期間中の返品と取り消しの合計払い戻し。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。

名前	型	説明
currency	string	金額値の通貨。
value	number	金額の値。 たとえば、通貨が USD の場合、値 600 は $600.00 になります。

DocumentSource

ドキュメントのソース。 ブラジル向けの ENF と他の世界の DRS。

名前	型	説明
DRS	string
ENF	string
Other	string

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

FailedPayment

支払いが失敗しました。

名前	型	説明
date	string	支払いが試行された日付。
failedPaymentReason	FailedPaymentReason	支払いが失敗した理由。

FailedPaymentReason

支払いが失敗した理由。

名前	型	説明
BankDeclined	string
CardExpired	string
IncorrectCardDetails	string
Other	string

FreeAzureCreditApplied

料金に適用される無料の Azure クレジットの量。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。

名前	型	説明
currency	string	金額値の通貨。
value	number	金額の値。 たとえば、通貨が USD の場合、値 600 は $600.00 になります。

Invoice

請求書。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties	InvoiceProperties	請求書。
systemData	systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソースに関連付けられているメタデータのディクショナリ。 リソースの種類によっては設定されない場合があります。 キー/値の最大長は 256 文字でサポートされます。 キー/値は、値を空にしたり、null にしたりしないでください。 キーは <> % &\ を含むできませんか? /
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

InvoiceDocument

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

名前	型	説明
documentNumbers	string[]	請求書伝票の伝票番号。
externalUrl	string	ソースが Microsoft.Billing の外部にある場合に請求書ドキュメントをダウンロードする URL。
kind	InvoiceDocumentType	ドキュメントの種類。
name	string	請求書ドキュメントを一意に識別する ID。 この ID は、請求書 PDF、クレジット ノート、または税金受領書の識別子である場合があります。
source	DocumentSource	ドキュメントのソース。 ブラジル向けの ENF と他の世界の DRS。
url	string	ソースが Microsoft.Billing の内部にある場合に請求書ドキュメントをダウンロードする URL。

InvoiceDocumentType

ドキュメントの種類。

名前	型	説明
CreditNote	string
Invoice	string
Other	string
Summary	string
TaxReceipt	string
Transactions	string
VoidNote	string

InvoiceListResult

リソースの一覧のコンテナー

名前	型	説明
nextLink	string	結果の次のページへのリンク (URL)。
value	Invoice[]	リソースの一覧。

InvoiceProperties

請求書。

名前	型	説明
amountDue	AmountDue	現在の期限の金額。
azurePrepaymentApplied	AzurePrepaymentApplied	料金に適用される Azure 前払いの金額。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。
billedAmount	BilledAmount	請求書請求期間の合計料金。
billedDocumentId	string	この請求書が無効になった後に最初に請求されたアクティブな請求書の ID。 このフィールドは、無効な請求書にのみ適用されます。
billingProfileDisplayName	string	請求書が生成される課金プロファイルの名前。
billingProfileId	string	請求書が生成される課金プロファイルの ID。
creditAmount	CreditAmount	請求書請求期間中の返品と取り消しの合計払い戻し。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。
creditForDocumentId	string	無効になった請求書の ID と、このクレジット ノートが結果として発行されました。 このフィールドは、クレジット ノートにのみ適用されます。
documentType	InvoiceDocumentType	ドキュメントの種類。
documents	InvoiceDocument[]	請求書、クレジット ノート、税金受領書など、ダウンロードして表示できるドキュメントの一覧。
dueDate	string	請求書の期限。
failedPayments	FailedPayment[]	失敗した支払いの一覧。
freeAzureCreditApplied	FreeAzureCreditApplied	料金に適用される無料の Azure クレジットの量。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。
invoiceDate	string	請求書が生成された日付。
invoicePeriodEndDate	string	請求書が生成される請求期間の終了日。 日付は MM-DD-YYYY 形式です。
invoicePeriodStartDate	string	請求書が生成される請求期間の開始日。 日付は MM-DD-YYYY 形式です。
invoiceType	InvoiceType	請求書の種類。
isMonthlyInvoice	boolean	請求書が月次請求サイクルの一部として生成されるかどうかを指定します。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。
payments	Payment[]	支払いの一覧。
purchaseOrderNumber	string	請求書のオプションの発注書番号。
rebillDetails	RebillDetails	請求書の詳細を再請求します。
refundDetails	RefundDetails	払い戻し要求の詳細。
specialTaxationType	SpecialTaxationType	請求書に使用される税計算の種類を識別します。 このフィールドは、特別な税計算ロジックを持つ請求書にのみ適用されます。
status	InvoiceStatus	請求書の現在の状態。
subTotal	SubTotal	税引き前の金額。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。
subscriptionDisplayName	string	請求書が生成される課金サブスクリプションの名前。
subscriptionId	string	請求書が生成されるサブスクリプションの ID。
taxAmount	TaxAmount	請求期間に請求される税金の金額。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。
totalAmount	TotalAmount	請求書が生成された期限の金額。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。

InvoiceStatus

請求書の現在の状態。

名前	型	説明
Due	string
Locked	string
Other	string
OverDue	string
Paid	string
Void	string

InvoiceType

請求書の種類。

名前	型	説明
AzureMarketplace	string
AzureServices	string
AzureSupport	string
Other	string

Payment

請求書の支払い。

名前	型	説明
amount	Amount	支払い済み金額。
date	string	支払いが行われた日付。
paymentMethodFamily	PaymentMethodFamily	支払い方法のファミリ。
paymentMethodId	string	請求書に使用される支払方法を一意に識別する ID。
paymentMethodType	string	支払い方法の種類。
paymentType	string	支払いの種類。

PaymentMethodFamily

支払い方法のファミリ。

名前	型	説明
CheckWire	string
CreditCard	string
Credits	string
DirectDebit	string
EWallet	string
None	string
Other	string
TaskOrder	string

RebillDetails

請求書のリビルの詳細。

名前	型	説明
creditNoteDocumentId	string	クレジット ノートの ID。
invoiceDocumentId	string	請求書の ID。
rebillDetails	RebillDetails	請求書のリビルの詳細。

RefundDetails

払い戻し要求の詳細。

名前	型	説明
amountRefunded	AmountRefunded	払い戻しされた金額。
amountRequested	AmountRequested	要求された払い戻しの金額。
approvedOn	string	払い戻しが承認された日付。
completedOn	string	払い戻しが完了した日付。
rebillInvoiceId	string	払い戻しの請求請求書の請求書 ID。
refundOperationId	string	払い戻し操作の ID。
refundReason	RefundReasonCode	払い戻しの理由。
refundStatus	RefundStatus	払い戻し要求の状態。
requestedOn	string	払い戻しが要求された日付。
transactionCount	integer	払い戻されたトランザクションの数。

RefundReasonCode

払い戻しの理由。

名前	型	説明
AccidentalConversion	string
AccidentalPurchase	string
ForgotToCancel	string
Other	string
UnclearDocumentation	string
UnclearPricing	string

RefundStatus

払い戻し要求の状態。

名前	型	説明
Approved	string
Cancelled	string
Completed	string
Declined	string
Expired	string
Other	string
Pending	string

SpecialTaxationType

請求書に使用される税計算の種類を識別します。 このフィールドは、特別な税計算ロジックを持つ請求書にのみ適用されます。

名前	型	説明
InvoiceLevel	string
SubtotalLevel	string

SubTotal

税引き前の金額。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。

名前	型	説明
currency	string	金額値の通貨。
value	number	金額の値。 たとえば、通貨が USD の場合、値 600 は $600.00 になります。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

TaxAmount

請求期間に請求される税金の金額。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。

名前	型	説明
currency	string	金額値の通貨。
value	number	金額の値。 たとえば、通貨が USD の場合、値 600 は $600.00 になります。

TotalAmount

請求書が生成された期限の金額。 このフィールドは、契約の種類が Microsoft 顧客契約の請求先アカウントに適用されます。

名前	型	説明
currency	string	金額値の通貨。
value	number	金額の値。 たとえば、通貨が USD の場合、値 600 は $600.00 になります。