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 custos de utilização do Azure.

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

Parâmetros do URI

Name Em Necessário Tipo Description
billingAccountName
 path True

string

O ID que identifica exclusivamente uma conta de faturação.
invoiceName
 path True

string

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

string

A versão da API a utilizar com o pedido de cliente. A versão atual é 2020-05-01.

Respostas

Name Tipo Description
200 OK

TransactionListResult

OK. O pedido foi bem-sucedido.
Other Status Codes

ErrorResponse

Resposta de erro que descreve a razão pela qual 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

Name Description
user_impersonation representar a sua conta de utilizador

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

Name Description
Amount

O montante.
ErrorDetails

Os detalhes do erro.
ErrorResponse

A resposta a erros indica que o serviço não consegue processar o pedido recebido. 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 reserva.

Amount

O montante.

Name Tipo Description
currency

string

A moeda do valor de montante.
value

number

Valor de montante.

ErrorDetails

Os detalhes do erro.

Name Tipo Description
code

string

Código de erro.
details

ErrorSubDetails[]

Os subdiretores do erro.
message

string

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

string

O destino do erro específico.

ErrorResponse

A resposta a erros indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Name Tipo Description
error

ErrorDetails

Os detalhes do erro.

ErrorSubDetails

Name Tipo Description
code

string

Código de erro.
message

string

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

string

O destino do erro específico.

ReservationType

O tipo de transação.

Name Tipo Description
Purchase

string

Usage Charge

string

Transaction

Uma transação.

Name Tipo Description
id

string

ID do Recurso.
name

string

Nome do recurso.
properties.azureCreditApplied

Amount

A quantidade de créditos do Azure aplicados automaticamente a esta transação.
properties.azurePlan

string

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

string

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

string

O nome do perfil de faturação que será faturado para a transação.
properties.billingProfileId

string

O ID do perfil de faturação que será faturado para a transação.
properties.customerDisplayName

string

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

string

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

string

A data da transação.
properties.discount

number

O desconto de percentagem, se existir, aplicado a esta transação.
properties.effectivePrice

Amount

O preço do produto depois de aplicar quaisquer descontos.
properties.exchangeRate

number

A taxa de câmbio utilizada para converter o montante cobrado em moeda de faturação, se aplicável.
properties.invoice

string

Fatura em que a transação foi faturada ou "pendente" se a transação não for faturada.
properties.invoiceId

string

O ID da fatura na qual a transação foi faturada. Este campo só é aplicável às transações que são faturadas.
properties.invoiceSectionDisplayName

string

O nome da secção da fatura que será faturada para a transação.
properties.invoiceSectionId

string

O ID da secção da fatura que será faturado para a transação.
properties.kind

TransactionTypeKind

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

Amount

O preço de venda a retalho do produto.
properties.orderId

string

O ID da encomenda da reserva. O campo só é aplicável para a transação de reserva de tipo.
properties.orderName

string

O nome da encomenda de reserva. O campo só é aplicável para transações de tipo de reserva.
properties.pricingCurrency

string

O código ISO 4217 para a moeda em que o produto tem um preço.
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 de produto para o qual a transação ocorreu.
properties.productTypeId

string

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

integer

A quantidade comprada na transação.
properties.servicePeriodEndDate

string

A data de fim do termo do produto ou a data de fim do mês em que a utilização terminou.
properties.servicePeriodStartDate

string

A data da compra do produto ou a data de início do mês em que a utilização foi iniciada.
properties.subTotal

Amount

O montante cobrado antes de impostos para a transação.
properties.subscriptionId

string

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

string

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

Amount

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

Amount

O custo associado à transação.
properties.transactionType

ReservationType

O tipo de transação.
properties.unitOfMeasure

string

A unidade de medida utilizada para faturar o produto. Por exemplo, os serviços de computação são faturados à hora.
properties.unitType

string

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

number

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

string

Tipo de recurso.

TransactionListResult

A lista de transações.

Name Tipo Description
nextLink

string

A ligação (URL) para a página seguinte dos resultados.
totalCount

number

Número total de registos.
value

Transaction[]

A lista de transações.

TransactionTypeKind

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

Name Tipo Description
all

string

reservation

string