Transactions - List By Invoice

Referenz

Service:: Billing

API Version:: 2020-05-01

Listet die Transaktionen für eine Rechnung auf. Transaktionen umfassen Käufe, Rückerstattungen und Azure-Nutzungsgebühren.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
billingAccountName	path	True	string	Die ID, die ein Abrechnungskonto eindeutig identifiziert.
invoiceName	path	True	string	Die ID, die eine Rechnung eindeutig identifiziert.
api-version	query	True	string	Die Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2020-05-01.

Antworten

Name	Typ	Beschreibung
200 OK	TransactionListResult	OK. Die Anforderung war erfolgreich.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
Amount	Der Betrag.
ErrorDetails	Die Details des Fehlers.
ErrorResponse	Die Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.
ErrorSubDetails
ReservationType	Der Transaktionstyp
Transaction	Transaktion.
TransactionListResult	Die Liste der Transaktionen.
TransactionTypeKind	Die Art der Transaktion. Optionen sind alle oder Reservierung.

Amount

Der Betrag.

Name	Typ	Beschreibung
currency	string	Die Währung für den Betragswert.
value	number	Betragswert.

ErrorDetails

Die Details des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode
details	ErrorSubDetails[]	Die Unterdetails des Fehlers.
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.
target	string	Das Ziel des bestimmten Fehlers.

ErrorResponse

Die Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Name	Typ	Beschreibung
error	ErrorDetails	Die Details des Fehlers.

ErrorSubDetails

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.
target	string	Das Ziel des bestimmten Fehlers.

ReservationType

Der Transaktionstyp

Name	Typ	Beschreibung
Purchase	string
Usage Charge	string

Transaction

Transaktion.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
name	string	Name der Ressource.
properties.azureCreditApplied	Amount	Die Höhe aller Azure-Gutschriften, die automatisch auf diese Transaktion angewendet werden.
properties.azurePlan	string	Der Typ des Azure-Plans des Abonnements, der für die Transaktion verwendet wurde.
properties.billingCurrency	string	Der ISO 4217-Code für die Währung, in der diese Transaktion abgerechnet wird.
properties.billingProfileDisplayName	string	Der Name des Abrechnungsprofils, das für die Transaktion in Rechnung gestellt wird.
properties.billingProfileId	string	Die ID des Abrechnungsprofils, das für die Transaktion in Rechnung gestellt wird.
properties.customerDisplayName	string	Der Name des Kunden, für den die Transaktion durchgeführt wurde. Das Feld gilt nur für Microsoft Partner-Vereinbarung Abrechnungskonto.
properties.customerId	string	Die ID des Kunden, für den die Transaktion durchgeführt wurde. Das Feld gilt nur für Microsoft Partner-Vereinbarung Abrechnungskonto.
properties.date	string	Das Datum der Transaktion.
properties.discount	number	Der prozentuale Rabatt, falls vorhanden, der auf diese Transaktion angewendet wird.
properties.effectivePrice	Amount	Der Preis des Produkts nach Anwendung etwaiger Rabatte.
properties.exchangeRate	number	Der Wechselkurs, der zum Umrechnen des berechneten Betrags in die Abrechnungswährung verwendet wird, falls zutreffend.
properties.invoice	string	Rechnung, auf der die Transaktion abgerechnet oder "ausstehend" wurde, wenn die Transaktion nicht in Rechnung gestellt wird.
properties.invoiceId	string	Die ID der Rechnung, auf der die Transaktion in Rechnung gestellt wurde. Dieses Feld gilt nur für Transaktionen, die in Rechnung gestellt werden.
properties.invoiceSectionDisplayName	string	Der Name des Rechnungsabschnitts, der für die Transaktion in Rechnung gestellt wird.
properties.invoiceSectionId	string	Die ID des Rechnungsabschnitts, der für die Transaktion in Rechnung gestellt wird.
properties.kind	TransactionTypeKind	Die Art der Transaktion. Optionen sind alle oder Reservierung.
properties.marketPrice	Amount	Der Einzelhandelspreis des Produkts.
properties.orderId	string	Die Bestell-ID der Reservierung. Das Feld gilt nur für Transaktionen der Art reservierung.
properties.orderName	string	Der Name des Reservierungsauftrags. Das Feld gilt nur für Transaktionen der Art reservierung.
properties.pricingCurrency	string	Der ISO 4217-Code für die Währung, in der das Produktpreis berechnet wird.
properties.productDescription	string	Die Beschreibung des Produkts, für das die Transaktion durchgeführt wurde.
properties.productFamily	string	Die Familie des Produkts, für das die Transaktion durchgeführt wurde.
properties.productType	string	Der Typ des Produkts, für das die Transaktion durchgeführt wurde.
properties.productTypeId	string	Die ID des Produkttyps, für den die Transaktion durchgeführt wurde.
properties.quantity	integer	Die in der Transaktion erworbene Menge.
properties.servicePeriodEndDate	string	Das Enddatum der Produktlaufzeit oder das Enddatum des Monats, in dem die Nutzung endet.
properties.servicePeriodStartDate	string	Das Kaufdatum des Produkts oder das Startdatum des Monats, in dem die Nutzung begonnen hat.
properties.subTotal	Amount	Der für die Transaktion berechnete Betrag vor Steuern.
properties.subscriptionId	string	Die ID des Abonnements, das für die Transaktion verwendet wurde. Das Feld gilt nur für Transaktionen der Art reservierung.
properties.subscriptionName	string	Der Name des Abonnements, das für die Transaktion verwendet wurde. Das Feld gilt nur für Transaktionen der Art reservierung.
properties.tax	Amount	Der auf die Transaktion angewendete Steuerbetrag.
properties.transactionAmount	Amount	Die der Transaktion zugeordnete Gebühr.
properties.transactionType	ReservationType	Der Transaktionstyp
properties.unitOfMeasure	string	Die Maßeinheit, die zum Abrechnen des Produkts verwendet wird. Computedienste werden beispielsweise pro Stunde abgerechnet.
properties.unitType	string	Die Beschreibung der Maßeinheit für ein bestimmtes Produkt.
properties.units	number	Die Anzahl der Einheiten, die für ein bestimmtes Produkt verwendet werden.
type	string	Der Ressourcentyp.

TransactionListResult

Die Liste der Transaktionen.

Name	Typ	Beschreibung
nextLink	string	Der Link (URL) zur nächsten Seite der Ergebnisse.
totalCount	number	Gesamtanzahl von Datensätzen.
value	Transaction[]	Die Liste der Transaktionen.

TransactionTypeKind

Die Art der Transaktion. Optionen sind alle oder Reservierung.

Name	Typ	Beschreibung
all	string
reservation	string

Transactions - List By Invoice

URI-Parameter

Antworten

Sicherheit

azure_auth

Scopes

Beispiele

TransactionsListByInvoice

Sample Request

Sample Response

Definitionen

Amount

ErrorDetails

ErrorResponse

ErrorSubDetails

ReservationType

Transaction

TransactionListResult

TransactionTypeKind

Zusätzliche Ressourcen