Compartir a través de

Obtención de la factura por identificador

Se aplica a: Centro de socios operado por 21Vianet | Centro de socios para Microsoft Cloud para el Gobierno de EE.UU.

Nota:

En el caso de las compras comerciales modernas, esta API solo se aplica a las facturas generadas antes del 15 de mayo de 2025.

Recupera una factura determinada mediante el identificador de factura.

Prerrequisitos

  • Credenciales tal como se describe en Autenticación del Centro de asociados. Este escenario solo admite la autenticación con credenciales de App+User.

  • Un identificador de factura válido.

C#

Para obtener una factura por identificador:

  1. Use la colección IPartner.Invoices y llame al método ById().

  2. Llame a los métodos Get() o GetAsync().

// IPartner scopedPartnerOperations;
// string selectedInvoiceId;

var invoice = scopedPartnerOperations.Invoices.ById(selectedInvoiceId).Get();

Ejemplo: Aplicación de prueba de consola. Project: PartnerSDK.FeatureSample Clase: GetInvoice.cs

Solicitud REST

Sintaxis de la solicitud

Método Solicitud de URI
OBTÉN {baseURL}/v1/invoices/{invoice-id} HTTP/1.1

Parámetro de URI

Use el siguiente parámetro de consulta para obtener la factura.

Nombre Tipo Obligatorio Description
invoice-id cadena Sí El valor es un identificador de factura que permite al revendedor filtrar los resultados de una factura determinada.

Encabezados de solicitud

Para más información, consulte Encabezados REST del Centro de partners.

Cuerpo de la solicitud

Ninguno

Ejemplo de solicitud

GET https://api.partnercenter.microsoft.com/v1/invoices/<invoice-id> HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 8ac25aa5-9537-4b6d-b782-aa0c8e979e99
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd

Respuesta REST

Si se ejecuta correctamente, este método devuelve un recurso Invoice en el cuerpo de la respuesta.

Códigos de éxito y de error de la respuesta

Cada respuesta incluye un código de estado HTTP que indica el éxito o error y la información adicional de depuración. Use una herramienta de seguimiento de red para leer este código, tipo de error y parámetros adicionales. Para obtener la lista completa, consulte Códigos de error.

Ejemplo de respuesta

HTTP/1.1 200 OK
Content-Length: 676
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 8ac25aa5-9537-4b6d-b782-aa0c8e979e99
Date: Thu, 24 Mar 2016 05:22:14 GMT

{
    "id": "G000024135",
    "invoiceDate": "2018-02-08T22:40:37.5897767Z",
    "billingPeriodStartDate": "2018-02-01T22:40:37.5897767Z",
    "billingPeriodEndDate": "2018-02-28T22:40:37.5897767Z",
    "totalCharges": 2076.63,
    "paidAmount": 0,
    "currencyCode": "USD",
    "currencySymbol": "$",
    "pdfDownloadLink": "/invoices/G000024135/documents/statement",
    "taxReceipts": [
        {
            "id": "123456",
            "taxReceiptPdfDownloadLink": "/invoices/G000024135/receipts/123456/documents/statement"
        }
    ],
    "invoiceDetails": [
        {
            "invoiceLineItemType": "billing_line_items",
            "billingProvider": "one_time",
            "links": {
                "self": {
                    "uri": "/invoices/OneTime-G000024135/lineitems/OneTime/BillingLineItems",
                    "method": "GET",
                    "headers": []
                }
            },
            "attributes": {
                "objectType": "InvoiceDetail"
            }
        }
    ],
    "documentType": "invoice",
    "invoiceType": "OneTime",
    "links": {
        "self": {
            "uri": "/invoices/OneTime-G000024135",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Invoice"
    }
}
  • Last updated on