Invoices - Get By Billing Account

Serviço:

Billing

Versão da API:

2024-04-01

Obtém uma fatura cobrando o nome e a ID da conta. A operação tem suporte para contas de cobrança com o tipo de contrato Microsoft Partner Agreement ou Contrato de Cliente da Microsoft.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}?api-version=2024-04-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. 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	A 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.

Respostas

Nome	Tipo	Description
200 OK	Invoice	A lista de faturas.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Exemplos

InvoicesGetByBillingAccount

Solicitação de exemplo

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?api-version=2024-04-01

Resposta de exemplo

Código de status:

200

{
  "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",
    "specialTaxationType": "SubtotalLevel",
    "subTotal": {
      "currency": "USD",
      "value": 33.99
    },
    "taxAmount": {
      "currency": "USD",
      "value": 1
    },
    "totalAmount": {
      "currency": "USD",
      "value": 7.53
    }
  },
  "type": "Microsoft.Billing/billingAccounts/invoices"
}

Definições

Nome	Description
Amount	O valor.
AmountDue	O valor devido a partir de agora.
AmountRefunded	O valor reembolsado.
AmountRequested	O valor do reembolso solicitado.
AzurePrepaymentApplied	A quantidade de pagamento antecipado do Azure aplicada aos encargos. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.
BilledAmount	O total de encargos para o período de cobrança da fatura.
createdByType	O tipo de identidade que criou o recurso.
CreditAmount	O reembolso total de retornos e cancelamentos durante o período de cobrança da fatura. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.
DocumentSource	A origem do documento. ENF para Brasil e DRS para o resto do mundo.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
FailedPayment	Um pagamento com falha.
FailedPaymentReason	O motivo pelo qual o pagamento falhou.
FreeAzureCreditApplied	A quantidade de créditos gratuitos do Azure aplicados aos encargos. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.
Invoice	Uma fatura.
InvoiceDocument	As propriedades de um documento.
InvoiceDocumentType	O tipo do documento.
InvoiceProperties	Uma fatura.
InvoiceStatus	O status atual da fatura.
InvoiceType	Tipo de fatura.
Payment	Um pagamento de fatura.
PaymentMethodFamily	A família da forma de pagamento.
RebillDetails	Os detalhes de rebill de uma fatura.
RefundDetails	Os detalhes de uma solicitação de reembolso.
RefundReasonCode	O motivo do reembolso.
RefundStatus	O status da solicitaçã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.
SubTotal	O valor pré-imposto devido. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.
systemData	Metadados relativos à criação e última modificação do recurso.
TaxAmount	O valor do imposto cobrado pelo período de cobrança. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.
TotalAmount	O valor devido quando a fatura foi gerada. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.

Amount

O valor.

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.

AmountDue

O valor devido a partir de agora.

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.

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.

AzurePrepaymentApplied

A quantidade de pagamento antecipado do Azure aplicada aos encargos. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.

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.

BilledAmount

O total de encargos para o período de cobrança da fatura.

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

CreditAmount

O reembolso total de retornos e cancelamentos durante o período de cobrança da fatura. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.

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.

DocumentSource

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

Nome	Tipo	Description
DRS	string
ENF	string
Other	string

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	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

FailedPayment

Um pagamento com falha.

Nome	Tipo	Description
date	string	A data em que o pagamento foi tentado.
failedPaymentReason	FailedPaymentReason	O motivo pelo qual o pagamento falhou.

FailedPaymentReason

O motivo pelo qual o pagamento falhou.

Nome	Tipo	Description
BankDeclined	string
CardExpired	string
IncorrectCardDetails	string
Other	string

FreeAzureCreditApplied

A quantidade de créditos gratuitos do Azure aplicados aos encargos. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.

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.

Invoice

Uma fatura.

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

InvoiceDocument

As propriedades de um documento.

Nome	Tipo	Description
documentNumbers	string[]	Os números do documento do documento da fatura.
externalUrl	string	A URL para baixar o documento da fatura se a origem for externa ao Microsoft.Billing.
kind	InvoiceDocumentType	O tipo do documento.
name	string	A ID que identifica exclusivamente um documento de fatura. Essa ID pode ser um identificador para um PDF de fatura, uma anotação de crédito ou um recibo de imposto.
source	DocumentSource	A origem do documento. ENF para Brasil e DRS para o resto do mundo.
url	string	A URL para baixar o documento da fatura se a origem for interna para Microsoft.Billing.

InvoiceDocumentType

O tipo do documento.

Nome	Tipo	Description
CreditNote	string
Invoice	string
Other	string
Summary	string
TaxReceipt	string
Transactions	string
VoidNote	string

InvoiceProperties

Uma fatura.

Nome	Tipo	Description
amountDue	AmountDue	O valor devido a partir de agora.
azurePrepaymentApplied	AzurePrepaymentApplied	A quantidade de pagamento antecipado do Azure aplicada aos encargos. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.
billedAmount	BilledAmount	O total de encargos para o período de cobrança da fatura.
billedDocumentId	string	A ID da fatura ativa que é cobrada originalmente depois que essa fatura foi anulada. Esse campo é aplicável somente às faturas nulas.
billingProfileDisplayName	string	O nome do perfil de cobrança para o qual a fatura é gerada.
billingProfileId	string	A ID do perfil de cobrança para o qual a fatura é gerada.
creditAmount	CreditAmount	O reembolso total de retornos e cancelamentos durante o período de cobrança da fatura. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.
creditForDocumentId	string	A ID da fatura que foi anulada e essa nota de crédito foi emitida como resultado. Esse campo é aplicável somente às notas de crédito.
documentType	InvoiceDocumentType	O tipo do documento.
documents	InvoiceDocument[]	Lista de documentos disponíveis para download e exibição, como fatura, anotação de crédito ou recibo de imposto.
dueDate	string	A data de conclusão da fatura.
failedPayments	FailedPayment[]	Lista de pagamentos com falha.
freeAzureCreditApplied	FreeAzureCreditApplied	A quantidade de créditos gratuitos do Azure aplicados aos encargos. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.
invoiceDate	string	A data em que a fatura foi gerada.
invoicePeriodEndDate	string	A data de término do período de cobrança para o qual a fatura é gerada. A data está no formato MM-DD-YYYY.
invoicePeriodStartDate	string	A data de início do período de cobrança para o qual a fatura é gerada. A data está no 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. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.
payments	Payment[]	Lista de pagamentos.
purchaseOrderNumber	string	Um número de pedido de compra opcional para a fatura.
rebillDetails	RebillDetails	Rebillar detalhes de uma fatura.
refundDetails	RefundDetails	Os detalhes de uma solicitação de reembolso.
specialTaxationType	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.
status	InvoiceStatus	O status atual da fatura.
subTotal	SubTotal	O valor pré-imposto devido. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.
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 pelo período de cobrança. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.
totalAmount	TotalAmount	O valor devido quando a fatura foi gerada. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.

InvoiceStatus

O status atual da fatura.

Nome	Tipo	Description
Due	string
Locked	string
Other	string
OverDue	string
Paid	string
Void	string

InvoiceType

Tipo de fatura.

Nome	Tipo	Description
AzureMarketplace	string
AzureServices	string
AzureSupport	string
Other	string

Payment

Um pagamento de fatura.

Nome	Tipo	Description
amount	Amount	O valor pago.
date	string	A data em que o pagamento foi feito.
paymentMethodFamily	PaymentMethodFamily	A família da forma de pagamento.
paymentMethodId	string	A ID que identifica exclusivamente a forma de pagamento usada para a fatura.
paymentMethodType	string	O tipo de forma de pagamento.
paymentType	string	O tipo de pagamento.

PaymentMethodFamily

A família da forma de pagamento.

Nome	Tipo	Description
CheckWire	string
CreditCard	string
Credits	string
DirectDebit	string
EWallet	string
None	string
Other	string
TaskOrder	string

RebillDetails

Os detalhes de rebill de uma fatura.

Nome	Tipo	Description
creditNoteDocumentId	string	A ID da nota de crédito.
invoiceDocumentId	string	A ID da fatura.
rebillDetails	RebillDetails	Os detalhes de rebill de uma fatura.

RefundDetails

Os detalhes de uma solicitação de reembolso.

Nome	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	A ID da fatura rebill para um reembolso.
refundOperationId	string	A ID da operação de reembolso.
refundReason	RefundReasonCode	O motivo do reembolso.
refundStatus	RefundStatus	O status da solicitação 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.

Nome	Tipo	Description
AccidentalConversion	string
AccidentalPurchase	string
ForgotToCancel	string
Other	string
UnclearDocumentation	string
UnclearPricing	string

RefundStatus

O status da solicitação de reembolso.

Nome	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 é aplicável somente a faturas com lógica de cálculo de imposto especial.

Nome	Tipo	Description
InvoiceLevel	string
SubtotalLevel	string

SubTotal

O valor pré-imposto devido. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.

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	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 pelo período de cobrança. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.

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.

TotalAmount

O valor devido quando a fatura foi gerada. Esse campo é aplicável a contas de cobrança com o tipo de contrato Microsoft Customer Agreement.

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.