Invoices - Get By Id

Referencia

Service:: Billing

API Version:: 2020-05-01

Obtiene una factura por identificador. La operación se admite para las cuentas de facturación con el tipo de contrato Microsoft Partner Agreement o Contrato de cliente de Microsoft.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
invoiceName	path	True	string	Identificador que identifica de forma única una factura.
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 2020-05-01.

Respuestas

Nombre	Tipo	Description
200 OK	Invoice	Aceptar. La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Invoice

Sample Request

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

/** Samples for Invoices GetById. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceById.json
     */
    /**
     * Sample code: Invoice.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void invoice(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.invoices().getByIdWithResponse("{invoiceName}", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armbilling_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billing/armbilling"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceById.json
func ExampleInvoicesClient_GetByID() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbilling.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewInvoicesClient().GetByID(ctx, "{invoiceName}", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Invoice = armbilling.Invoice{
	// 	Name: to.Ptr("{invoiceName}"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/invoices"),
	// 	ID: to.Ptr("providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}"),
	// 	Properties: &armbilling.InvoiceProperties{
	// 		AmountDue: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](16.53),
	// 		},
	// 		AzurePrepaymentApplied: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](15.46),
	// 		},
	// 		BilledAmount: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](33.99),
	// 		},
	// 		BillingProfileDisplayName: to.Ptr("Contoso Operations Billing"),
	// 		BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}"),
	// 		CreditAmount: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](2),
	// 		},
	// 		Documents: []*armbilling.Document{
	// 			{
	// 				Kind: to.Ptr(armbilling.DocumentTypeInvoice),
	// 				Source: to.Ptr(armbilling.DocumentSourceDRS),
	// 				URL: to.Ptr("https://microsoft.com/invoice.pdf"),
	// 			},
	// 			{
	// 				Kind: to.Ptr(armbilling.DocumentTypeTaxReceipt),
	// 				Source: to.Ptr(armbilling.DocumentSourceDRS),
	// 				URL: to.Ptr("https://microsoft.com/taxDoc.pdf"),
	// 		}},
	// 		DueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-16T17:32:28.000Z"); return t}()),
	// 		FreeAzureCreditApplied: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](0),
	// 		},
	// 		InvoiceDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-01T17:32:28.000Z"); return t}()),
	// 		InvoicePeriodEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-15T17:32:28.000Z"); return t}()),
	// 		InvoicePeriodStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-01T17:32:28.000Z"); return t}()),
	// 		IsMonthlyInvoice: to.Ptr(false),
	// 		Payments: []*armbilling.PaymentProperties{
	// 			{
	// 				Amount: &armbilling.Amount{
	// 					Currency: to.Ptr("USD"),
	// 					Value: to.Ptr[float32](2),
	// 				},
	// 				Date: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-14T17:32:28.000Z"); return t}()),
	// 				PaymentMethodFamily: to.Ptr(armbilling.PaymentMethodFamilyCreditCard),
	// 				PaymentMethodType: to.Ptr("visa"),
	// 				PaymentType: to.Ptr("credited"),
	// 		}},
	// 		PurchaseOrderNumber: to.Ptr("123456"),
	// 		Status: to.Ptr(armbilling.InvoiceStatusDue),
	// 		SubTotal: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](33.99),
	// 		},
	// 		TaxAmount: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](0),
	// 		},
	// 		TotalAmount: &armbilling.Amount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](16.53),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
 *
 * @summary Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceById.json
 */
async function invoice() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const invoiceName = "{invoiceName}";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const result = await client.invoices.getById(invoiceName);
  console.log(result);
}

invoice().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}",
  "name": "{invoiceName}",
  "type": "Microsoft.Billing/billingAccounts/invoices",
  "properties": {
    "dueDate": "2018-01-16T17:32:28Z",
    "invoiceDate": "2018-01-01T17:32:28Z",
    "status": "Due",
    "amountDue": {
      "currency": "USD",
      "value": 16.53
    },
    "billedAmount": {
      "currency": "USD",
      "value": 33.99
    },
    "azurePrepaymentApplied": {
      "currency": "USD",
      "value": 15.46
    },
    "creditAmount": {
      "currency": "USD",
      "value": 2
    },
    "freeAzureCreditApplied": {
      "currency": "USD",
      "value": 0
    },
    "subTotal": {
      "currency": "USD",
      "value": 33.99
    },
    "taxAmount": {
      "currency": "USD",
      "value": 0
    },
    "totalAmount": {
      "currency": "USD",
      "value": 16.53
    },
    "invoicePeriodStartDate": "2018-01-01T17:32:28Z",
    "invoicePeriodEndDate": "2018-01-15T17:32:28Z",
    "isMonthlyInvoice": false,
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
    "billingProfileDisplayName": "Contoso Operations Billing",
    "purchaseOrderNumber": "123456",
    "documents": [
      {
        "kind": "Invoice",
        "url": "https://microsoft.com/invoice.pdf",
        "source": "DRS"
      },
      {
        "kind": "TaxReceipt",
        "url": "https://microsoft.com/taxDoc.pdf",
        "source": "DRS"
      }
    ],
    "payments": [
      {
        "date": "2018-01-14T17:32:28Z",
        "paymentType": "credited",
        "amount": {
          "currency": "USD",
          "value": 2
        },
        "paymentMethodFamily": "CreditCard",
        "paymentMethodType": "visa"
      }
    ]
  }
}

Definiciones

Nombre	Description
Amount	Cantidad.
Document	Propiedades de un documento.
DocumentSource	Origen del documento. ENF para Brasil y DRS para el resto del mundo.
DocumentType	Tipo del documento.
ErrorDetails	Detalles del error.
ErrorResponse	La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.
ErrorSubDetails
Invoice	Una factura.
InvoiceDocumentType	Tipo del documento.
InvoiceStatus	Estado actual de la factura.
InvoiceType	Tipo de factura.
PaymentMethodFamily	Familia de métodos de pago.
PaymentProperties	Propiedades de un pago.
RebillDetails	Detalles de la facturación de una factura.

Amount

Cantidad.

Nombre	Tipo	Description
currency	string	Moneda del valor de la cantidad.
value	number	Valor de cantidad.

Document

Propiedades de un documento.

Nombre	Tipo	Description
kind	DocumentType	Tipo del documento.
source	DocumentSource	Origen del documento. ENF para Brasil y DRS para el resto del mundo.
url	string	Dirección URL del documento.

DocumentSource

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

Nombre	Tipo	Description
DRS	string
ENF	string

DocumentType

Tipo del documento.

Nombre	Tipo	Description
CreditNote	string
Invoice	string
TaxReceipt	string
VoidNote	string

ErrorDetails

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
details	ErrorSubDetails[]	Los detalles secundarios del error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.
target	string	Destino del error determinado.

ErrorResponse

La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error.

ErrorSubDetails

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.
target	string	Destino del error determinado.

Invoice

Una factura.

Nombre	Tipo	Description
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties.amountDue	Amount	La cantidad vencida a partir de ahora.
properties.azurePrepaymentApplied	Amount	El importe del prepago de Azure aplicado a los cargos. Este campo se aplica a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
properties.billedAmount	Amount	Los cargos totales del período de facturación.
properties.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 anuladas.
properties.billingProfileDisplayName	string	Nombre del perfil de facturación para el que se genera la factura.
properties.billingProfileId	string	Identificador del perfil de facturación para el que se genera la factura.
properties.creditAmount	Amount	Reembolso total de devoluciones y cancelaciones durante el período de facturación. Este campo se aplica a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
properties.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.
properties.documentType	InvoiceDocumentType	Tipo del documento.
properties.documents	Document[]	Lista de documentos disponibles para descargar, como factura y recibo fiscal.
properties.dueDate	string	Fecha de vencimiento de la factura.
properties.freeAzureCreditApplied	Amount	Cantidad de créditos gratuitos de Azure aplicados a los cargos. Este campo se aplica a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
properties.invoiceDate	string	Fecha en la que se generó la factura.
properties.invoicePeriodEndDate	string	Fecha de finalización del período de facturación para el que se genera la factura.
properties.invoicePeriodStartDate	string	Fecha de inicio del período de facturación para el que se genera la factura.
properties.invoiceType	InvoiceType	Tipo de factura.
properties.isMonthlyInvoice	boolean	Especifica si la factura se genera como parte del ciclo de facturación mensual o no. Este campo se aplica a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
properties.payments	PaymentProperties[]	Lista de pagos.
properties.purchaseOrderNumber	string	Número de pedido de compra opcional para la factura.
properties.rebillDetails	<string, RebillDetails>	Detalles de la facturación de una factura.
properties.status	InvoiceStatus	Estado actual de la factura.
properties.subTotal	Amount	El importe de impuestos previos que debe pagarse. Este campo se aplica a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
properties.subscriptionId	string	Identificador de la suscripción para la que se genera la factura.
properties.taxAmount	Amount	El importe del impuesto que se cobra durante el período de facturación. Este campo se aplica a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
properties.totalAmount	Amount	Importe vencido cuando se generó la factura. Este campo se aplica a las cuentas de facturación con el tipo de contrato Contrato de cliente de Microsoft.
type	string	Tipo de recurso.

InvoiceDocumentType

Tipo del documento.

Nombre	Tipo	Description
CreditNote	string
Invoice	string

InvoiceStatus

Estado actual de la factura.

Nombre	Tipo	Description
Due	string
OverDue	string
Paid	string
Void	string

InvoiceType

Tipo de factura.

Nombre	Tipo	Description
AzureMarketplace	string
AzureService	string
AzureSupport	string

PaymentMethodFamily

Familia de métodos de pago.

Nombre	Tipo	Description
CheckWire	string
CreditCard	string
Credits	string
None	string

PaymentProperties

Propiedades de un pago.

Nombre	Tipo	Description
amount	Amount	Importe pagado.
date	string	Fecha en que se realizó el pago.
paymentMethodFamily	PaymentMethodFamily	Familia de métodos de pago.
paymentMethodType	string	Tipo de método de pago.
paymentType	string	Tipo de pago.

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	<string, RebillDetails>	Detalles de la facturación de una factura.

Compartir a través de

Invoices - Get By Id

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

Invoice

Sample Request

Sample Response

Definiciones

Amount

Document

DocumentSource

DocumentType

ErrorDetails

ErrorResponse

ErrorSubDetails

Invoice

InvoiceDocumentType

InvoiceStatus

InvoiceType

PaymentMethodFamily

PaymentProperties

RebillDetails

Recursos adicionales