Obtenir les éléments facturés de la ligne de consommation commerciale

Article
04/26/2024

Remarque

Vous pouvez toujours utiliser cette API après le 30 septembre 2024 pour vos nouvelles données d’utilisation du commerce générées avant septembre 2022. Choisissez la version appropriée en fonction de ces détails :

Pour accéder aux éléments de ligne d’utilisation quotidiens notés pour les factures de septembre 2022 à septembre 2024, utilisez cette API jusqu’au 30 septembre 2024, sauf si vous avez déjà basculé vers l’API v2 GA.
Pour les périodes de facturation antérieures à septembre 2022, obtenez uniquement les éléments de ligne d’utilisation évalués quotidiennement avec cette API.
Pour obtenir les éléments de ligne d’utilisation évalués quotidiennement pour les factures de septembre 2022, utilisez uniquement l’API v2 GA.

Suivez ce lien pour vous préparer aux nouvelles API :

API de rapprochement d’utilisation facturée et non facturée par jour v2 (GA)

Vous pouvez utiliser les méthodes suivantes pour obtenir une collection de détails pour les éléments de ligne de facture de consommation commerciale (également appelés éléments de ligne d’utilisation quotidiens fermés) pour une facture spécifiée.

Important

Les données d’utilisation évaluées quotidiennement n’incluent pas les frais pour ces produits :

Réservation Azure
Plan d’épargne Azure
Office
Dynamics
Microsoft Power Apps
Logiciels perpétuels
Abonnement logiciel
Produit SaaS tiers

Prérequis

Informations d’identification, comme décrit dans Authentification auprès de l’Espace partenaires. Ce scénario prend en charge l’authentification avec les informations d’identification d’application et d’application+utilisateur autonomes.
ID de facture pour lequel obtenir les éléments de ligne.

C#

Pour obtenir les éléments de ligne commerciale de la facture spécifiée, vous devez récupérer l’objet de facture :

Appelez la méthode ById pour obtenir une interface vers les opérations de facture pour la facture spécifiée.
Appelez la méthode Get ou GetAsync pour récupérer l’objet de facture. L’objet de facture contient toutes les informations de la facture spécifiée.

Le fournisseur identifie la source des informations détaillées facturées (par exemple, onetime). InvoiceLineItemType spécifie le type (par exemple, UsageLineItem).

L’exemple de code suivant utilise une boucle foreach pour traiter la collection d’éléments de ligne. Une collection distincte d’éléments de ligne est récupérée pour chaque InvoiceLineItemType.

Pour obtenir une collection d’éléments de ligne qui correspondent à une instance InvoiceDetail :

Transmettez billingProvider et InvoiceLineItemType de l’instance à la méthode By.
Appelez la méthode Get ou GetAsync pour récupérer les éléments de ligne associés.
Créez un énumérateur pour parcourir la collection, comme illustré dans l’exemple suivant.

// IAggregatePartner partnerOperations;
// string invoiceId;
// string curencyCode;
// string period;
// int pageMaxSizeReconLineItems = 2000;

// all the operations executed on this partner operation instance will share the same correlation Id but will differ in request Id
IPartner scopedPartnerOperations = partnerOperations.With(RequestContextFactory.Instance.Create(Guid.NewGuid()));

var seekBasedResourceCollection = scopedPartnerOperations.Invoices.ById(invoiceId).By("onetime", "usagelineitems", curencyCode, period, pageMaxSizeReconLineItems).Get();

var fetchNext = true;

ConsoleKeyInfo keyInfo;

var itemNumber = 1;
while (fetchNext)
{
    Console.Out.WriteLine("\tLine line items count: " + seekBasedResourceCollection.Items.Count());

    seekBasedResourceCollection.Items.ToList().ForEach(item =>
    {
        // Instance of type DailyRatedUsageLineItem
        if (item is DailyRatedUsageLineItem)
        {
            Type t = typeof(DailyRatedUsageLineItem);
            PropertyInfo[] properties = t.GetProperties();

            foreach (PropertyInfo property in properties)
            {
                // Insert code here to work with the line item properties
            }
        }
        itemNumber++;
    });

    Console.Out.WriteLine("\tPress any key to fetch next data. Press the Escape (Esc) key to quit: \n");
    keyInfo = Console.ReadKey();

    if (keyInfo.Key == ConsoleKey.Escape)
    {
        break;
    }

    fetchNext = !string.IsNullOrWhiteSpace(seekBasedResourceCollection.ContinuationToken);

    if (fetchNext)
    {
        if (seekBasedResourceCollection.Links.Next.Headers != null && seekBasedResourceCollection.Links.Next.Headers.Any())
        {
            seekBasedResourceCollection = scopedPartnerOperations.Invoices.ById(invoiceId).By("onetime", "usagelineitems", curencyCode, period, pageMaxSizeReconLineItems).Seek(seekBasedResourceCollection.ContinuationToken, SeekOperation.Next);
        }
    }
}

Consultez un exemple :

Exemple : Application de test console
Projet : Exemples du Kit de développement logiciel (SDK) de l’Espace partenaires
Classe : GetBilledConsumptionReconLineItemsPaging.cs

Demande REST

Syntaxe de la requête

Utilisez la première syntaxe pour renvoyer une liste complète de chaque élément de ligne pour la facture donnée. Pour les factures de grande taille, utilisez la deuxième syntaxe avec une taille spécifiée et un décalage basé sur 0 pour renvoyer une liste paginée des éléments de ligne. Utilisez la troisième syntaxe pour obtenir la page suivante d’éléments de ligne de reconligne à l’aide seekOperation = "Next"de .

Méthode	URI de demande
GET	{baseURL}/v1/invoices/{invoice-id}/lineitems ?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode} HTTP/1.1
GET	{baseURL}/v1/invoices/{invoice-id}/lineitems ?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&size={size} HTTP/1.1
GET	{baseURL}/v1/invoices/{invoice-id}/lineitems ?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&size={size}&seekOperation=Next

Paramètres d’URI

Utilisez l’URI et les paramètres de requête suivants lors de la création de la requête.

Nom	Type	Requise	Description
invoice-id	string	Oui	Chaîne qui identifie la facture.
fournisseur	string	Oui	Le fournisseur : « OneTime ».
invoice-line-item-type	string	Oui	Type de détail de facture : « UsageLineItems ».
currencyCode	string	Oui	Code monétaire des éléments de ligne facturés.
period	string	Oui	Période de reconquête facturée. exemple : actuel, précédent.
size	nombre	Non	Nombre maximal d’éléments à retourner. La taille par défaut est 2000
seekOperation	string	Non	Définissez seekOperation=Suivant pour obtenir la page suivante des éléments de ligne de reconligne.

En-têtes de requête

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

Corps de la demande

Aucune.

Réponse REST

Si elle réussit, la réponse contient la collection de détails de l’élément de ligne.

Pour l’élément de ligne ChargeType, la valeur d’achat est mappée à Nouveau. La valeur Remboursement est mappée à Annuler.

Codes d’erreur et de réussite de la réponse

Chaque réponse est fournie avec un code d’état HTTP qui indique la réussite ou l’échec et d’autres informations de débogage. Utilisez un outil de suivi réseau pour lire ce code, le type d’erreur et d’autres paramètres. Pour obtenir la liste complète, consultez Codes d’erreur REST de l’Espace partenaires.

Exemples REST

Exemple de demande-réponse 1

Les détails de cet exemple de requête et de réponse REST sont les suivants :

Fournisseur : OneTime
InvoiceLineItemType : UsageLineItems
Période : précédent

Exemple de requête 1

GET https://api.partnercenter.microsoft.com/v1/invoices/T000001234/lineitems?provider=onetime&invoicelineitemtype=usagelineitems&currencycode=usd&period=previous&size=2000 HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 1234ecb8-37af-45f4-a1a1-358de3ca2b9e
MS-CorrelationId: 5e612512-4345-4bb0-866e-47aeda031234
X-Locale: en-US
MS-PartnerCenter-Application: Partner Center .NET SDK Samples
Host: api.partnercenter.microsoft.com