Transactions - List By Invoice
Lista as transações de uma fatura. As transações incluem compras, reembolsos e encargos de uso do Azure.
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/transactions?api-version=2024-04-01
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}
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
billing
|
path | True |
string |
A ID que identifica exclusivamente uma conta de cobrança. Padrão Regex: |
invoice
|
path | True |
string |
A ID que identifica exclusivamente uma fatura. Padrão Regex: |
api-version
|
query | True |
string |
A versão da API a ser usada com a solicitação do cliente. A versão atual é 2024-04-01. |
count
|
query |
boolean |
A opção de consulta count permite que os clientes solicitem uma contagem dos recursos correspondentes incluídos com os recursos na resposta. |
|
filter
|
query |
string |
A opção de consulta de filtro permite que os clientes filtrem uma coleção de recursos que são endereçados por uma URL de solicitação. |
|
order
|
query |
string |
A opção orderby query permite que os clientes solicitem recursos em uma ordem específica. |
|
search
|
query |
string |
A opção de consulta de pesquisa permite que os clientes solicitem itens em uma coleção que corresponda a uma expressão de pesquisa de texto livre. A pesquisa só tem suporte para campos de cadeia de caracteres. |
|
skip
|
query |
integer int64 |
A opção ignorar consulta solicita o número de itens na coleção consultada que devem ser ignorados e não incluídos no resultado. |
|
top
|
query |
integer int64 |
A opção de consulta superior solicita que o número de itens na coleção consultada seja incluído no resultado. O valor máximo com suporte para a parte superior é 50. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
A lista de transações. |
|
Other Status Codes |
Resposta de erro que descreve por que a operação falhou. |
Exemplos
TransactionsListByInvoice
Solicitação de exemplo
Resposta de exemplo
{
"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"
}
]
}
Definições
Nome | Description |
---|---|
Amount |
O valor reembolsado. |
Amount |
O valor do reembolso solicitado. |
Azure |
O valor de todos os créditos do Azure aplicados automaticamente a essa transação. |
Consumption |
A quantidade de diminuição do MACC (Compromisso de Consumo) do Microsoft Azure por meio da transação. |
created |
O tipo de identidade que criou o recurso. |
Credit |
O tipo de crédito da transação. Aplica-se somente a transações creditadas. |
Effective |
O preço do produto após a aplicação de descontos. |
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta de erro |
Market |
O preço de varejo do produto. |
Refund |
Os detalhes de reembolso de uma transação. |
Special |
Identifica o tipo de cálculo de imposto usado para a fatura. O campo é aplicável somente a faturas com lógica de cálculo de imposto especial. |
Sub |
O valor cobrado previamente pela transação. |
system |
Metadados relativos à criação e última modificação do recurso. |
Tax |
O valor do imposto aplicado à transação. |
Transaction |
Uma transação. |
Transaction |
O encargo associado à transação. |
Transaction |
Tipo da transação, cobrada ou não faturada. |
Transaction |
Um contêiner para uma lista de recursos |
Transaction |
Uma transação. |
AmountRefunded
O valor reembolsado.
Nome | Tipo | Description |
---|---|---|
currency |
string |
A moeda do valor do valor. |
value |
number |
O valor da quantidade. Por exemplo, se a moeda for USD, um valor de 600 seria US$ 600,00. |
AmountRequested
O valor do reembolso solicitado.
Nome | Tipo | Description |
---|---|---|
currency |
string |
A moeda do valor do valor. |
value |
number |
O valor da quantidade. Por exemplo, se a moeda for USD, um valor de 600 seria US$ 600,00. |
AzureCreditApplied
O valor de todos os créditos do Azure aplicados automaticamente a essa transação.
Nome | Tipo | Description |
---|---|---|
currency |
string |
A moeda do valor do valor. |
value |
number |
O valor da quantidade. Por exemplo, se a moeda for USD, um valor de 600 seria US$ 600,00. |
ConsumptionCommitmentDecremented
A quantidade de diminuição do MACC (Compromisso de Consumo) do Microsoft Azure por meio da transação.
Nome | Tipo | Description |
---|---|---|
currency |
string |
A moeda do valor do valor. |
value |
number |
O valor da quantidade. Por exemplo, se a moeda for USD, um valor de 600 seria US$ 600,00. |
createdByType
O tipo de identidade que criou o recurso.
Nome | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CreditType
O tipo de crédito da transação. Aplica-se somente a transações creditadas.
Nome | Tipo | Description |
---|---|---|
AzureCreditOffer |
string |
|
AzureFreeCredit |
string |
|
Other |
string |
|
Refund |
string |
|
ServiceInterruption |
string |
EffectivePrice
O preço do produto após a aplicação de descontos.
Nome | Tipo | Description |
---|---|---|
currency |
string |
A moeda do valor do valor. |
value |
number |
O valor da quantidade. Por exemplo, se a moeda for USD, um valor de 600 seria US$ 600,00. |
ErrorAdditionalInfo
As informações adicionais do erro de gerenciamento de recursos.
Nome | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
Nome | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
Nome | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
MarketPrice
O preço de varejo do produto.
Nome | Tipo | Description |
---|---|---|
currency |
string |
A moeda do valor do valor. |
value |
number |
O valor da quantidade. Por exemplo, se a moeda for USD, um valor de 600 seria US$ 600,00. |
RefundTransactionDetails
Os detalhes de reembolso de uma transação.
Nome | Tipo | Description |
---|---|---|
amountRefunded |
O valor reembolsado. |
|
amountRequested |
O valor do reembolso solicitado. |
|
refundOperationId |
string |
A ID da operação de reembolso. |
SpecialTaxationType
Identifica o tipo de cálculo de imposto usado para a fatura. O campo é aplicável somente a faturas com lógica de cálculo de imposto especial.
Nome | Tipo | Description |
---|---|---|
InvoiceLevel |
string |
|
SubtotalLevel |
string |
SubTotal
O valor cobrado previamente pela transação.
Nome | Tipo | Description |
---|---|---|
currency |
string |
A moeda do valor do valor. |
value |
number |
O valor da quantidade. Por exemplo, se a moeda for USD, um valor de 600 seria US$ 600,00. |
systemData
Metadados relativos à criação e última modificação do recurso.
Nome | Tipo | Description |
---|---|---|
createdAt |
string |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
createdByType |
O tipo de identidade que criou o recurso. |
|
lastModifiedAt |
string |
O carimbo de data/hora da última modificação do recurso (UTC) |
lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |
Tax
O valor do imposto aplicado à transação.
Nome | Tipo | Description |
---|---|---|
currency |
string |
A moeda do valor do valor. |
value |
number |
O valor da quantidade. Por exemplo, se a moeda for USD, um valor de 600 seria US$ 600,00. |
Transaction
Uma transação.
Nome | Tipo | Description |
---|---|---|
id |
string |
ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
O nome do recurso |
properties |
Uma transação. |
|
systemData |
Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy. |
|
tags |
object |
Dicionário de metadados associados ao recurso. Ele pode não ser preenchido para todos os tipos de recursos. Comprimento máximo de chave/valor com suporte de 256 caracteres. Chaves/valor não devem esvaziar valor nem nulo. As chaves não podem conter <> % & \ ? / |
type |
string |
O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
TransactionAmount
O encargo associado à transação.
Nome | Tipo | Description |
---|---|---|
currency |
string |
A moeda do valor do valor. |
value |
number |
O valor da quantidade. Por exemplo, se a moeda for USD, um valor de 600 seria US$ 600,00. |
TransactionKind
Tipo da transação, cobrada ou não faturada.
Nome | Tipo | Description |
---|---|---|
All |
string |
|
Other |
string |
|
Reservation |
string |
TransactionListResult
Um contêiner para uma lista de recursos
Nome | Tipo | Description |
---|---|---|
nextLink |
string |
O link (url) para a próxima página de resultados. |
value |
A lista de recursos. |
TransactionProperties
Uma transação.
Nome | Tipo | Description |
---|---|---|
azureCreditApplied |
O valor de todos os créditos do Azure aplicados automaticamente a essa transação. |
|
azurePlan |
string |
Detalhes do plano do Azure. |
billingCurrency |
string |
O código ISO 4217 para a moeda na qual essa transação é cobrada. |
billingProfileDisplayName |
O nome do perfil de cobrança. |
|
billingProfileId |
string |
A ID totalmente qualificada que identifica exclusivamente um perfil de cobrança. |
consumptionCommitmentDecremented |
A quantidade de diminuição do MACC (Compromisso de Consumo) do Microsoft Azure por meio da transação. |
|
creditType |
O tipo de crédito da transação. Aplica-se somente a transações creditadas. |
|
customerDisplayName |
string |
O nome do cliente. |
customerId |
string |
A ID totalmente qualificada que identifica exclusivamente um cliente. |
date |
string |
A data da transação. |
discount |
number |
O desconto percentual, se houver, aplicado a essa transação. |
effectivePrice |
O preço do produto após a aplicação de descontos. |
|
exchangeRate |
number |
A taxa de câmbio usada para converter o valor cobrado em moeda de cobrança, se aplicável. |
invoice |
string |
Nome da fatura no qual a transação foi cobrada ou 'Pendente' se a transação não for cobrada. |
invoiceId |
string |
A ID totalmente qualificada da fatura na qual a transação foi cobrada. Esse campo só é aplicável para transações cobradas. |
invoiceSectionDisplayName |
string |
O nome da seção da fatura. |
invoiceSectionId |
string |
A ID totalmente qualificada que identifica exclusivamente uma seção de fatura. |
isThirdParty |
boolean |
Se a transação é de terceiros ou não. |
kind |
Tipo da transação, cobrada ou não faturada. |
|
marketPrice |
O preço de varejo do produto. |
|
partNumber |
string |
O número de parte do produto para o qual a transação ocorreu. O campo só é aplicável para faturas do Contrato Enterprise. |
pricingCurrency |
string |
O código ISO 4217 para a moeda na qual o produto é precificado. |
productDescription |
string |
A descrição do produto para o qual a transação ocorreu. |
productFamily |
string |
A família do produto para o qual a transação ocorreu. |
productType |
string |
O tipo do produto para o qual a transação ocorreu. |
productTypeId |
string |
A ID do tipo de produto para o qual a transação ocorreu. |
quantity |
integer |
A quantidade comprada na transação. |
reasonCode |
string |
Há um código de motivo para a transação. |
refundTransactionDetails |
Os detalhes de reembolso de uma transação. |
|
servicePeriodEndDate |
string |
A data de término do termo do produto ou a data de término do mês em que o uso terminou. |
servicePeriodStartDate |
string |
A data da compra do produto ou a data de início do mês em que o uso foi iniciado. |
specialTaxationType |
Identifica o tipo de cálculo de imposto usado para a fatura. O campo é aplicável somente a faturas com lógica de cálculo de imposto especial. |
|
subTotal |
O valor cobrado previamente pela transação. |
|
tax |
O valor do imposto aplicado à transação. |
|
transactionAmount |
O encargo associado à transação. |
|
transactionType |
string |
O tipo de transação. |
unitOfMeasure |
string |
A unidade de medida usada para cobrar pelo produto. Por exemplo, os serviços de computação são cobrados por hora. |
unitType |
string |
A descrição da unidade de medida para um determinado produto. |
units |
number |
O número de unidades usadas para um determinado produto. |