Transactions - List By Invoice

Serviço:

Billing

Versão da API:

2024-04-01

Lista as transações de uma fatura. As transações incluem compras, reembolsos e encargos de utilização do Azure.

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

Com parâmetros opcionais:

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 do URI

Name	Em	Necessário	Tipo	Description
billingAccountName	path	True	string	O ID que identifica exclusivamente uma conta de cobrança. Padrão Regex: ^([0-9]+|([Pp][Cc][Nn]\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$
invoiceName	path	True	string	O ID que identifica exclusivamente uma fatura. Padrão Regex: ^(H[0-9]-[A-Z0-9]+)$|^(?:([GHT]|HT){1}[A-Z0-9]{9})$|^(?:[D]{1}[A-Z0-9]{9})$|^(?:E{1}[B-Z0-9]{1}[A-Z0-9]{8})$|^(?:EA[A-Z0-9]{8})$
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 de contagem 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.
orderBy	query		string	A opção de consulta orderby 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 dentro de uma coleção correspondente a uma expressão de pesquisa de texto livre. A pesquisa só é suportada 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 suportado para o topo é 50.

Respostas

Name	Tipo	Description
200 OK	TransactionListResult	A lista de transações.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Exemplos

TransactionsListByInvoice

Pedido de amostra

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789/transactions?api-version=2024-04-01

Resposta da amostra

Código de estado:

200

{
  "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

Name	Description
AmountRefunded	O valor reembolsado.
AmountRequested	O valor do reembolso solicitado.
AzureCreditApplied	O montante de quaisquer créditos do Azure aplicados automaticamente a esta transação.
ConsumptionCommitmentDecremented	O montante do Compromisso de Consumo do Microsoft Azure (MACC) diminuído através da transação.
createdByType	O tipo de identidade que criou o recurso.
CreditType	O tipo de crédito da operação. Aplica-se apenas a transações creditadas.
EffectivePrice	O preço do produto após a aplicação de quaisquer descontos.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
MarketPrice	O preço de venda ao público do produto.
RefundTransactionDetails	Os detalhes de reembolso de uma transação.
SpecialTaxationType	Identifica o tipo de cálculo de imposto usado para a fatura. O campo aplica-se apenas a faturas com lógica especial de cálculo de imposto.
SubTotal	O valor cobrado antes de impostos pela transação.
systemData	Metadados referentes à criação e última modificação do recurso.
Tax	O valor do imposto aplicado à transação.
Transaction	Uma transação.
TransactionAmount	O encargo associado à transação.
TransactionKind	Tipo de transação, faturada ou não faturada.
TransactionListResult	Um contêiner para uma lista de recursos
TransactionProperties	Uma transação.

AmountRefunded

O valor reembolsado.

Name	Tipo	Description
currency	string	A moeda para o valor do montante.
value	number	O valor do montante. Por exemplo, se a moeda for USD, então um valor de 600 seria $600,00.

AmountRequested

O valor do reembolso solicitado.

Name	Tipo	Description
currency	string	A moeda para o valor do montante.
value	number	O valor do montante. Por exemplo, se a moeda for USD, então um valor de 600 seria $600,00.

AzureCreditApplied

O montante de quaisquer créditos do Azure aplicados automaticamente a esta transação.

Name	Tipo	Description
currency	string	A moeda para o valor do montante.
value	number	O valor do montante. Por exemplo, se a moeda for USD, então um valor de 600 seria $600,00.

ConsumptionCommitmentDecremented

O montante do Compromisso de Consumo do Microsoft Azure (MACC) diminuído através da transação.

Name	Tipo	Description
currency	string	A moeda para o valor do montante.
value	number	O valor do montante. Por exemplo, se a moeda for USD, então um valor de 600 seria $600,00.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreditType

O tipo de crédito da operação. Aplica-se apenas a transações creditadas.

Name	Tipo	Description
AzureCreditOffer	string
AzureFreeCredit	string
Other	string
Refund	string
ServiceInterruption	string

EffectivePrice

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

Name	Tipo	Description
currency	string	A moeda para o valor do montante.
value	number	O valor do montante. Por exemplo, se a moeda for USD, então um valor de 600 seria $600,00.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

MarketPrice

O preço de venda ao público do produto.

Name	Tipo	Description
currency	string	A moeda para o valor do montante.
value	number	O valor do montante. Por exemplo, se a moeda for USD, então um valor de 600 seria $600,00.

RefundTransactionDetails

Os detalhes de reembolso de uma transação.

Name	Tipo	Description
amountRefunded	AmountRefunded	O valor reembolsado.
amountRequested	AmountRequested	O valor do reembolso solicitado.
refundOperationId	string	O ID da operação de reembolso.

SpecialTaxationType

Identifica o tipo de cálculo de imposto usado para a fatura. O campo aplica-se apenas a faturas com lógica especial de cálculo de imposto.

Name	Tipo	Description
InvoiceLevel	string
SubtotalLevel	string

SubTotal

O valor cobrado antes de impostos pela transação.

Name	Tipo	Description
currency	string	A moeda para o valor do montante.
value	number	O valor do montante. Por exemplo, se a moeda for USD, então um valor de 600 seria $600,00.

systemData

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	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	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Tax

O valor do imposto aplicado à transação.

Name	Tipo	Description
currency	string	A moeda para o valor do montante.
value	number	O valor do montante. Por exemplo, se a moeda for USD, então um valor de 600 seria $600,00.

Transaction

Uma transação.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties	TransactionProperties	Uma transação.
systemData	systemData	Metadados do Azure Resource Manager contendo 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 suportado 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.

Name	Tipo	Description
currency	string	A moeda para o valor do montante.
value	number	O valor do montante. Por exemplo, se a moeda for USD, então um valor de 600 seria $600,00.

TransactionKind

Tipo de transação, faturada ou não faturada.

Name	Tipo	Description
All	string
Other	string
Reservation	string

TransactionListResult

Um contêiner para uma lista de recursos

Name	Tipo	Description
nextLink	string	O link (url) para a próxima página de resultados.
value	Transaction[]	A lista de recursos.

TransactionProperties

Uma transação.

Name	Tipo	Description
azureCreditApplied	AzureCreditApplied	O montante de quaisquer créditos do Azure aplicados automaticamente a esta transação.
azurePlan	string	Detalhes do plano do Azure.
billingCurrency	string	O código ISO 4217 para a moeda na qual esta transação é faturada.
billingProfileDisplayName		O nome do perfil de cobrança.
billingProfileId	string	O ID totalmente qualificado que identifica exclusivamente um perfil de faturamento.
consumptionCommitmentDecremented	ConsumptionCommitmentDecremented	O montante do Compromisso de Consumo do Microsoft Azure (MACC) diminuído através da transação.
creditType	CreditType	O tipo de crédito da operação. Aplica-se apenas a transações creditadas.
customerDisplayName	string	O nome do cliente.
customerId	string	O ID totalmente qualificado que identifica exclusivamente um cliente.
date	string	A data da transação.
discount	number	O desconto percentual, se houver, aplicado a esta transação.
effectivePrice	EffectivePrice	O preço do produto após a aplicação de quaisquer 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 na qual a transação foi faturada ou 'Pendente' se a transação não for faturada.
invoiceId	string	O ID totalmente qualificado da fatura na qual a transação foi faturada. Este campo só é aplicável às transações faturadas.
invoiceSectionDisplayName	string	O nome da seção da fatura.
invoiceSectionId	string	O ID totalmente qualificado que identifica exclusivamente uma seção de fatura.
isThirdParty	boolean	Se a transação é ou não de terceiros.
kind	TransactionKind	Tipo de transação, faturada ou não faturada.
marketPrice	MarketPrice	O preço de venda ao público do produto.
partNumber	string	O número da peça do produto para o qual a transação ocorreu. O campo só é aplicável a faturas do Enterprise Agreement.
pricingCurrency	string	O código ISO 4217 para a moeda em que 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 de 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á código de razão para a transação.
refundTransactionDetails	RefundTransactionDetails	Os detalhes de reembolso de uma transação.
servicePeriodEndDate	string	A data final do termo do produto ou a data final 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 começou.
specialTaxationType	SpecialTaxationType	Identifica o tipo de cálculo de imposto usado para a fatura. O campo aplica-se apenas a faturas com lógica especial de cálculo de imposto.
subTotal	SubTotal	O valor cobrado antes de impostos pela transação.
tax	Tax	O valor do imposto aplicado à transação.
transactionAmount	TransactionAmount	O encargo associado à transação.
transactionType	string	O tipo de transação.
unitOfMeasure	string	A unidade de medida utilizada para faturar o produto. Por exemplo, os serviços de computação são cobrados por hora.
unitType	string	A descrição da unidade de medida de um determinado produto.
units	number	O número de unidades utilizadas para um determinado produto.