TransactionProperties Class

A transaction.

Inheritance
azure.mgmt.billing._serialization.Model
TransactionProperties

Constructor

TransactionProperties(*, azure_credit_applied: _models.TransactionPropertiesAzureCreditApplied | None = None, azure_plan: str | None = None, billing_currency: str | None = None, billing_profile_display_name: Any | None = None, billing_profile_id: str | None = None, consumption_commitment_decremented: _models.TransactionPropertiesConsumptionCommitmentDecremented | None = None, customer_display_name: str | None = None, customer_id: str | None = None, credit_type: str | _models.CreditType | None = None, date: datetime | None = None, discount: float | None = None, effective_price: _models.TransactionPropertiesEffectivePrice | None = None, exchange_rate: float | None = None, invoice: str | None = None, invoice_id: str | None = None, invoice_section_display_name: str | None = None, invoice_section_id: str | None = None, is_third_party: bool | None = None, kind: str | _models.TransactionKind | None = None, market_price: _models.TransactionPropertiesMarketPrice | None = None, part_number: str | None = None, pricing_currency: str | None = None, product_description: str | None = None, product_family: str | None = None, product_type_id: str | None = None, product_type: str | None = None, quantity: int | None = None, reason_code: str | None = None, service_period_start_date: datetime | None = None, service_period_end_date: datetime | None = None, sub_total: _models.TransactionPropertiesSubTotal | None = None, tax: _models.TransactionPropertiesTax | None = None, transaction_amount: _models.TransactionPropertiesTransactionAmount | None = None, transaction_type: str | None = None, units: float | None = None, unit_of_measure: str | None = None, unit_type: str | None = None, special_taxation_type: str | _models.SpecialTaxationType | None = None, refund_transaction_details: _models.TransactionPropertiesRefundTransactionDetails | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
azure_credit_applied

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

azure_plan
str

Details of the Azure plan.

billing_currency
str

The ISO 4217 code for the currency in which this transaction is billed.

billing_profile_display_name
any

The name of the billing profile.

billing_profile_id
str

The fully qualified ID that uniquely identifies a billing profile.

consumption_commitment_decremented

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

customer_display_name
str

The name of the customer.

customer_id
str

The fully qualified ID that uniquely identifies a customer.

credit_type

The credit type of the transaction. Applies only to credited transactions. Known values are: "Other", "AzureFreeCredit", "AzureCreditOffer", "ServiceInterruption", and "Refund".

date

The date of transaction.

discount

The percentage discount, if any, applied to this transaction.

effective_price

The price of the product after applying any discounts.

exchange_rate

The exchange rate used to convert charged amount to billing currency, if applicable.

invoice
str

Invoice name on which the transaction was billed or 'Pending' if the transaction is not billed.

invoice_id
str

The fully qualified ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed.

invoice_section_display_name
str

The name of the invoice section.

invoice_section_id
str

The fully qualified ID that uniquely identifies an invoice section.

is_third_party

Whether or not the transaction is third party.

kind

Type of the transaction, billed or unbilled. Known values are: "Other", "All", and "Reservation".

market_price

The retail price of the product.

part_number
str

The part number of the product for which the transaction took place. The field is only applicable for Enterprise Agreement invoices.

pricing_currency
str

The ISO 4217 code for the currency in which the product is priced.

product_description
str

The description of the product for which the transaction took place.

product_family
str

The family of the product for which the transaction took place.

product_type_id
str

The ID of the product type for which the transaction took place.

product_type
str

The type of the product for which the transaction took place.

quantity
int

The quantity purchased in the transaction.

reason_code
str

There reason code for the transaction.

service_period_start_date

The date of the purchase of the product, or the start date of the month in which usage started.

service_period_end_date

The end date of the product term, or the end date of the month in which usage ended.

sub_total

The pre-tax charged amount for the transaction.

tax

The tax amount applied to the transaction.

transaction_amount

The charge associated with the transaction.

transaction_type
str

The type of transaction.

units

The number of units used for a given product.

unit_of_measure
str

The unit of measure used to bill for the product. For example, compute services are billed per hour.

unit_type
str

The description for the unit of measure for a given product.

special_taxation_type

Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. Known values are: "SubtotalLevel" and "InvoiceLevel".

refund_transaction_details

The refund details of a transaction.

Variables

Name Description
azure_credit_applied

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

azure_plan
str

Details of the Azure plan.

billing_currency
str

The ISO 4217 code for the currency in which this transaction is billed.

billing_profile_display_name
any

The name of the billing profile.

billing_profile_id
str

The fully qualified ID that uniquely identifies a billing profile.

consumption_commitment_decremented

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

customer_display_name
str

The name of the customer.

customer_id
str

The fully qualified ID that uniquely identifies a customer.

credit_type

The credit type of the transaction. Applies only to credited transactions. Known values are: "Other", "AzureFreeCredit", "AzureCreditOffer", "ServiceInterruption", and "Refund".

date

The date of transaction.

discount

The percentage discount, if any, applied to this transaction.

effective_price

The price of the product after applying any discounts.

exchange_rate

The exchange rate used to convert charged amount to billing currency, if applicable.

invoice
str

Invoice name on which the transaction was billed or 'Pending' if the transaction is not billed.

invoice_id
str

The fully qualified ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed.

invoice_section_display_name
str

The name of the invoice section.

invoice_section_id
str

The fully qualified ID that uniquely identifies an invoice section.

is_third_party

Whether or not the transaction is third party.

kind

Type of the transaction, billed or unbilled. Known values are: "Other", "All", and "Reservation".

market_price

The retail price of the product.

part_number
str

The part number of the product for which the transaction took place. The field is only applicable for Enterprise Agreement invoices.

pricing_currency
str

The ISO 4217 code for the currency in which the product is priced.

product_description
str

The description of the product for which the transaction took place.

product_family
str

The family of the product for which the transaction took place.

product_type_id
str

The ID of the product type for which the transaction took place.

product_type
str

The type of the product for which the transaction took place.

quantity
int

The quantity purchased in the transaction.

reason_code
str

There reason code for the transaction.

service_period_start_date

The date of the purchase of the product, or the start date of the month in which usage started.

service_period_end_date

The end date of the product term, or the end date of the month in which usage ended.

sub_total

The pre-tax charged amount for the transaction.

tax

The tax amount applied to the transaction.

transaction_amount

The charge associated with the transaction.

transaction_type
str

The type of transaction.

units

The number of units used for a given product.

unit_of_measure
str

The unit of measure used to bill for the product. For example, compute services are billed per hour.

unit_type
str

The description for the unit of measure for a given product.

special_taxation_type

Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. Known values are: "SubtotalLevel" and "InvoiceLevel".

refund_transaction_details

The refund details of a transaction.