Transactions - List By Invoice

Reference

Service:: Billing

API Version:: 2024-04-01

Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
billingAccountName	path	True	string	The ID that uniquely identifies a billing account. Regex pattern: `^([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})?)$`
invoiceName	path	True	string	The ID that uniquely identifies an invoice. Regex pattern: `^(H[0-9]-[A-Z0-9]+)$\|^(?:([GHT]\|HT){1}[A-Z0-9]{9})$\|^(?:[D]{1}[A-Z0-9]{9})$\|^(?:E{1}[B-Z0-9]{1}[A-Z0-9]{8})$\|^(?:EA[A-Z0-9]{8})$`
api-version	query	True	string	The version of the API to be used with the client request. The current version is 2024-04-01.
count	query		boolean	The count query option allows clients to request a count of the matching resources included with the resources in the response.
filter	query		string	The filter query option allows clients to filter a collection of resources that are addressed by a request URL.
orderBy	query		string	The orderby query option allows clients to request resources in a particular order.
search	query		string	The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.
skip	query		integer int64	The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.
top	query		integer int64	The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.

Responses

Name	Type	Description
200 OK	TransactionListResult	The list of transactions.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Examples

TransactionsListByInvoice

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789/transactions?api-version=2024-04-01

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/41000000-0000-0000-0000-000000000000",
      "name": "41000000-0000-0000-0000-000000000000",
      "properties": {
        "azureCreditApplied": {
          "currency": "USD",
          "value": 2000
        },
        "billingCurrency": "USD",
        "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",
        "consumptionCommitmentDecremented": {
          "currency": "USD",
          "value": 100
        },
        "date": "2023-05-01T00:00:00Z",
        "discount": 0.1,
        "effectivePrice": {
          "currency": "USD",
          "value": 10
        },
        "exchangeRate": 1,
        "invoice": "G123456789",
        "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789",
        "invoiceSectionDisplayName": "Contoso operations invoiceSection",
        "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/22000000-0000-0000-0000-000000000000",
        "marketPrice": {
          "currency": "USD",
          "value": 20
        },
        "partNumber": "0001",
        "pricingCurrency": "USD",
        "productDescription": "Standard D1, US West 3",
        "productFamily": "Storage",
        "productTypeId": "A12345",
        "productType": "VM Instance",
        "quantity": 1,
        "servicePeriodStartDate": "2023-05-01T00:00:00Z",
        "servicePeriodEndDate": "2023-09-30T00:00:00Z",
        "subTotal": {
          "currency": "USD",
          "value": 4500
        },
        "tax": {
          "currency": "USD",
          "value": 500
        },
        "transactionAmount": {
          "currency": "USD",
          "value": 5000
        },
        "transactionType": "Purchase",
        "units": 11.25,
        "unitOfMeasure": "1 Minute",
        "unitType": "1 Runtime Minute"
      },
      "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions"
    },
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/BillingProfiles/xxxx-xxxx-xxx-xxx/transactions/51000000-0000-0000-0000-000000000000",
      "name": "51000000-0000-0000-0000-000000000000",
      "properties": {
        "azureCreditApplied": {
          "currency": "USD",
          "value": 20
        },
        "billingCurrency": "USD",
        "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",
        "consumptionCommitmentDecremented": {
          "currency": "USD",
          "value": 50
        },
        "date": "2024-04-01T00:00:00Z",
        "discount": 0.1,
        "effectivePrice": {
          "currency": "USD",
          "value": 10
        },
        "exchangeRate": 1,
        "invoice": "pending",
        "invoiceSectionDisplayName": "Contoso operations invoiceSection",
        "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/22000000-0000-0000-0000-000000000000",
        "marketPrice": {
          "currency": "USD",
          "value": 20
        },
        "partNumber": "0002",
        "pricingCurrency": "USD",
        "productDescription": "Standard Support",
        "productFamily": "Storage",
        "productTypeId": "A12345",
        "productType": "VM Instance",
        "quantity": 1,
        "servicePeriodStartDate": "2023-05-01T00:00:00Z",
        "servicePeriodEndDate": "2023-09-30T00:00:00Z",
        "subTotal": {
          "currency": "USD",
          "value": 45
        },
        "tax": {
          "currency": "USD",
          "value": 5
        },
        "transactionAmount": {
          "currency": "USD",
          "value": 50
        },
        "transactionType": "Cancel",
        "units": 1.25,
        "unitOfMeasure": "1 Minute",
        "unitType": "1 Runtime Minute"
      },
      "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions"
    }
  ]
}

Definitions

Name	Description
AmountRefunded	The amount refunded.
AmountRequested	The amount of refund requested.
AzureCreditApplied	The amount of any Azure credits automatically applied to this transaction.
ConsumptionCommitmentDecremented	The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction.
createdByType	The type of identity that created the resource.
CreditType	The credit type of the transaction. Applies only to credited transactions.
EffectivePrice	The price of the product after applying any discounts.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
MarketPrice	The retail price of the product.
RefundTransactionDetails	The refund details of a transaction.
SpecialTaxationType	Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic.
SubTotal	The pre-tax charged amount for the transaction.
systemData	Metadata pertaining to creation and last modification of the resource.
Tax	The tax amount applied to the transaction.
Transaction	A transaction.
TransactionAmount	The charge associated with the transaction.
TransactionKind	Type of the transaction, billed or unbilled.
TransactionListResult	A container for a list of resources
TransactionProperties	A transaction.

AmountRefunded

The amount refunded.

Name	Type	Description
currency	string	The currency for the amount value.
value	number	The amount value. For example, if the currency is USD, then a value of 600 would be $600.00.

AmountRequested

The amount of refund requested.

Name	Type	Description
currency	string	The currency for the amount value.
value	number	The amount value. For example, if the currency is USD, then a value of 600 would be $600.00.

AzureCreditApplied

The amount of any Azure credits automatically applied to this transaction.

Name	Type	Description
currency	string	The currency for the amount value.
value	number	The amount value. For example, if the currency is USD, then a value of 600 would be $600.00.

ConsumptionCommitmentDecremented

The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction.

Name	Type	Description
currency	string	The currency for the amount value.
value	number	The amount value. For example, if the currency is USD, then a value of 600 would be $600.00.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreditType

The credit type of the transaction. Applies only to credited transactions.

Name	Type	Description
AzureCreditOffer	string
AzureFreeCredit	string
Other	string
Refund	string
ServiceInterruption	string

EffectivePrice

The price of the product after applying any discounts.

Name	Type	Description
currency	string	The currency for the amount value.
value	number	The amount value. For example, if the currency is USD, then a value of 600 would be $600.00.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

MarketPrice

The retail price of the product.

Name	Type	Description
currency	string	The currency for the amount value.
value	number	The amount value. For example, if the currency is USD, then a value of 600 would be $600.00.

RefundTransactionDetails

The refund details of a transaction.

Name	Type	Description
amountRefunded	AmountRefunded	The amount refunded.
amountRequested	AmountRequested	The amount of refund requested.
refundOperationId	string	The ID of refund operation.

SpecialTaxationType

Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic.

Name	Type	Description
InvoiceLevel	string
SubtotalLevel	string

SubTotal

The pre-tax charged amount for the transaction.

Name	Type	Description
currency	string	The currency for the amount value.
value	number	The amount value. For example, if the currency is USD, then a value of 600 would be $600.00.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Tax

The tax amount applied to the transaction.

Name	Type	Description
currency	string	The currency for the amount value.
value	number	The amount value. For example, if the currency is USD, then a value of 600 would be $600.00.

Transaction

A transaction.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	TransactionProperties	A transaction.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

TransactionAmount

The charge associated with the transaction.

Name	Type	Description
currency	string	The currency for the amount value.
value	number	The amount value. For example, if the currency is USD, then a value of 600 would be $600.00.

TransactionKind

Type of the transaction, billed or unbilled.

Name	Type	Description
All	string
Other	string
Reservation	string

TransactionListResult

A container for a list of resources

Name	Type	Description
nextLink	string	The link (url) to the next page of results.
value	Transaction[]	The list of resources.

TransactionProperties