Invoices - Get

Referencia

Servicio:: Billing

Versión de la API:: 2024-04-01

Obtiene una factura por identificador. La operación es compatible con todos los tipos de cuenta de facturación.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description

Nombre	En	Requerido	Tipo	Description
invoiceName	path	True	string	Identificador que identifica de forma única una factura. Patrón de 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	Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2024-04-01.

invoiceName

path

True

string

Identificador que identifica de forma única una factura.

Patrón de 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

Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2024-04-01.

Respuestas

Nombre	Tipo	Description
200 OK	Invoice	Una factura.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Ejemplos

InvoicesGet

Solicitud de ejemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/invoices/G123456789?api-version=2024-04-01

Respuesta de muestra

status code:: 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"
}

Definiciones

Nombre	Description
Amount	Cantidad.
AmountDue	Importe vencido a partir de ahora.
AmountRefunded	Importe devuelto.
AmountRequested	Cantidad de reembolso solicitada.
AzurePrepaymentApplied	El importe del prepago de Azure aplicado a los cargos. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
BilledAmount	Los cargos totales del período de facturación.
createdByType	Tipo de identidad que creó el recurso.
CreditAmount	Reembolso total de devoluciones y cancelaciones durante el período de facturación. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
DocumentSource	Origen del documento. ENF para Brasil y DRS para el resto del mundo.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
FailedPayment	Un pago erróneo.
FailedPaymentReason	Motivo por el que se produjo un error en el pago.
FreeAzureCreditApplied	Cantidad de créditos gratuitos de Azure aplicados a los cargos. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
Invoice	Una factura.
InvoiceDocument	Propiedades de un documento.
InvoiceDocumentType	Tipo del documento.
InvoiceProperties	Una factura.
InvoiceStatus	Estado actual de la factura.
InvoiceType	Tipo de factura.
Payment	Un pago de factura.
PaymentMethodFamily	Familia de métodos de pago.
RebillDetails	Detalles de la facturación de una factura.
RefundDetails	Detalles de una solicitud de reembolso.
RefundReasonCode	Motivo del reembolso.
RefundStatus	Estado de la solicitud de reembolso.
SpecialTaxationType	Identifica el tipo de cálculo fiscal utilizado para la factura. El campo solo es aplicable a las facturas con lógica de cálculo fiscal especial.
SubTotal	El importe de impuestos previos que se debe. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
systemData	Metadatos relativos a la creación y última modificación del recurso.
TaxAmount	El importe del impuesto que se cobra durante el período de facturación. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
TotalAmount	Importe vencido cuando se generó la factura. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.

Amount

Cantidad.

Nombre	Tipo	Description
currency	string	Moneda del valor de la cantidad.
value	number	Valor de la cantidad. Por ejemplo, si la moneda es USD, un valor de 600 sería $600.00.

AmountDue

Importe vencido a partir de ahora.

Nombre	Tipo	Description
currency	string	Moneda del valor de la cantidad.
value	number	Valor de la cantidad. Por ejemplo, si la moneda es USD, un valor de 600 sería $600.00.

AmountRefunded

Importe devuelto.

Nombre	Tipo	Description
currency	string	Moneda del valor de la cantidad.
value	number	Valor de la cantidad. Por ejemplo, si la moneda es USD, un valor de 600 sería $600.00.

AmountRequested

Cantidad de reembolso solicitada.

Nombre	Tipo	Description
currency	string	Moneda del valor de la cantidad.
value	number	Valor de la cantidad. Por ejemplo, si la moneda es USD, un valor de 600 sería $600.00.

AzurePrepaymentApplied

El importe del prepago de Azure aplicado a los cargos. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.

Nombre	Tipo	Description
currency	string	Moneda del valor de la cantidad.
value	number	Valor de la cantidad. Por ejemplo, si la moneda es USD, un valor de 600 sería $600.00.

BilledAmount

Los cargos totales del período de facturación.

Nombre	Tipo	Description
currency	string	Moneda del valor de la cantidad.
value	number	Valor de la cantidad. Por ejemplo, si la moneda es USD, un valor de 600 sería $600.00.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreditAmount

Reembolso total de devoluciones y cancelaciones durante el período de facturación. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.

Nombre	Tipo	Description
currency	string	Moneda del valor de la cantidad.
value	number	Valor de la cantidad. Por ejemplo, si la moneda es USD, un valor de 600 sería $600.00.

DocumentSource

Origen del documento. ENF para Brasil y DRS para el resto del mundo.

Nombre	Tipo	Description
DRS	string
ENF	string
Other	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

FailedPayment

Un pago erróneo.

Nombre	Tipo	Description
date	string	Fecha en que se intentó el pago.
failedPaymentReason	FailedPaymentReason	Motivo por el que se produjo un error en el pago.

FailedPaymentReason

Motivo por el que se produjo un error en el pago.

Nombre	Tipo	Description
BankDeclined	string
CardExpired	string
IncorrectCardDetails	string
Other	string

FreeAzureCreditApplied

Cantidad de créditos gratuitos de Azure aplicados a los cargos. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.

Nombre	Tipo	Description
currency	string	Moneda del valor de la cantidad.
value	number	Valor de la cantidad. Por ejemplo, si la moneda es USD, un valor de 600 sería $600.00.

Invoice

Una factura.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties	InvoiceProperties	Una factura.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object	Diccionario de metadatos asociados al recurso. Es posible que no se rellene para todos los tipos de recursos. Longitud máxima de clave/valor admitida de 256 caracteres. Las claves y el valor no deben estar vacíos ni null. Las claves no pueden contener <> % & \ ? /
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

InvoiceDocument

Propiedades de un documento.

Nombre	Tipo	Description
documentNumbers	string[]	Los números de documento del documento de factura.
externalUrl	string	Dirección URL para descargar el documento de factura si el origen es externo a Microsoft.Billing.
kind	InvoiceDocumentType	Tipo del documento.
name	string	Identificador que identifica de forma única un documento de factura. Este identificador puede ser un identificador para un PDF de factura, una nota de crédito o un recibo fiscal.
source	DocumentSource	Origen del documento. ENF para Brasil y DRS para el resto del mundo.
url	string	Dirección URL para descargar el documento de factura si el origen es interno de Microsoft.Billing.

InvoiceDocumentType

Tipo del documento.

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

InvoiceProperties

Una factura.

Nombre	Tipo	Description
amountDue	AmountDue	Importe vencido a partir de ahora.
azurePrepaymentApplied	AzurePrepaymentApplied	El importe del prepago de Azure aplicado a los cargos. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
billedAmount	BilledAmount	Los cargos totales del período de facturación.
billedDocumentId	string	Identificador de la factura activa que se factura originalmente después de anular esta factura. Este campo solo se aplica a las facturas nulas.
billingProfileDisplayName	string	Nombre del perfil de facturación para el que se genera la factura.
billingProfileId	string	Identificador del perfil de facturación para el que se genera la factura.
creditAmount	CreditAmount	Reembolso total de devoluciones y cancelaciones durante el período de facturación. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
creditForDocumentId	string	El identificador de la factura que se anuló y esta nota de crédito se emitió como resultado. Este campo solo se aplica a las notas de crédito.
documentType	InvoiceDocumentType	Tipo del documento.
documents	InvoiceDocument[]	Lista de documentos disponibles para descargar y ver, como factura, nota de crédito o recibo fiscal.
dueDate	string	Fecha de vencimiento de la factura.
failedPayments	FailedPayment[]	Lista de pagos erróneos.
freeAzureCreditApplied	FreeAzureCreditApplied	Cantidad de créditos gratuitos de Azure aplicados a los cargos. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
invoiceDate	string	Fecha en que se generó la factura.
invoicePeriodEndDate	string	Fecha de finalización del período de facturación para el que se genera la factura. La fecha está en formato MM-DD-YYYY.
invoicePeriodStartDate	string	Fecha de inicio del período de facturación para el que se genera la factura. La fecha está en formato MM-DD-YYYY.
invoiceType	InvoiceType	Tipo de factura.
isMonthlyInvoice	boolean	Especifica si la factura se genera como parte del ciclo de facturación mensual o no. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
payments	Payment[]	Lista de pagos.
purchaseOrderNumber	string	Número de pedido de compra opcional para la factura.
rebillDetails	RebillDetails	Detalles de la facturación de una factura.
refundDetails	RefundDetails	Detalles de una solicitud de reembolso.
specialTaxationType	SpecialTaxationType	Identifica el tipo de cálculo fiscal utilizado para la factura. El campo solo es aplicable a las facturas con lógica de cálculo fiscal especial.
status	InvoiceStatus	Estado actual de la factura.
subTotal	SubTotal	El importe de impuestos previos que se debe. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
subscriptionDisplayName	string	Nombre de la suscripción de facturación para la que se genera la factura.
subscriptionId	string	Identificador de la suscripción para la que se genera la factura.
taxAmount	TaxAmount	El importe del impuesto que se cobra durante el período de facturación. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
totalAmount	TotalAmount	Importe vencido cuando se generó la factura. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.

InvoiceStatus

Estado actual de la factura.

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

InvoiceType

Tipo de factura.

Nombre	Tipo	Description
AzureMarketplace	string
AzureServices	string
AzureSupport	string
Other	string

Payment

Un pago de factura.

Nombre	Tipo	Description
amount	Amount	Importe pagado.
date	string	Fecha en que se realizó el pago.
paymentMethodFamily	PaymentMethodFamily	Familia de métodos de pago.
paymentMethodId	string	Identificador que identifica de forma única el método de pago usado para la factura.
paymentMethodType	string	Tipo de método de pago.
paymentType	string	Tipo de pago.

PaymentMethodFamily

Familia de métodos de pago.

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

RebillDetails

Detalles de la facturación de una factura.

Nombre	Tipo	Description
creditNoteDocumentId	string	Identificador de la nota de crédito.
invoiceDocumentId	string	Identificador de la factura.
rebillDetails	RebillDetails	Detalles de la facturación de una factura.

RefundDetails

Detalles de una solicitud de reembolso.

Nombre	Tipo	Description
amountRefunded	AmountRefunded	Importe devuelto.
amountRequested	AmountRequested	Cantidad de reembolso solicitada.
approvedOn	string	Fecha en que se aprobó el reembolso.
completedOn	string	Fecha en que se completó el reembolso.
rebillInvoiceId	string	El identificador de factura de la factura para un reembolso.
refundOperationId	string	Identificador de la operación de reembolso.
refundReason	RefundReasonCode	Motivo del reembolso.
refundStatus	RefundStatus	Estado de la solicitud de reembolso.
requestedOn	string	Fecha en que se solicitó el reembolso.
transactionCount	integer	Número de transacciones reembolsables.

RefundReasonCode

Motivo del reembolso.

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

RefundStatus

Estado de la solicitud de reembolso.

Nombre	Tipo	Description
Approved	string
Cancelled	string
Completed	string
Declined	string
Expired	string
Other	string
Pending	string

SpecialTaxationType

Identifica el tipo de cálculo fiscal utilizado para la factura. El campo solo es aplicable a las facturas con lógica de cálculo fiscal especial.

Nombre	Tipo	Description
InvoiceLevel	string
SubtotalLevel	string

SubTotal

El importe de impuestos previos que se debe. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.

Nombre	Tipo	Description
currency	string	Moneda del valor de la cantidad.
value	number	Valor de la cantidad. Por ejemplo, si la moneda es USD, un valor de 600 sería $600.00.

systemData

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

TaxAmount

El importe del impuesto que se cobra durante el período de facturación. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.

Nombre	Tipo	Description
currency	string	Moneda del valor de la cantidad.
value	number	Valor de la cantidad. Por ejemplo, si la moneda es USD, un valor de 600 sería $600.00.

TotalAmount

Importe vencido cuando se generó la factura. Este campo es aplicable a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.

Nombre	Tipo	Description
currency	string	Moneda del valor de la cantidad.
value	number	Valor de la cantidad. Por ejemplo, si la moneda es USD, un valor de 600 sería $600.00.

Compartir a través de