Abrufen von in Rechnung gestellten kommerziellen Verbrauchspositionen

Artikel
04/26/2024

Hinweis

Sie können diese API nach dem 30. September 2024 weiterhin für Ihre neuen Geschäftsnutzungsdaten verwenden, die vor September 2022 generiert wurden. Wählen Sie die richtige Version basierend auf diesen Details aus:

Verwenden Sie diese API bis zum 30. September 2024, es sei denn, Sie haben bereits zu API v2 GA gewechselt, um auf die täglich bewerteten Nutzungspositionen für Rechnungen von September 2024 zuzugreifen.
Für Abrechnungszeiträume vor September 2022 erhalten Sie nur die täglich bewerteten Nutzungspositionen mit dieser API.
Verwenden Sie nur API v2 GA, um täglich bewertete Nutzungspositionen für Rechnungen ab September 2022 zu erhalten.

Folgen Sie diesem Link, um sich auf die neuen APIs vorzubereiten:

Abgerechnete und nicht abgerechnete tägliche Nutzungsabstimmungs-API v2 (GA)

Sie können die folgenden Methoden verwenden, um eine Sammlung von Details für rechnungsmäßig genutzte Rechnungspositionen (auch als abgeschlossene tagesverwertete Positionen bezeichnet) für eine angegebene Rechnung abzurufen.

Wichtig

Die täglich bewerteten Nutzungsdaten enthalten keine Gebühren für diese Produkte:

Azure-Reservierung
Azure-Sparplan
Office
Dynamics
Microsoft Power Apps
Unbefristete Software
Softwareabonnement
SaaS-Produkt von Drittanbietern

Voraussetzungen

Anmeldeinformationen, wie unter Partner Center-Authentifizierung beschrieben. Dieses Szenario unterstützt die Authentifizierung mit eigenständigen App- und App+Benutzeranmeldeinformationen.
Die Rechnungs-ID, für die die Positionen abgerufen werden sollen.

C#

Um die handelsspezifischen Positionen für die angegebene Rechnung abzurufen, müssen Sie das Rechnungsobjekt abrufen:

Rufen Sie die ById-Methode auf, um eine Schnittstelle zu Rechnungsvorgängen für die angegebene Rechnung abzurufen.
Rufen Sie die Get- oder GetAsync-Methode auf, um das Rechnungsobjekt abzurufen. Das Rechnungsobjekt enthält alle Informationen für die angegebene Rechnung.

Der Anbieter identifiziert die Quelle der rechnungsierten Detailinformationen (z . B. einmal). Der InvoiceLineItemType gibt den Typ an (z. B . UsageLineItem).

Im folgenden Beispielcode wird eine Foreachschleife verwendet, um die Zeilenelementeauflistung zu verarbeiten. Für jeden InvoiceLineItemType wird eine separate Sammlung von Zeilenelementen abgerufen.

So rufen Sie eine Sammlung von Positionen ab, die einer InvoiceDetail-Instanz entsprechen:

Übergeben Sie den BillingProvider und InvoiceLineItemType der Instanz an die By-Methode.
Rufen Sie die Get- oder GetAsync-Methode auf, um die zugehörigen Zeilenelemente abzurufen.
Erstellen Sie einen Enumerator, um die Auflistung zu durchlaufen, wie im folgenden Beispiel gezeigt.

// 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);
        }
    }
}

Sehen Sie sich ein Beispiel an:

Beispiel: Konsolentest-App
Projekt: Partner Center SDK-Beispiele
Klasse: GetBilledConsumptionReconLineItemsPaging.cs

REST-Anforderung

Anforderungssyntax

Verwenden Sie die erste Syntax, um eine vollständige Liste aller Artikel für die angegebene Rechnung zurückzugeben. Verwenden Sie bei größeren Rechnungen die zweite Syntax mit einer festgelegten Größe und einem 0-basierten Offset zur Rückgabe einer in Seiten unterteilten Liste mit Positionen. Verwenden Sie die dritte Syntax, um die nächste Seite der Neukonfigurationszeilenelemente zu seekOperation = "Next"verwenden.

Methode	Anforderungs-URI
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

URI-Parameter

Verwenden Sie beim Erstellen der Anforderung die folgenden URI- und Abfrageparameter.

Name	Type	Erforderlich	Beschreibung
invoice-id	Zeichenfolge	Ja	Eine Zeichenfolge, die die Rechnung identifiziert.
provider	Zeichenfolge	Ja	Der Anbieter: "OneTime".
invoice-line-item-type	Zeichenfolge	Ja	Der Typ der Rechnungsdetails: "UsageLineItems".
currencyCode	Zeichenfolge	Ja	Der Währungscode für die in Rechnung gestellten Positionen.
period (Zeitraum)	Zeichenfolge	Ja	Der Zeitraum für die abrechnungsaufwendigte Abstimmung. Beispiel: current, previous.
size	Zahl	No	Die maximale Anzahl der zurückzugebenden Elemente. Standardgröße ist 2000
seekOperation	Zeichenfolge	No	Set seekOperation=Next to get the next page of recon line items.

Anforderungsheader

Weitere Informationen finden Sie unter Partner Center-REST-Header.

Anforderungstext

Keine.

REST-Antwort

Wenn die Antwort erfolgreich verläuft, enthält die Antwort die Auflistung der Zeilenelementdetails.

Für die Position "ChargeType" wird der Wert "Purchase " " Neu" zugeordnet. Der Wert "Rückerstattung" wird " Abbrechen" zugeordnet.

Erfolgs- und Fehlercodes der Antwort

Jede Antwort enthält einen HTTP-Statuscode, der Erfolg oder Fehler und andere Debuginformationen angibt. Verwenden Sie ein Netzwerkablaufverfolgungstool, um diesen Code, fehlertyp und weitere Parameter zu lesen. Die vollständige Liste finden Sie unter Partner Center-REST-Fehlercodes.

REST-Beispiele

Anforderungsantwort (Beispiel 1)

Die Details für diese Beispiel-REST-Anforderung und -Antwort sind wie folgt:

Anbieter: OneTime
InvoiceLineItemType: UsageLineItems
Zeitraum: Vorheriger

Anforderungsbeispiel 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