Számlázott kereskedelmi használatalapú sortételek lekérése

Cikk
04/26/2024

Feljegyzés

Ezt az API-t 2024. szeptember 30. után is használhatja a 2022 szeptembere előtt létrehozott új kereskedelmi használati adatokhoz. Az alábbi részletek alapján válassza ki a megfelelő verziót:

A számlák 2022 szeptembere és 2024 szeptembere közötti napi névleges használati sorokhoz való hozzáféréshez használja ezt az API-t 2024. szeptember 30-ig, hacsak nem váltott már az API v2 GA-ra.
A 2022 szeptembere előtti számlázási időszakokban csak ezzel az API-val kaphat napi névleges használati sorelemeket.
Ha 2022 szeptemberétől napi névleges használati sorelemeket szeretne lekérni a számlákhoz, csak az API v2 GA-t használja.

Az alábbi hivatkozásra kattintva felkészülhet az új API-kra:

Számlázott és korlátlan napi névleges használati egyeztetési API v2 (GA)

Az alábbi módszerekkel lekérheti a kereskedelmi felhasználású számlasorelemek (más néven a napi névleges használatú cikkek) részleteit egy adott számlához.

Fontos

A napi névleges használati adatok nem tartalmazzák az alábbi termékek díjait:

Azure-foglalás
Azure megtakarítási terv
Office
Dynamics
Microsoft Power Apps
Állandó szoftver
Szoftver-előfizetés
Külső SaaS-termék

Előfeltételek

Hitelesítő adatok a Partnerközpont hitelesítésében leírtak szerint. Ez a forgatókönyv támogatja az önálló alkalmazással és az App+Felhasználói hitelesítő adatokkal való hitelesítést is.
A sorelemek lekéréséhez használt számlaazonosító.

C#

A megadott számla kereskedelmi sorelemeinek lekéréséhez le kell kérnie a számlaobjektumot:

Hívja meg a ById metódust, hogy lekérje a megadott számla számlaműveleteinek felületét.
A számlaobjektum lekéréséhez hívja meg a Get vagy a GetAsync metódust. A számlaobjektum a megadott számla összes információját tartalmazza.

A Szolgáltató azonosítja a számlázott részletek információinak forrását (például egyszer). A InvoiceLineItemType megadja a típust (például UsageLineItem).

Az alábbi példakód egy foreach hurkot használ a sorelemek gyűjteményének feldolgozásához. Minden InvoiceLineItemType esetében külön sorelemek gyűjteménye lesz lekérve.

A InvoiceDetail-példánynak megfelelő sorelemek gyűjteményének lekérése:

Adja át a példány BillingProvider és InvoiceLineItemType tulajdonságát a By metódusnak.
Hívja meg a Get vagy a GetAsync metódust a kapcsolódó sorelemek lekéréséhez.
Hozzon létre egy enumerátort a gyűjtemény bejárásához az alábbi példában látható módon.

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

Lásd egy példát:

Minta: Konzoltesztelő alkalmazás
Projekt: Partnerközpont SDK-minták
Osztály: GetBilledConsumptionReconLineItemsPaging.cs

REST-kérés

Kérés szintaxisa

Az első szintaxissal az adott számla összes sorelemének teljes listáját adja vissza. Nagyméretű számlák esetén használja a második szintaxist egy megadott mérettel és 0-alapú eltolással a sorelemek lapozott listájának visszaadásához. A harmadik szintaxissal lekérheti a sorelemek következő lapját a következő használatával seekOperation = "Next".

Metódus	Kérés URI-ja
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-paraméterek

A kérés létrehozásakor használja az alábbi URI- és lekérdezési paramétereket.

Név	Típus	Kötelező	Leírás
számlaazonosító	sztring	Igen	A számlát azonosító sztring.
szolgáltató	sztring	Igen	A szolgáltató: "OneTime".
számlasor-tétel típusa	sztring	Igen	A számla részleteinek típusa: "UsageLineItems".
currencyCode	sztring	Igen	A számlázott sorelemek pénznemkódja.
Időszak	sztring	Igen	A számlázott felderítés időszaka. például: aktuális, előző.
Méret	szám	Nem	A visszaadni kívánt elemek maximális száma. Az alapértelmezett méret 2000
seekOperation	húr	Nem	Állítsa be a seekOperation=Next elemet a következő sorelemek lekéréséhez.

Kérésfejlécek

További információ: Partnerközpont – REST fejlécek.

Kérés törzse

Nincs.

REST-válasz

Ha sikeres, a válasz tartalmazza a sorelem részleteinek gyűjteményét.

A ChargeType sortételnél a Beszerzés érték Új értékre van leképezve. A Visszatérítés érték a Mégse értékre van leképezve.

Válasz sikeresség és hibakódok

Minden válaszhoz tartozik egy HTTP-állapotkód, amely jelzi a sikert vagy a hibát, valamint egyéb hibakeresési információkat. Ezt a kódot, hibatípust és további paramétereket egy hálózati nyomkövetési eszközzel olvashatja el. A teljes listát a Partnerközpont REST-hibakódjaiban találja.

REST-példák

1. példa a kérelem-válaszra

A példa REST-kérésének és válaszának részletei a következők:

Szolgáltató: OneTime
InvoiceLineItemType: UsageLineItems
Időszak: Előző

1. példa kérése

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