Pobieranie elementów wiersza komercyjnego użycia rozliczonego na fakturze

Artykuł
04/26/2024

Uwaga

Ten interfejs API można nadal używać po 30 września 2024 r. dla nowych danych użycia handlu wygenerowanych przed wrześniem 2022 r. Wybierz odpowiednią wersję na podstawie następujących szczegółów:

Aby uzyskać dostęp do codziennych elementów wiersza użycia ocenianego dla faktur od września 2022 r. do września 2024 r., użyj tego interfejsu API do 30 września 2024 r., chyba że został już przełączony do interfejsu API w wersji 2 (ogólna dostępność).
W przypadku okresów rozliczeniowych przed wrześniem 2022 r. uzyskaj dzienne elementy wiersza użycia z tym interfejsem API.
Aby uzyskać dzienne elementy wierszy użycia dla faktur z września 2022 r., użyj tylko interfejsu API w wersji 2 (ogólna dostępność).

Postępuj zgodnie z tym linkiem, aby przygotować się do nowych interfejsów API:

Rozliczane i nienaliczone dzienne interfejs API uzgodnień użycia w wersji 2 (GA)

Poniższe metody umożliwiają pobranie kolekcji szczegółów dotyczących elementów wiersza faktury z użyciem komercyjnych (nazywanych również zamkniętymi elementami wierszy dziennego użycia) dla określonej faktury.

Ważne

Dane dziennego użycia nie obejmują opłat za te produkty:

Rezerwacja platformy Azure
Plan oszczędnościowy Azure
Office
Dynamics
Microsoft Power Apps
Oprogramowanie bezterminowe
Subskrypcja oprogramowania
Produkt SaaS innej firmy

Wymagania wstępne

Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie w Centrum partnerskim. Ten scenariusz obsługuje uwierzytelnianie zarówno przy użyciu autonomicznych poświadczeń aplikacji, jak i aplikacji i użytkownika.
Identyfikator faktury w celu pobrania elementów wiersza.

C#

Aby pobrać elementy wiersza komercyjnego dla określonej faktury, należy pobrać obiekt faktury:

Wywołaj metodę ById , aby pobrać interfejs do operacji na fakturze dla określonej faktury.
Wywołaj metodę Get lub GetAsync , aby pobrać obiekt faktury. Obiekt faktury zawiera wszystkie informacje dotyczące określonej faktury.

Dostawca identyfikuje źródło rozliczanych informacji szczegółowych (na przykład jednorazowo). Parametr InvoiceLineItemType określa typ (na przykład UsageLineItem).

Poniższy przykładowy kod używa pętli foreach do przetwarzania kolekcji elementów wiersza. Dla każdego elementu InvoiceLineItemType jest pobierana oddzielna kolekcja elementów wiersza.

Aby uzyskać kolekcję elementów wiersza odpowiadających wystąpieniu InvoiceDetail :

Przekaż element BillingProvider i InvoiceLineItemType wystąpienia do metody By.
Wywołaj metodę Get lub GetAsync , aby pobrać skojarzone elementy wiersza.
Utwórz moduł wyliczający, aby przejść przez kolekcję, jak pokazano w poniższym przykładzie.

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

Zobacz przykład:

Przykład: aplikacja testowa konsoli
Projekt: Przykłady zestawu SDK Centrum partnerskiego
Klasa: GetBilledConsumptionReconLineItemsPaging.cs

Żądanie REST

Składnia żądania

Użyj pierwszej składni, aby zwrócić pełną listę każdego elementu wiersza dla danej faktury. W przypadku dużych faktur użyj drugiej składni z określonym rozmiarem i przesunięciem na podstawie 0 w celu zwrócenia stronicowanej listy elementów wiersza. Użyj trzeciej składni, aby uzyskać następną stronę elementów wierszy ponownego tworzenia przy użyciu polecenia seekOperation = "Next".

Method	Identyfikator URI żądania
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

Parametry identyfikatora URI

Podczas tworzenia żądania użyj następującego identyfikatora URI i parametrów zapytania.

Nazwisko	Type	Wymagania	opis
identyfikator faktury	string	Tak	Ciąg identyfikujący fakturę.
dostawca	string	Tak	Dostawca: "OneTime".
typ elementu faktury	string	Tak	Typ szczegółów faktury: "UsageLineItems".
currencyCode	string	Tak	Kod waluty dla rozliczanych elementów wiersza.
Okres	string	Tak	Okres opłat za rozliczenie. przykład: bieżący, poprzedni.
size	numer	Nie.	Maksymalna liczba elementów do zwrócenia. Domyślny rozmiar to 2000
seekOperation	string	Nie	Ustaw wartość seekOperation=Next, aby pobrać następną stronę elementów wiersza ponownego tworzenia.

Nagłówki żądań

Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.

Treść żądania

Brak.

Odpowiedź REST

W przypadku powodzenia odpowiedź zawiera kolekcję szczegółów elementu wiersza.

W przypadku elementu wiersza ChargeType wartość Zakup jest mapowana na nowy. Wartość Zwrot jest mapowana na Anuluj.

Kody powodzenia i błędów odpowiedzi

Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i inne informacje o debugowaniu. Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i inne parametry. Aby uzyskać pełną listę, zobacz Kody błędów REST Centrum partnerskiego.

Przykłady rest

Przykład odpowiedzi na żądanie 1

Szczegóły tego przykładowego żądania REST i odpowiedzi są następujące:

Dostawca: OneTime
InvoiceLineItemType: UsageLineItems
Okres: poprzedni

Przykład żądania 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