Partager via

Obtenir la facture par ID

S’applique à : Espace partenaires géré par 21Vianet | Espace partenaires pour Microsoft Cloud pour le gouvernement des États-Unis

Note

Pour les achats commerciaux modernes, cette API s’applique uniquement aux factures générées avant le 15 mai 2025.

Récupère une facture donnée à l’aide de l’ID de facture.

Prerequisites

  • Informations d’identification décrites dans l’authentification de l’Espace partenaires. Ce scénario prend uniquement en charge l’authentification avec les informations d’identification App+Utilisateur.

  • ID de facture valide.

C#

Pour obtenir une facture par ID :

  1. Utilisez votre collection IPartner.Invoices et appelez la méthode ById().

  2. Appelez les méthodes Get() ou GetAsync().

// IPartner scopedPartnerOperations;
// string selectedInvoiceId;

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

Exemple : Application de test de console. Projet : PartnerSDK.FeatureSample Classe : GetInvoice.cs

Requête REST

Syntaxe de la requête

Méthode URI de la requête
GET {baseURL}/v1/invoices/{invoice-id} HTTP/1.1

Paramètre d’URI

Utilisez le paramètre de requête suivant pour obtenir la facture.

Nom Type Obligatoire Descriptif
invoice-id chaîne de caractères Oui La valeur est un ID de facture qui permet au revendeur de filtrer les résultats d’une facture donnée.

En-têtes de requête

Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires.

Corps de la requête

Aucun

Exemple de requête

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

Réponse REST

Si elle réussit, cette méthode retourne une ressource Invoice dans le corps de la réponse.

Réussite de la réponse et codes d’erreur

Chaque réponse est accompagnée d’un code d’état HTTP qui indique la réussite ou l’échec ainsi que des informations de débogage supplémentaires. Utilisez un outil de suivi réseau pour lire ce code, le type d’erreur et les paramètres supplémentaires. Pour obtenir la liste complète, consultez Codes d’erreur.

Exemple de réponse

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