TransactionProperties interface
A transaction.
Properties
| azure |
The amount of any Azure credits automatically applied to this transaction. |
| azure |
Details of the Azure plan. |
| billing |
The ISO 4217 code for the currency in which this transaction is billed. |
| billing |
The name of the billing profile. |
| billing |
The fully qualified ID that uniquely identifies a billing profile. |
| consumption |
The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction. |
| credit |
The credit type of the transaction. Applies only to credited transactions. |
| customer |
The name of the customer. |
| customer |
The fully qualified ID that uniquely identifies a customer. |
| date | The date of transaction. |
| discount | The percentage discount, if any, applied to this transaction. |
| effective |
The price of the product after applying any discounts. |
| exchange |
The exchange rate used to convert charged amount to billing currency, if applicable. |
| invoice | Invoice name on which the transaction was billed or 'Pending' if the transaction is not billed. |
| invoice |
The fully qualified ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed. |
| invoice |
The name of the invoice section. |
| invoice |
The fully qualified ID that uniquely identifies an invoice section. |
| is |
Whether or not the transaction is third party. |
| kind | Type of the transaction, billed or unbilled. |
| market |
The retail price of the product. |
| part |
The part number of the product for which the transaction took place. The field is only applicable for Enterprise Agreement invoices. |
| pricing |
The ISO 4217 code for the currency in which the product is priced. |
| product |
The description of the product for which the transaction took place. |
| product |
The family of the product for which the transaction took place. |
| product |
The type of the product for which the transaction took place. |
| product |
The ID of the product type for which the transaction took place. |
| quantity | The quantity purchased in the transaction. |
| reason |
There reason code for the transaction. |
| refund |
The refund details of a transaction. |
| service |
The end date of the product term, or the end date of the month in which usage ended. |
| service |
The date of the purchase of the product, or the start date of the month in which usage started. |
| special |
Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. |
| sub |
The pre-tax charged amount for the transaction. |
| tax | The tax amount applied to the transaction. |
| transaction |
The charge associated with the transaction. |
| transaction |
The type of transaction. |
| unit |
The unit of measure used to bill for the product. For example, compute services are billed per hour. |
| units | The number of units used for a given product. |
| unit |
The description for the unit of measure for a given product. |
Property Details
azureCreditApplied
The amount of any Azure credits automatically applied to this transaction.
azureCreditApplied?: TransactionPropertiesAzureCreditAppliedProperty Value
azurePlan
Details of the Azure plan.
azurePlan?: stringProperty Value
string
billingCurrency
The ISO 4217 code for the currency in which this transaction is billed.
billingCurrency?: stringProperty Value
string
billingProfileDisplayName
The name of the billing profile.
billingProfileDisplayName?: anyProperty Value
any
billingProfileId
The fully qualified ID that uniquely identifies a billing profile.
billingProfileId?: stringProperty Value
string
consumptionCommitmentDecremented
The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction.
consumptionCommitmentDecremented?: TransactionPropertiesConsumptionCommitmentDecrementedProperty Value
creditType
The credit type of the transaction. Applies only to credited transactions.
creditType?: stringProperty Value
string
customerDisplayName
The name of the customer.
customerDisplayName?: stringProperty Value
string
customerId
The fully qualified ID that uniquely identifies a customer.
customerId?: stringProperty Value
string
date
The date of transaction.
date?: DateProperty Value
Date
discount
The percentage discount, if any, applied to this transaction.
discount?: numberProperty Value
number
effectivePrice
The price of the product after applying any discounts.
effectivePrice?: TransactionPropertiesEffectivePriceProperty Value
exchangeRate
The exchange rate used to convert charged amount to billing currency, if applicable.
exchangeRate?: numberProperty Value
number
invoice
Invoice name on which the transaction was billed or 'Pending' if the transaction is not billed.
invoice?: stringProperty Value
string
invoiceId
The fully qualified ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed.
invoiceId?: stringProperty Value
string
invoiceSectionDisplayName
The name of the invoice section.
invoiceSectionDisplayName?: stringProperty Value
string
invoiceSectionId
The fully qualified ID that uniquely identifies an invoice section.
invoiceSectionId?: stringProperty Value
string
isThirdParty
Whether or not the transaction is third party.
isThirdParty?: booleanProperty Value
boolean
kind
Type of the transaction, billed or unbilled.
kind?: stringProperty Value
string
marketPrice
The retail price of the product.
marketPrice?: TransactionPropertiesMarketPriceProperty Value
partNumber
The part number of the product for which the transaction took place. The field is only applicable for Enterprise Agreement invoices.
partNumber?: stringProperty Value
string
pricingCurrency
The ISO 4217 code for the currency in which the product is priced.
pricingCurrency?: stringProperty Value
string
productDescription
The description of the product for which the transaction took place.
productDescription?: stringProperty Value
string
productFamily
The family of the product for which the transaction took place.
productFamily?: stringProperty Value
string
productType
The type of the product for which the transaction took place.
productType?: stringProperty Value
string
productTypeId
The ID of the product type for which the transaction took place.
productTypeId?: stringProperty Value
string
quantity
The quantity purchased in the transaction.
quantity?: numberProperty Value
number
reasonCode
There reason code for the transaction.
reasonCode?: stringProperty Value
string
refundTransactionDetails
The refund details of a transaction.
refundTransactionDetails?: TransactionPropertiesRefundTransactionDetailsProperty Value
servicePeriodEndDate
The end date of the product term, or the end date of the month in which usage ended.
servicePeriodEndDate?: DateProperty Value
Date
servicePeriodStartDate
The date of the purchase of the product, or the start date of the month in which usage started.
servicePeriodStartDate?: DateProperty Value
Date
specialTaxationType
Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic.
specialTaxationType?: stringProperty Value
string
subTotal
The pre-tax charged amount for the transaction.
subTotal?: TransactionPropertiesSubTotalProperty Value
tax
The tax amount applied to the transaction.
tax?: TransactionPropertiesTaxProperty Value
transactionAmount
The charge associated with the transaction.
transactionAmount?: TransactionPropertiesTransactionAmountProperty Value
transactionType
The type of transaction.
transactionType?: stringProperty Value
string
unitOfMeasure
The unit of measure used to bill for the product. For example, compute services are billed per hour.
unitOfMeasure?: stringProperty Value
string
units
The number of units used for a given product.
units?: numberProperty Value
number
unitType
The description for the unit of measure for a given product.
unitType?: stringProperty Value
string