Transactions - List By Invoice

Referencia

Service:: Billing

API Version:: 2020-05-01

Egy számla tranzakcióit sorolja fel. A tranzakciók közé tartoznak a vásárlások, a visszatérítések és az Azure használati díjai.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
billingAccountName	path	True	string	A számlázási fiókot egyedileg azonosító azonosító.
invoiceName	path	True	string	A számlát egyedileg azonosító azonosító.
api-version	query	True	string	Az ügyfélkéréshez használni kívánt API verziója. Az aktuális verzió: 2020.05.01.

Válaszok

Name	Típus	Description
200 OK	TransactionListResult	OK gombra. A kérés sikeres volt.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

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

Definíciók

Name	Description
Amount	Az összeg.
ErrorDetails	A hiba részletei.
ErrorResponse	A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.
ErrorSubDetails
ReservationType	A tranzakció típusa.
Transaction	Egy tranzakció.
TransactionListResult	A tranzakciók listája.
TransactionTypeKind	A tranzakció típusa. A beállítások mind vagy foglalások.

Amount

Az összeg.

Name	Típus	Description
currency	string	Az összeg értékének pénzneme.
value	number	Összegérték.

ErrorDetails

A hiba részletei.

Name	Típus	Description
code	string	Hibakód.
details	ErrorSubDetails[]	A hiba aladatai.
message	string	Hibaüzenet jelzi, hogy a művelet miért nem sikerült.
target	string	Az adott hiba célja.

ErrorResponse

A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.

Name	Típus	Description
error	ErrorDetails	A hiba részletei.

ErrorSubDetails

Name	Típus	Description
code	string	Hibakód.
message	string	Hibaüzenet jelzi, hogy a művelet miért nem sikerült.
target	string	Az adott hiba célja.

ReservationType

A tranzakció típusa.

Name	Típus	Description
Purchase	string
Usage Charge	string

Transaction

Egy tranzakció.

Name	Típus	Description
id	string	Erőforrás-azonosító.
name	string	Erőforrás neve.
properties.azureCreditApplied	Amount	A tranzakcióra automatikusan alkalmazott Azure-kreditek mennyisége.
properties.azurePlan	string	A tranzakcióhoz használt előfizetés Azure-csomagjának típusa.
properties.billingCurrency	string	Annak a pénznemnek az ISO 4217-kódja, amelyben a tranzakciót kiszámlázták.
properties.billingProfileDisplayName	string	Annak a számlázási profilnak a neve, amely a tranzakcióért lesz számlázva.
properties.billingProfileId	string	A tranzakcióhoz kiszámlázott számlázási profil azonosítója.
properties.customerDisplayName	string	Annak az ügyfélnek a neve, amelyhez a tranzakciót végrehajtották. A mező csak Microsoft Partnerszerződés számlázási fiókra vonatkozik.
properties.customerId	string	Annak az ügyfélnek az azonosítója, amelyre a tranzakciót végrehajtották. A mező csak Microsoft Partnerszerződés számlázási fiókra vonatkozik.
properties.date	string	A tranzakció dátuma.
properties.discount	number	A tranzakcióra alkalmazott százalékos kedvezmény (ha van ilyen).
properties.effectivePrice	Amount	A termék ára a kedvezmények alkalmazása után.
properties.exchangeRate	number	A számlázott összeg számlázási pénznemre történő átváltásához használt átváltási árfolyam, ha van ilyen.
properties.invoice	string	Számla, amelyre a tranzakciót kiszámlázták, vagy "függőben" van, ha a tranzakciót nem számlázták ki.
properties.invoiceId	string	Annak a számlának az azonosítója, amelyre a tranzakciót kiszámlázták. Ez a mező csak a számlázott tranzakciókra vonatkozik.
properties.invoiceSectionDisplayName	string	Annak a számlaszakasznak a neve, amely a tranzakcióért lesz számlázva.
properties.invoiceSectionId	string	A tranzakcióhoz kiszámlázott számlaszakasz azonosítója.
properties.kind	TransactionTypeKind	A tranzakció típusa. A beállítások mind vagy foglalások.
properties.marketPrice	Amount	A termék kiskereskedelmi ára.
properties.orderId	string	A foglalás rendelésazonosítója. A mező csak a foglalás típusú tranzakciókra vonatkozik.
properties.orderName	string	A foglalási rendelés neve. A mező csak a foglalás típusú tranzakciókra vonatkozik.
properties.pricingCurrency	string	A termék árát tartalmazó pénznem ISO 4217-kódja.
properties.productDescription	string	Annak a terméknek a leírása, amelyre a tranzakciót végrehajtották.
properties.productFamily	string	Annak a terméknek a családja, amelyre az ügylet történt.
properties.productType	string	Annak a terméknek a típusa, amelyre a tranzakciót végrehajtották.
properties.productTypeId	string	Annak a terméktípusnak az azonosítója, amelyre a tranzakciót végrehajtották.
properties.quantity	integer	A tranzakcióban vásárolt mennyiség.
properties.servicePeriodEndDate	string	A termékkifejezés záró dátuma vagy annak a hónapnak a záró dátuma, amelyben a használat véget ért.
properties.servicePeriodStartDate	string	A termék megvásárlásának dátuma vagy annak a hónapnak a kezdő dátuma, amelyben a használat elkezdődött.
properties.subTotal	Amount	Az ügylethez felszámított adóelőfizetési összeg.
properties.subscriptionId	string	A tranzakcióhoz használt előfizetés azonosítója. A mező csak a foglalás típusú tranzakciókra vonatkozik.
properties.subscriptionName	string	A tranzakcióhoz használt előfizetés neve. A mező csak a foglalás típusú tranzakciókra vonatkozik.
properties.tax	Amount	A tranzakcióra alkalmazott adóösszeg.
properties.transactionAmount	Amount	A tranzakcióhoz társított díj.
properties.transactionType	ReservationType	A tranzakció típusa.
properties.unitOfMeasure	string	A termék számlázásához használt mértékegység. A számítási szolgáltatások számlázása például óraalapú.
properties.unitType	string	Az adott termék mértékegységének leírása.
properties.units	number	Az adott termékhez használt egységek száma.
type	string	Erőforrástípus.

TransactionListResult

A tranzakciók listája.

Name	Típus	Description
nextLink	string	Az eredmények következő oldalára mutató hivatkozás (URL).
totalCount	number	Rekordok teljes száma.
value	Transaction[]	A tranzakciók listája.

TransactionTypeKind

A tranzakció típusa. A beállítások mind vagy foglalások.

Name	Típus	Description
all	string
reservation	string

Transactions - List By Invoice

URI-paraméterek

Válaszok

Biztonság

azure_auth

Scopes

Példák

TransactionsListByInvoice

Sample Request

Sample Response

Definíciók

Amount

ErrorDetails

ErrorResponse

ErrorSubDetails

ReservationType

Transaction

TransactionListResult

TransactionTypeKind

További források