Transactions - List By Invoice

  • Referência
Service:
Billing
API Version:
2020-05-01

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=2020-05-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
billingAccountName
 path True

string

A ID que identifica exclusivamente uma conta de cobrança.
invoiceName
 path True

string

A ID que identifica exclusivamente uma fatura.
api-version
 query True

string

A versão da API a ser usada com a solicitação do cliente. A versão atual é 2020-05-01.

Respostas

Nome Tipo Description
200 OK

TransactionListResult

OK. A solicitação foi bem-sucedida.
Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

TransactionsListByInvoice

Sample Request

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

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

Definições

Nome Description
Amount

O valor.
ErrorDetails

Os detalhes do erro.
ErrorResponse

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.
ErrorSubDetails
ReservationType

O tipo de transação.
Transaction

Uma transação.
TransactionListResult

A lista de transações.
TransactionTypeKind

O tipo de transação. As opções são todas ou reservas.

Amount

O valor.

Nome Tipo Description
currency

string

A moeda do valor do valor.
value

number

Valor da quantidade.

ErrorDetails

Os detalhes do erro.

Nome Tipo Description
code

string

Código do erro.
details

ErrorSubDetails[]

Os sub-detalhes do erro.
message

string

Mensagem de erro indicando por que a operação falhou.
target

string

O destino do erro específico.

ErrorResponse

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Nome Tipo Description
error

ErrorDetails

Os detalhes do erro.

ErrorSubDetails

Nome Tipo Description
code

string

Código do erro.
message

string

Mensagem de erro indicando por que a operação falhou.
target

string

O destino do erro específico.

ReservationType

O tipo de transação.

Nome Tipo Description
Purchase

string

Usage Charge

string

Transaction

Uma transação.

Nome Tipo Description
id

string

ID do recurso.
name

string

Nome do recurso.
properties.azureCreditApplied

Amount

O valor de todos os créditos do Azure aplicados automaticamente a essa transação.
properties.azurePlan

string

O tipo de plano do azure da assinatura que foi usada para a transação.
properties.billingCurrency

string

O código ISO 4217 para a moeda na qual essa transação é cobrada.
properties.billingProfileDisplayName

string

O nome do perfil de cobrança que será cobrado pela transação.
properties.billingProfileId

string

A ID do perfil de cobrança que será cobrada pela transação.
properties.customerDisplayName

string

O nome do cliente para o qual a transação ocorreu. O campo é aplicável somente para Contrato de Parceiro da Microsoft conta de cobrança.
properties.customerId

string

A ID do cliente para o qual a transação ocorreu. O campo é aplicável somente para Contrato de Parceiro da Microsoft conta de cobrança.
properties.date

string

A data da transação.
properties.discount

number

O desconto percentual, se houver, aplicado a essa transação.
properties.effectivePrice

Amount

O preço do produto após a aplicação de descontos.
properties.exchangeRate

number

A taxa de câmbio usada para converter o valor cobrado em moeda de cobrança, se aplicável.
properties.invoice

string

Fatura na qual a transação foi cobrada ou 'pendente' se a transação não for cobrada.
properties.invoiceId

string

A ID da fatura na qual a transação foi cobrada. Esse campo só é aplicável a transações que são cobradas.
properties.invoiceSectionDisplayName

string

O nome da seção da fatura que será cobrada pela transação.
properties.invoiceSectionId

string

A ID da seção da fatura que será cobrada pela transação.
properties.kind

TransactionTypeKind

O tipo de transação. As opções são todas ou reservas.
properties.marketPrice

Amount

O preço de varejo do produto.
properties.orderId

string

A ID do pedido da reserva. O campo só é aplicável à transação de reserva de tipo.
properties.orderName

string

O nome do pedido de reserva. O campo só é aplicável a transações de reserva de tipo.
properties.pricingCurrency

string

O código ISO 4217 para a moeda na qual o produto é precificado.
properties.productDescription

string

A descrição do produto para o qual a transação ocorreu.
properties.productFamily

string

A família do produto para o qual a transação ocorreu.
properties.productType

string

O tipo do produto para o qual a transação ocorreu.
properties.productTypeId

string

A ID do tipo de produto para o qual a transação ocorreu.
properties.quantity

integer

A quantidade adquirida na transação.
properties.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.
properties.servicePeriodStartDate

string

A data da compra do produto ou a data de início do mês em que o uso foi iniciado.
properties.subTotal

Amount

O valor cobrado previamente pela transação.
properties.subscriptionId

string

A ID da assinatura que foi usada para a transação. O campo só é aplicável à transação de reserva de tipo.
properties.subscriptionName

string

O nome da assinatura que foi usada para a transação. O campo só é aplicável à transação de reserva de tipo.
properties.tax

Amount

O valor do imposto aplicado à transação.
properties.transactionAmount

Amount

A cobrança associada à transação.
properties.transactionType

ReservationType

O tipo de transação.
properties.unitOfMeasure

string

A unidade de medida usada para cobrar pelo produto. Por exemplo, os serviços de computação são cobrados por hora.
properties.unitType

string

A descrição da unidade de medida para um determinado produto.
properties.units

number

O número de unidades usadas para um determinado produto.
type

string

Tipo de recurso.

TransactionListResult

A lista de transações.

Nome Tipo Description
nextLink

string

O link (url) para a próxima página de resultados.
totalCount

number

Número total de registros.
value

Transaction[]

A lista de transações.

TransactionTypeKind

O tipo de transação. As opções são todas ou reservas.

Nome Tipo Description
all

string

reservation

string