Obter fatura por ID

Artigo
10/07/2024

Aplica-se a: Centro de Parceiros | Centro de Parceiros operado pela 21Vianet | Centro de Parceiros para Microsoft Cloud for US Government

Obtém uma determinada fatura com o ID da fatura.

Pré-requisitos

Credenciais conforme descrito na autenticação do Centro de Parceiros. Este cenário suporta a autenticação apenas com credenciais de Aplicação+Utilizador.
Um ID de Fatura válido.

C#

Para obter uma fatura por ID:

Utilize a coleção IPartner.Invoices e chame o método ById( ).
Chame os métodos Get() ou GetAsync( ).

// IPartner scopedPartnerOperations;
// string selectedInvoiceId;

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

Exemplo: aplicação de teste da consola. Project: PartnerSDK.FeatureSample Class: GetInvoice.cs

Pedido REST

Sintaxe do pedido

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

Parâmetro URI

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

Nome	Tipo	Necessário	Descrição
invoice-id	string	Sim	O valor é um ID de fatura que permite ao revendedor filtrar os resultados de uma determinada fatura.

Cabeçalhos do pedido

Para obter mais informações, veja Cabeçalhos REST do Centro de Parceiros.

Corpo do pedido

Nenhuma

Exemplo de pedido

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, este método devolve um recurso de Fatura no corpo da resposta.

Códigos de erro e êxito da resposta

Cada resposta inclui um código de estado HTTP que indica êxito ou falha e informações adicionais de depuração. Utilize uma ferramenta de rastreio de rede para ler este código, tipo de erro e parâmetros adicionais. Para obter a lista completa, veja 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"
    }
}

Partilhar via