Partilhar via

Invoices - List By Billing Profile

  • Referência
Serviço:
Billing
Versão da API:
2024-04-01

Lista as faturas de um perfil de faturamento para uma determinada data de início e de término. A operação é suportada para contas de cobrança com tipo de contrato Contrato de Parceiro Microsoft ou Contrato de Cliente Microsoft.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices?api-version=2024-04-01
Com parâmetros opcionais: 
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices?periodStartDate={periodStartDate}&periodEndDate={periodEndDate}&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})?)$
billingProfileName
 path True

string

O ID que identifica exclusivamente um perfil de faturamento.

Padrão Regex: ^[a-zA-Z\d-_]{1,128}$
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.
periodEndDate
 query

string

date

A data final do período de faturamento para o qual a fatura é gerada. A data está em formato MM-DD-YYYY.
periodStartDate
 query

string

date

A data de início do período de faturamento para o qual a fatura é gerada. A data está em formato MM-DD-YYYY.
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

InvoiceListResult

A lista de faturas.
Other Status Codes

ErrorResponse

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

Exemplos

InvoicesListByBillingProfile

Pedido de amostra

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoices?periodStartDate=2023-01-01&periodEndDate=2023-06-30&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/invoices/G123456789",
      "name": "G123456789",
      "properties": {
        "amountDue": {
          "currency": "USD",
          "value": 8.53
        },
        "azurePrepaymentApplied": {
          "currency": "USD",
          "value": 25.46
        },
        "billedAmount": {
          "currency": "USD",
          "value": 33.99
        },
        "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",
        "creditAmount": {
          "currency": "USD",
          "value": 0
        },
        "documents": [
          {
            "kind": "Invoice",
            "name": "12345678"
          },
          {
            "kind": "TaxReceipt",
            "name": "22345678"
          }
        ],
        "documentType": "Invoice",
        "dueDate": "2023-02-16T17:32:28Z",
        "freeAzureCreditApplied": {
          "currency": "USD",
          "value": 0
        },
        "invoiceDate": "2023-02-01T17:32:28Z",
        "invoicePeriodEndDate": "2023-02-15T17:32:28Z",
        "invoicePeriodStartDate": "2023-02-01T17:32:28Z",
        "isMonthlyInvoice": false,
        "purchaseOrderNumber": "123456",
        "rebillDetails": {
          "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002",
          "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2",
          "rebillDetails": {
            "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001",
            "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote"
          }
        },
        "status": "Due",
        "subTotal": {
          "currency": "USD",
          "value": 33.99
        },
        "taxAmount": {
          "currency": "USD",
          "value": 1
        },
        "totalAmount": {
          "currency": "USD",
          "value": 7.53
        }
      },
      "type": "Microsoft.Billing/billingAccounts/invoices"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321",
      "name": "G987654321",
      "properties": {
        "amountDue": {
          "currency": "USD",
          "value": 0
        },
        "azurePrepaymentApplied": {
          "currency": "USD",
          "value": 25.46
        },
        "billedAmount": {
          "currency": "USD",
          "value": 33.99
        },
        "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",
        "creditAmount": {
          "currency": "USD",
          "value": 0
        },
        "documents": [
          {
            "kind": "Invoice",
            "name": "12345678"
          },
          {
            "kind": "TaxReceipt",
            "name": "22345678"
          }
        ],
        "documentType": "Invoice",
        "dueDate": "2023-01-16T17:32:28Z",
        "freeAzureCreditApplied": {
          "currency": "USD",
          "value": 0
        },
        "invoiceDate": "2023-01-01T17:32:28Z",
        "invoicePeriodEndDate": "2023-01-15T17:32:28Z",
        "invoicePeriodStartDate": "2023-01-01T17:32:28Z",
        "isMonthlyInvoice": false,
        "payments": [
          {
            "amount": {
              "currency": "USD",
              "value": 33.99
            },
            "date": "2023-01-14T17:32:28Z",
            "paymentMethodFamily": "CreditCard",
            "paymentMethodType": "visa",
            "paymentType": "debited"
          }
        ],
        "purchaseOrderNumber": "123455",
        "rebillDetails": {
          "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000002",
          "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote2",
          "rebillDetails": {
            "invoiceDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/I000001",
            "creditNoteDocumentId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/CreditNote"
          }
        },
        "status": "Paid",
        "subTotal": {
          "currency": "USD",
          "value": 33.99
        },
        "taxAmount": {
          "currency": "USD",
          "value": 1
        },
        "totalAmount": {
          "currency": "USD",
          "value": 7.53
        }
      },
      "type": "Microsoft.Billing/billingAccounts/invoices"
    }
  ]
}

Definições

Name Description
Amount

O montante.
AmountDue

O montante devido a partir de agora.
AmountRefunded

O valor reembolsado.
AmountRequested

O valor do reembolso solicitado.
AzurePrepaymentApplied

O valor do pré-pagamento do Azure aplicado aos encargos. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.
BilledAmount

O total de encargos para o período de faturamento da fatura.
createdByType

O tipo de identidade que criou o recurso.
CreditAmount

O reembolso total para devoluções e cancelamentos durante o período de faturação da fatura. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.
DocumentSource

A fonte do documento. ENF para o Brasil e DRS para o resto do mundo.
ErrorAdditionalInfo

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

O detalhe do erro.
ErrorResponse

Resposta de erro
FailedPayment

Um pagamento falhado.
FailedPaymentReason

A razão pela qual o pagamento falhou.
FreeAzureCreditApplied

A quantidade de créditos gratuitos do Azure aplicados às cobranças. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.
Invoice

Uma fatura.
InvoiceDocument

As propriedades de um documento.
InvoiceDocumentType

O tipo do documento.
InvoiceListResult

Um contêiner para uma lista de recursos
InvoiceProperties

Uma fatura.
InvoiceStatus

O status atual da fatura.
InvoiceType

Tipo de fatura.
Payment

Um pagamento de fatura.
PaymentMethodFamily

A família do método de pagamento.
RebillDetails

Os detalhes de refaturação de uma fatura.
RefundDetails

Os detalhes de um pedido de reembolso.
RefundReasonCode

O motivo do reembolso.
RefundStatus

O status do pedido 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.
SubTotal

O montante antes de impostos devido. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.
systemData

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

O valor do imposto cobrado para o período de faturamento. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.
TotalAmount

O valor devido quando a fatura foi gerada. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.

Amount

O montante.

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.

AmountDue

O montante devido a partir de agora.

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.

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.

AzurePrepaymentApplied

O valor do pré-pagamento do Azure aplicado aos encargos. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.

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.

BilledAmount

O total de encargos para o período de faturamento da fatura.

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

CreditAmount

O reembolso total para devoluções e cancelamentos durante o período de faturação da fatura. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.

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.

DocumentSource

A fonte do documento. ENF para o Brasil e DRS para o resto do mundo.

Name Tipo Description
DRS

string

ENF

string

Other

string

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.

FailedPayment

Um pagamento falhado.

Name Tipo Description
date

string

A data em que o pagamento foi tentado.
failedPaymentReason

FailedPaymentReason

A razão pela qual o pagamento falhou.

FailedPaymentReason

A razão pela qual o pagamento falhou.

Name Tipo Description
BankDeclined

string

CardExpired

string

IncorrectCardDetails

string

Other

string

FreeAzureCreditApplied

A quantidade de créditos gratuitos do Azure aplicados às cobranças. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.

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.

Invoice

Uma fatura.

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

InvoiceProperties

Uma fatura.
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"

InvoiceDocument

As propriedades de um documento.

Name Tipo Description
documentNumbers

string[]

Os números de documento para o documento de fatura.
externalUrl

string

A URL para baixar o documento de fatura se a fonte for externa ao Microsoft.Billing.
kind

InvoiceDocumentType

O tipo do documento.
name

string

O ID que identifica exclusivamente um documento de fatura. Esse ID pode ser um identificador para um PDF de fatura, uma nota de crédito ou um recibo de imposto.
source

DocumentSource

A fonte do documento. ENF para o Brasil e DRS para o resto do mundo.
url

string

A URL para baixar o documento de fatura se a fonte for interna ao Microsoft.Billing.

InvoiceDocumentType

O tipo do documento.

Name Tipo Description
CreditNote

string

Invoice

string

Other

string

Summary

string

TaxReceipt

string

Transactions

string

VoidNote

string

InvoiceListResult

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

Invoice[]

A lista de recursos.

InvoiceProperties

Uma fatura.

Name Tipo Description
amountDue

AmountDue

O montante devido a partir de agora.
azurePrepaymentApplied

AzurePrepaymentApplied

O valor do pré-pagamento do Azure aplicado aos encargos. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.
billedAmount

BilledAmount

O total de encargos para o período de faturamento da fatura.
billedDocumentId

string

O ID da fatura ativa que é originalmente faturada após esta fatura ter sido anulada. Este campo aplica-se apenas às faturas anuladas.
billingProfileDisplayName

string

O nome do perfil de faturamento para o qual a fatura é gerada.
billingProfileId

string

A ID do perfil de faturamento para o qual a fatura é gerada.
creditAmount

CreditAmount

O reembolso total para devoluções e cancelamentos durante o período de faturação da fatura. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.
creditForDocumentId

string

O ID da fatura que foi anulada e esta nota de crédito foi emitida como resultado. Este campo aplica-se apenas às notas de crédito.
documentType

InvoiceDocumentType

O tipo do documento.
documents

InvoiceDocument[]

Lista de documentos disponíveis para download e visualização, como fatura, nota de crédito ou recibo de imposto.
dueDate

string

A data de vencimento da fatura.
failedPayments

FailedPayment[]

Lista de pagamentos falhados.
freeAzureCreditApplied

FreeAzureCreditApplied

A quantidade de créditos gratuitos do Azure aplicados às cobranças. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.
invoiceDate

string

A data em que a fatura foi gerada.
invoicePeriodEndDate

string

A data final do período de faturamento para o qual a fatura é gerada. A data está em formato MM-DD-YYYY.
invoicePeriodStartDate

string

A data de início do período de faturamento para o qual a fatura é gerada. A data está em formato MM-DD-YYYY.
invoiceType

InvoiceType

Tipo de fatura.
isMonthlyInvoice

boolean

Especifica se a fatura é gerada como parte do ciclo de faturamento mensal ou não. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.
payments

Payment[]

Lista de pagamentos.
purchaseOrderNumber

string

Um número de ordem de compra opcional para a fatura.
rebillDetails

RebillDetails

Refaturar os detalhes de uma fatura.
refundDetails

RefundDetails

Os detalhes de um pedido de reembolso.
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.
status

InvoiceStatus

O status atual da fatura.
subTotal

SubTotal

O montante antes de impostos devido. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.
subscriptionDisplayName

string

O nome da assinatura de cobrança para a qual a fatura é gerada.
subscriptionId

string

A ID da assinatura para a qual a fatura é gerada.
taxAmount

TaxAmount

O valor do imposto cobrado para o período de faturamento. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.
totalAmount

TotalAmount

O valor devido quando a fatura foi gerada. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.

InvoiceStatus

O status atual da fatura.

Name Tipo Description
Due

string

Locked

string

Other

string

OverDue

string

Paid

string

Void

string

InvoiceType

Tipo de fatura.

Name Tipo Description
AzureMarketplace

string

AzureServices

string

AzureSupport

string

Other

string

Payment

Um pagamento de fatura.

Name Tipo Description
amount

Amount

O valor pago.
date

string

A data em que o pagamento foi efetuado.
paymentMethodFamily

PaymentMethodFamily

A família do método de pagamento.
paymentMethodId

string

O ID que identifica exclusivamente o método de pagamento usado para a fatura.
paymentMethodType

string

O tipo de método de pagamento.
paymentType

string

O tipo de pagamento.

PaymentMethodFamily

A família do método de pagamento.

Name Tipo Description
CheckWire

string

CreditCard

string

Credits

string

DirectDebit

string

EWallet

string

None

string

Other

string

TaskOrder

string

RebillDetails

Os detalhes de refaturação de uma fatura.

Name Tipo Description
creditNoteDocumentId

string

O ID da nota de crédito.
invoiceDocumentId

string

O ID da fatura.
rebillDetails

RebillDetails

Os detalhes de refaturação de uma fatura.

RefundDetails

Os detalhes de um pedido de reembolso.

Name Tipo Description
amountRefunded

AmountRefunded

O valor reembolsado.
amountRequested

AmountRequested

O valor do reembolso solicitado.
approvedOn

string

Data em que o reembolso foi aprovado.
completedOn

string

Data em que o reembolso foi concluído.
rebillInvoiceId

string

O ID da fatura da fatura de refaturação para um reembolso.
refundOperationId

string

O ID da operação de reembolso.
refundReason

RefundReasonCode

O motivo do reembolso.
refundStatus

RefundStatus

O status do pedido de reembolso.
requestedOn

string

Data em que o reembolso foi solicitado.
transactionCount

integer

O número de transações reembolsadas.

RefundReasonCode

O motivo do reembolso.

Name Tipo Description
AccidentalConversion

string

AccidentalPurchase

string

ForgotToCancel

string

Other

string

UnclearDocumentation

string

UnclearPricing

string

RefundStatus

O status do pedido de reembolso.

Name Tipo Description
Approved

string

Cancelled

string

Completed

string

Declined

string

Expired

string

Other

string

Pending

string

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 montante antes de impostos devido. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.

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.

TaxAmount

O valor do imposto cobrado para o período de faturamento. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.

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.

TotalAmount

O valor devido quando a fatura foi gerada. Este campo é aplicável a contas de faturação com tipo de contrato Contrato de Cliente Microsoft.

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.