Invoices - List By Billing Profile

Service:

Billing

API Version:

2020-05-01

Wyświetla listę faktur dla profilu rozliczeniowego dla danej daty rozpoczęcia i daty zakończenia. Operacja jest obsługiwana w przypadku kont rozliczeniowych z typem umowy Microsoft Partner Agreement lub Umowa z Klientem Microsoft.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices?api-version=2020-05-01&periodStartDate={periodStartDate}&periodEndDate={periodEndDate}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
billingAccountName	path	True	string	Identyfikator, który jednoznacznie identyfikuje konto rozliczeniowe.
billingProfileName	path	True	string	Identyfikator, który jednoznacznie identyfikuje profil rozliczeniowy.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta. Bieżąca wersja to 2020-05-01.
periodEndDate	query	True	string	Data zakończenia pobierania faktur. Data powinna być określona w formacie MM-DD-RRRR.
periodStartDate	query	True	string	Data rozpoczęcia pobierania faktur. Data powinna być określona w formacie MM-DD-RRRR.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	InvoiceListResult	OK. Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

InvoicesListByBillingProfile

InvoicesListByBillingProfileWithRebillDetails

InvoicesListByBillingProfile

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices?api-version=2020-05-01&periodStartDate=2018-01-01&periodEndDate=2018-06-30

Java

/** Samples for Invoices ListByBillingProfile. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-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(
                "{billingAccountName}",
                "{billingProfileName}",
                "2018-01-01",
                "2018-06-30",
                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="{billingAccountName}",
        billing_profile_name="{billingProfileName}",
        period_start_date="2018-01-01",
        period_end_date="2018-06-30",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-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"

	"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/InvoicesListByBillingProfile.json
func ExampleInvoicesClient_NewListByBillingProfilePager_invoicesListByBillingProfile() {
	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("{billingAccountName}", "{billingProfileName}", "2018-01-01", "2018-06-30", 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("1383723"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/invoices"),
		// 			ID: to.Ptr("providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/1383723"),
		// 			Properties: &armbilling.InvoiceProperties{
		// 				AmountDue: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](8.53),
		// 				},
		// 				AzurePrepaymentApplied: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](25.46),
		// 				},
		// 				BilledAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](33.99),
		// 				},
		// 				BillingProfileDisplayName: to.Ptr("Contoso Operations Billing"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}"),
		// 				CreditAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](1),
		// 				},
		// 				DocumentType: to.Ptr(armbilling.InvoiceDocumentTypeInvoice),
		// 				Documents: []*armbilling.Document{
		// 					{
		// 						Kind: to.Ptr(armbilling.DocumentTypeInvoice),
		// 						Source: to.Ptr(armbilling.DocumentSourceDRS),
		// 						URL: to.Ptr("https://microsoft.com/invoice.pdf"),
		// 					},
		// 					{
		// 						Kind: to.Ptr(armbilling.DocumentTypeTaxReceipt),
		// 						Source: to.Ptr(armbilling.DocumentSourceDRS),
		// 						URL: to.Ptr("https://microsoft.com/taxDoc.pdf"),
		// 				}},
		// 				DueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-16T17:32:28.000Z"); return t}()),
		// 				FreeAzureCreditApplied: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](0),
		// 				},
		// 				InvoiceDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-01T17:32:28.000Z"); return t}()),
		// 				InvoicePeriodEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-15T17:32:28.000Z"); return t}()),
		// 				InvoicePeriodStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-01T17:32:28.000Z"); return t}()),
		// 				IsMonthlyInvoice: to.Ptr(false),
		// 				Payments: []*armbilling.PaymentProperties{
		// 					{
		// 						Amount: &armbilling.Amount{
		// 							Currency: to.Ptr("USD"),
		// 							Value: to.Ptr[float32](1),
		// 						},
		// 						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.InvoiceStatusDue),
		// 				SubTotal: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](33.99),
		// 				},
		// 				TaxAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](0),
		// 				},
		// 				TotalAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](7.53),
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("1383724"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/invoices"),
		// 			ID: to.Ptr("providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/1383724"),
		// 			Properties: &armbilling.InvoiceProperties{
		// 				AmountDue: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](16.53),
		// 				},
		// 				AzurePrepaymentApplied: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](15.46),
		// 				},
		// 				BilledAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](33.99),
		// 				},
		// 				BillingProfileDisplayName: to.Ptr("Contoso Operations Billing"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}"),
		// 				CreditAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](2),
		// 				},
		// 				DocumentType: to.Ptr(armbilling.InvoiceDocumentTypeInvoice),
		// 				Documents: []*armbilling.Document{
		// 					{
		// 						Kind: to.Ptr(armbilling.DocumentTypeInvoice),
		// 						Source: to.Ptr(armbilling.DocumentSourceDRS),
		// 						URL: to.Ptr("https://microsoft.com/invoice.pdf"),
		// 					},
		// 					{
		// 						Kind: to.Ptr(armbilling.DocumentTypeTaxReceipt),
		// 						Source: to.Ptr(armbilling.DocumentSourceDRS),
		// 						URL: to.Ptr("https://microsoft.com/taxDoc.pdf"),
		// 				}},
		// 				DueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-01T17:32:28.000Z"); return t}()),
		// 				FreeAzureCreditApplied: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](0),
		// 				},
		// 				InvoiceDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-01T17:32:28.000Z"); return t}()),
		// 				InvoicePeriodEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-28T17:32:28.000Z"); return t}()),
		// 				InvoicePeriodStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-01T17:32:28.000Z"); return t}()),
		// 				IsMonthlyInvoice: to.Ptr(true),
		// 				Payments: []*armbilling.PaymentProperties{
		// 					{
		// 						Amount: &armbilling.Amount{
		// 							Currency: to.Ptr("USD"),
		// 							Value: to.Ptr[float32](2),
		// 						},
		// 						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.InvoiceStatusDue),
		// 				SubTotal: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](33.99),
		// 				},
		// 				TaxAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](0),
		// 				},
		// 				TotalAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](16.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/2020-05-01/examples/InvoicesListByBillingProfile.json
 */
async function invoicesListByBillingProfile() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const billingProfileName = "{billingProfileName}";
  const periodStartDate = "2018-01-01";
  const periodEndDate = "2018-06-30";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.invoices.listByBillingProfile(
    billingAccountName,
    billingProfileName,
    periodStartDate,
    periodEndDate
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

invoicesListByBillingProfile().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}/invoices/1383723",
      "name": "1383723",
      "type": "Microsoft.Billing/billingAccounts/invoices",
      "properties": {
        "dueDate": "2018-01-16T17:32:28Z",
        "invoiceDate": "2018-01-01T17:32:28Z",
        "status": "Due",
        "amountDue": {
          "currency": "USD",
          "value": 8.53
        },
        "billedAmount": {
          "currency": "USD",
          "value": 33.99
        },
        "azurePrepaymentApplied": {
          "currency": "USD",
          "value": 25.46
        },
        "creditAmount": {
          "currency": "USD",
          "value": 1
        },
        "freeAzureCreditApplied": {
          "currency": "USD",
          "value": 0
        },
        "subTotal": {
          "currency": "USD",
          "value": 33.99
        },
        "taxAmount": {
          "currency": "USD",
          "value": 0
        },
        "totalAmount": {
          "currency": "USD",
          "value": 7.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",
        "documentType": "Invoice",
        "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": 1
            },
            "paymentMethodFamily": "CreditCard",
            "paymentMethodType": "visa"
          }
        ]
      }
    },
    {
      "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/1383724",
      "name": "1383724",
      "type": "Microsoft.Billing/billingAccounts/invoices",
      "properties": {
        "dueDate": "2018-03-01T17: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-02-01T17:32:28Z",
        "invoicePeriodEndDate": "2018-02-28T17:32:28Z",
        "isMonthlyInvoice": true,
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
        "billingProfileDisplayName": "Contoso Operations Billing",
        "purchaseOrderNumber": "123456",
        "documentType": "Invoice",
        "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"
          }
        ]
      }
    }
  ]
}

InvoicesListByBillingProfileWithRebillDetails

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices?api-version=2020-05-01&periodStartDate=2018-01-01&periodEndDate=2018-06-30

Java

/** Samples for Invoices ListByBillingProfile. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoicesListByBillingProfileWithRebillDetails.json
     */
    /**
     * Sample code: InvoicesListByBillingProfileWithRebillDetails.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void invoicesListByBillingProfileWithRebillDetails(
        com.azure.resourcemanager.billing.BillingManager manager) {
        manager
            .invoices()
            .listByBillingProfile(
                "{billingAccountName}",
                "{billingProfileName}",
                "2018-01-01",
                "2018-06-30",
                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_with_rebill_details.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="{billingAccountName}",
        billing_profile_name="{billingProfileName}",
        period_start_date="2018-01-01",
        period_end_date="2018-06-30",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoicesListByBillingProfileWithRebillDetails.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"

	"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/InvoicesListByBillingProfileWithRebillDetails.json
func ExampleInvoicesClient_NewListByBillingProfilePager_invoicesListByBillingProfileWithRebillDetails() {
	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("{billingAccountName}", "{billingProfileName}", "2018-01-01", "2018-06-30", 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("I000003"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/invoices"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/I000003"),
		// 			Properties: &armbilling.InvoiceProperties{
		// 				AmountDue: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](8.53),
		// 				},
		// 				AzurePrepaymentApplied: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](25.46),
		// 				},
		// 				BilledAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](33.99),
		// 				},
		// 				BillingProfileDisplayName: to.Ptr("Contoso Operations Billing"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}"),
		// 				CreditAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](1),
		// 				},
		// 				DocumentType: to.Ptr(armbilling.InvoiceDocumentTypeInvoice),
		// 				Documents: []*armbilling.Document{
		// 					{
		// 						Kind: to.Ptr(armbilling.DocumentTypeInvoice),
		// 						Source: to.Ptr(armbilling.DocumentSourceDRS),
		// 						URL: to.Ptr("https://microsoft.com/invoice.pdf"),
		// 					},
		// 					{
		// 						Kind: to.Ptr(armbilling.DocumentTypeTaxReceipt),
		// 						Source: to.Ptr(armbilling.DocumentSourceDRS),
		// 						URL: to.Ptr("https://microsoft.com/taxDoc.pdf"),
		// 				}},
		// 				DueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-16T17:32:28.000Z"); return t}()),
		// 				FreeAzureCreditApplied: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](0),
		// 				},
		// 				InvoiceDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-01T17:32:28.000Z"); return t}()),
		// 				InvoicePeriodEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-15T17:32:28.000Z"); return t}()),
		// 				InvoicePeriodStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-01T17:32:28.000Z"); return t}()),
		// 				IsMonthlyInvoice: to.Ptr(false),
		// 				Payments: []*armbilling.PaymentProperties{
		// 					{
		// 						Amount: &armbilling.Amount{
		// 							Currency: to.Ptr("USD"),
		// 							Value: to.Ptr[float32](1),
		// 						},
		// 						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"),
		// 				RebillDetails: map[string]*armbilling.RebillDetails{
		// 					"creditNoteDocumentId": &armbilling.RebillDetails{
		// 					},
		// 					"invoiceDocumentId": &armbilling.RebillDetails{
		// 					},
		// 					"rebillDetails": &armbilling.RebillDetails{
		// 					},
		// 				},
		// 				Status: to.Ptr(armbilling.InvoiceStatusDue),
		// 				SubTotal: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](33.99),
		// 				},
		// 				TaxAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](0),
		// 				},
		// 				TotalAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](7.53),
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("1383724"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/invoices"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/1383724"),
		// 			Properties: &armbilling.InvoiceProperties{
		// 				AmountDue: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](16.53),
		// 				},
		// 				AzurePrepaymentApplied: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](15.46),
		// 				},
		// 				BilledAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](33.99),
		// 				},
		// 				BillingProfileDisplayName: to.Ptr("Contoso Operations Billing"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}"),
		// 				CreditAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](2),
		// 				},
		// 				DocumentType: to.Ptr(armbilling.InvoiceDocumentTypeInvoice),
		// 				Documents: []*armbilling.Document{
		// 					{
		// 						Kind: to.Ptr(armbilling.DocumentTypeInvoice),
		// 						Source: to.Ptr(armbilling.DocumentSourceDRS),
		// 						URL: to.Ptr("https://microsoft.com/invoice.pdf"),
		// 					},
		// 					{
		// 						Kind: to.Ptr(armbilling.DocumentTypeTaxReceipt),
		// 						Source: to.Ptr(armbilling.DocumentSourceDRS),
		// 						URL: to.Ptr("https://microsoft.com/taxDoc.pdf"),
		// 				}},
		// 				DueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-01T17:32:28.000Z"); return t}()),
		// 				FreeAzureCreditApplied: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](0),
		// 				},
		// 				InvoiceDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-01T17:32:28.000Z"); return t}()),
		// 				InvoicePeriodEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-28T17:32:28.000Z"); return t}()),
		// 				InvoicePeriodStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-01T17:32:28.000Z"); return t}()),
		// 				IsMonthlyInvoice: to.Ptr(true),
		// 				Payments: []*armbilling.PaymentProperties{
		// 					{
		// 						Amount: &armbilling.Amount{
		// 							Currency: to.Ptr("USD"),
		// 							Value: to.Ptr[float32](2),
		// 						},
		// 						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.InvoiceStatusDue),
		// 				SubTotal: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](33.99),
		// 				},
		// 				TaxAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](0),
		// 				},
		// 				TotalAmount: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](16.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/2020-05-01/examples/InvoicesListByBillingProfileWithRebillDetails.json
 */
async function invoicesListByBillingProfileWithRebillDetails() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const billingProfileName = "{billingProfileName}";
  const periodStartDate = "2018-01-01";
  const periodEndDate = "2018-06-30";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.invoices.listByBillingProfile(
    billingAccountName,
    billingProfileName,
    periodStartDate,
    periodEndDate
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

invoicesListByBillingProfileWithRebillDetails().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}/invoices/I000003",
      "name": "I000003",
      "type": "Microsoft.Billing/billingAccounts/invoices",
      "properties": {
        "dueDate": "2018-01-16T17:32:28Z",
        "invoiceDate": "2018-01-01T17:32:28Z",
        "status": "Due",
        "amountDue": {
          "currency": "USD",
          "value": 8.53
        },
        "billedAmount": {
          "currency": "USD",
          "value": 33.99
        },
        "azurePrepaymentApplied": {
          "currency": "USD",
          "value": 25.46
        },
        "creditAmount": {
          "currency": "USD",
          "value": 1
        },
        "freeAzureCreditApplied": {
          "currency": "USD",
          "value": 0
        },
        "subTotal": {
          "currency": "USD",
          "value": 33.99
        },
        "taxAmount": {
          "currency": "USD",
          "value": 0
        },
        "totalAmount": {
          "currency": "USD",
          "value": 7.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",
        "documentType": "Invoice",
        "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": 1
            },
            "paymentMethodFamily": "CreditCard",
            "paymentMethodType": "visa"
          }
        ],
        "rebillDetails": {
          "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/CreditNote2",
          "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/I000002",
          "rebillDetails": {
            "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/CreditNote1",
            "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/I000001",
            "rebillDetails": null
          }
        }
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/1383724",
      "name": "1383724",
      "type": "Microsoft.Billing/billingAccounts/invoices",
      "properties": {
        "dueDate": "2018-03-01T17: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-02-01T17:32:28Z",
        "invoicePeriodEndDate": "2018-02-28T17:32:28Z",
        "isMonthlyInvoice": true,
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
        "billingProfileDisplayName": "Contoso Operations Billing",
        "purchaseOrderNumber": "123456",
        "documentType": "Invoice",
        "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"
          }
        ]
      }
    }
  ]
}

Definicje

Nazwa	Opis
Amount	Kwota.
Document	Właściwości dokumentu.
DocumentSource	Źródło dokumentu. EnF dla Brazylii i DRS dla reszty świata.
DocumentType	Typ dokumentu.
ErrorDetails	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.
ErrorSubDetails
Invoice	Faktura.
InvoiceDocumentType	Typ dokumentu.
InvoiceListResult	Lista faktur.
InvoiceStatus	Bieżący stan faktury.
InvoiceType	Typ faktury.
PaymentMethodFamily	Rodzina formy płatności.
PaymentProperties	Właściwości płatności.
RebillDetails	Szczegóły ponownego wysyłania faktury.

Amount

Kwota.

Nazwa	Typ	Opis
currency	string	Waluta dla wartości kwoty.
value	number	Wartość kwoty.

Document

Właściwości dokumentu.

Nazwa	Typ	Opis
kind	DocumentType	Typ dokumentu.
source	DocumentSource	Źródło dokumentu. EnF dla Brazylii i DRS dla reszty świata.
url	string	Adres URL dokumentu.

DocumentSource

Źródło dokumentu. EnF dla Brazylii i DRS dla reszty świata.

Nazwa	Typ	Opis
DRS	string
ENF	string

DocumentType

Typ dokumentu.

Nazwa	Typ	Opis
CreditNote	string
Invoice	string
TaxReceipt	string
VoidNote	string

ErrorDetails

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ErrorSubDetails[]	Szczegóły podrzędne błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.
target	string	Element docelowy określonego błędu.

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu.

ErrorSubDetails

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.
target	string	Element docelowy określonego błędu.

Invoice

Faktura.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.amountDue	Amount	Kwota należna od teraz.
properties.azurePrepaymentApplied	Amount	Kwota przedpłaty za platformę Azure zastosowana do opłat. To pole ma zastosowanie do kont rozliczeniowych z Umowa z Klientem Microsoft typu umowy.
properties.billedAmount	Amount	Łączne opłaty za okres rozliczeniowy faktury.
properties.billedDocumentId	string	Identyfikator aktywnej faktury, która jest pierwotnie rozliczana po anulowaniu tej faktury. To pole ma zastosowanie tylko do faktur unieważnianych.
properties.billingProfileDisplayName	string	Nazwa profilu rozliczeniowego, dla którego jest generowana faktura.
properties.billingProfileId	string	Identyfikator profilu rozliczeniowego, dla którego jest generowana faktura.
properties.creditAmount	Amount	Łączny zwrot kosztów zwrotów i anulowania w okresie rozliczeniowym faktury. To pole ma zastosowanie do kont rozliczeniowych z Umowa z Klientem Microsoft typu umowy.
properties.creditForDocumentId	string	Identyfikator faktury, która została unieważniona i ta notatka kredytowa została wystawiona w wyniku. To pole ma zastosowanie tylko do notatek kredytowych.
properties.documentType	InvoiceDocumentType	Typ dokumentu.
properties.documents	Document[]	Lista dokumentów dostępnych do pobrania, takich jak faktura i paragon podatkowy.
properties.dueDate	string	Data ukończenia faktury.
properties.freeAzureCreditApplied	Amount	Kwota bezpłatnych środków na korzystanie z platformy Azure zastosowana do opłat. To pole ma zastosowanie do kont rozliczeniowych z Umowa z Klientem Microsoft typu umowy.
properties.invoiceDate	string	Data wygenerowania faktury.
properties.invoicePeriodEndDate	string	Data zakończenia okresu rozliczeniowego, dla którego jest generowana faktura.
properties.invoicePeriodStartDate	string	Data rozpoczęcia okresu rozliczeniowego, dla którego jest generowana faktura.
properties.invoiceType	InvoiceType	Typ faktury.
properties.isMonthlyInvoice	boolean	Określa, czy faktura jest generowana w ramach miesięcznego cyklu fakturowania, czy nie. To pole ma zastosowanie do kont rozliczeniowych z Umowa z Klientem Microsoft typu umowy.
properties.payments	PaymentProperties[]	Lista płatności.
properties.purchaseOrderNumber	string	Opcjonalny numer zamówienia zakupu dla faktury.
properties.rebillDetails	<string,  RebillDetails>	Szczegóły ponownego wysyłania faktur.
properties.status	InvoiceStatus	Bieżący stan faktury.
properties.subTotal	Amount	Należna kwota przed opodatkowaniem. To pole ma zastosowanie do kont rozliczeniowych z Umowa z Klientem Microsoft typu umowy.
properties.subscriptionId	string	Identyfikator subskrypcji, dla której jest generowana faktura.
properties.taxAmount	Amount	Kwota podatku naliczona za okres rozliczeniowy. To pole ma zastosowanie do kont rozliczeniowych z Umowa z Klientem Microsoft typu umowy.
properties.totalAmount	Amount	Kwota należna po wygenerowaniu faktury. To pole ma zastosowanie do kont rozliczeniowych z Umowa z Klientem Microsoft typu umowy.
type	string	Typ zasobu.

InvoiceDocumentType

Typ dokumentu.

Nazwa	Typ	Opis
CreditNote	string
Invoice	string

InvoiceListResult

Lista faktur.

Nazwa	Typ	Opis
nextLink	string	Link (adres URL) do następnej strony wyników.
totalCount	number	Całkowita liczba rekordów.
value	Invoice[]	Lista faktur.

InvoiceStatus

Bieżący stan faktury.

Nazwa	Typ	Opis
Due	string
OverDue	string
Paid	string
Void	string

InvoiceType

Typ faktury.

Nazwa	Typ	Opis
AzureMarketplace	string
AzureService	string
AzureSupport	string

PaymentMethodFamily

Rodzina formy płatności.

Nazwa	Typ	Opis
CheckWire	string
CreditCard	string
Credits	string
None	string

PaymentProperties

Właściwości płatności.

Nazwa	Typ	Opis
amount	Amount	Zapłacona kwota.
date	string	Data dokonania płatności.
paymentMethodFamily	PaymentMethodFamily	Rodzina formy płatności.
paymentMethodType	string	Typ formy płatności.
paymentType	string	Typ płatności.

RebillDetails

Szczegóły ponownego wysyłania faktury.

Nazwa	Typ	Opis
creditNoteDocumentId	string	Identyfikator noty kredytowej.
invoiceDocumentId	string	Identyfikator faktury.
rebillDetails	<string,  RebillDetails>	Szczegóły ponownego wysyłania faktur.