Partilhar via


Obter fatura por ID

Aplica-se a: Partner Center operado pela 21Vianet | Partner Center para a Nuvem Microsoft para o Governo dos EUA

Observação

Para compras comerciais modernas, esta API é aplicável apenas para faturas geradas antes de 15 de maio de 2025.

Recupera uma determinada fatura usando o ID da fatura.

Pré-requisitos

  • Credenciais conforme descrito na autenticação no Partner Center. Este cenário suporta autenticação apenas com credenciais App+User.

  • Um ID de fatura válido.

C#

Para obter uma fatura por ID:

  1. Use sua coleção IPartner.Invoices e chame o método ById( ).

  2. Chame os métodos Get() ou GetAsync().

// IPartner scopedPartnerOperations;
// string selectedInvoiceId;

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

Exemplo de: Aplicativo de teste de console. Projeto: PartnerSDK.FeatureSample Classe: GetInvoice.cs

Pedido de REST

Sintaxe da solicitação

Método Solicitar URI
GET {baseURL}/v1/invoices/{invoice-id} HTTP/1.1

Parâmetro URI

Use o seguinte parâmetro de consulta para obter a fatura.

Nome Tipo Obrigatório Description
ID da fatura string Yes O valor é um ID de fatura que permite ao revendedor filtrar os resultados de uma determinada fatura.

Cabeçalhos da requisição

Para mais informações, consulte os cabeçalhos REST do Partner Center .

Corpo de solicitação

Nenhum

Exemplo de solicitação

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

Resposta do REST

Se for bem-sucedido, esse método retornará um recurso Invoice no corpo da resposta.

Códigos de sucesso e erro de resposta

Cada resposta vem com um código de status HTTP que indica sucesso ou falha e informações adicionais de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e parâmetros adicionais. Para obter a lista completa, consulte Códigos de erro.

Exemplo de resposta

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"
    }
}