Získání nefakturovaných řádkových položek komerčního využití na faktuře

Článek
04/26/2024

Poznámka:

Po 30. září 2024 už toto rozhraní API nebude fungovat. Informace použijte k výběru vaší verze a plánu předem.

Pokud chcete získat přístup k nefakturovaných podrobnostem o denním využití pro aktuální a předchozí fakturační období, použijte toto rozhraní API. Můžete ho použít až do 30. září 2024, pokud před tímto datem nepřepnete na verzi 2 GA.
Pokud chcete získat nefakturované denní využití pro aktuální a předchozí období, přepněte do 30. září 2024 na obecně dostupnou verzi rozhraní API v2.

Kroky migrace rozhraní API v2 najdete v následujících krocích:

Fakturované a nefakturované rozhraní API pro odsouhlasení využití v2 (GA)

Jak získat kolekci nefakturovaných podrobností o řádkové položce komerční spotřeby.

Následující metody můžete použít k získání kolekce podrobností nefakturovaných řádkových položek komerční spotřeby (označovaných také jako otevřené řádkové položky využití) prostřednictvím kódu programu.

Důležité

Data o denním poměru využití nezahrnují poplatky za tyto produkty:

Rezervace Azure
Úsporný plán pro Azure
Office
Dynamics
Microsoft Power Apps
Časově neomezený software
Předplatné softwaru
Produkt SaaS marketplace

Poznámka:

Denní nefakturované údaje o využití můžete načíst prostřednictvím rozhraní API nebo portálu Partnerského centra. Zpřístupnění dat může trvat až 24 hodin. V závislosti na vaší poloze a na tom, kdy měřiče hlásí využití, ale může docházet k dalším zpožděním.

Někdy se nemusí zobrazit nejnovější nefakturovaná data o využití, dokud se nedoručí fakturovaná data o využití za předchozí měsíc. Tím zajistíte, že se fakturovaná data o využití doručí v rámci schváleného času. Jakmile obdržíte fakturovaná data o využití, měli byste být schopni načíst všechna aktualizovaná nefakturovaná data o využití od začátku měsíce.

Požadavky

Přihlašovací údaje popsané v ověřování v Partnerském centru Tento scénář podporuje ověřování pomocí samostatných přihlašovacích údajů aplikace i aplikace a uživatele.

C#

Získání řádkových položek pro zadanou fakturu:

Voláním metody ById získáte rozhraní pro operace faktury pro zadanou fakturu.
Voláním metody Get nebo GetAsync načtěte objekt faktury.

Objekt faktury obsahuje všechny informace o zadané faktuře. Zprostředkovatel identifikuje zdroj nefakturovaných podrobných informací (například OneTime). InvoiceLineItemType určuje typ (například UsageLineItem).

Následující ukázkový kód používá smyčku foreach ke zpracování kolekce InvoiceLineItems . Pro každou invoiceLineItemType se načte samostatná kolekce řádkových položek.

Získání kolekce řádkových položek, které odpovídají instanci InvoiceDetail :

Předejte instanci BillingProvider a InvoiceLineItemType metodě.
Volání Get nebo GetAsync metoda načíst přidružené řádkové položky.
Vytvořte enumerátor pro procházení kolekce, jak je znázorněno v následujícím příkladu.

// IAggregatePartner partnerOperations;
// 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("unbilled").By("onetime", "usagelineitems", curencyCode, period, pageMaxSizeReconLineItems).Get();

var fetchNext = true;

ConsoleKeyInfo keyInfo;

var itemNumber = 1;
while (fetchNext)
{
    Console.Out.WriteLine("\tLine 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("unbilled").By("onetime", "usagelineitems", curencyCode, period, pageMaxSizeReconLineItems).Seek(seekBasedResourceCollection.ContinuationToken, SeekOperation.Next);
        }
    }
}

Podobný příklad najdete tady:

Ukázka: Konzolová testovací aplikace
Projekt: Ukázky sady SDK v Partnerském centru
Třída: GetUnBilledConsumptionReconLineItemsPaging.cs

Požadavek REST

Syntaxe požadavku

V závislosti na vašem případu použití můžete pro požadavek REST použít následující syntaxe. Další informace najdete v popisech jednotlivých syntaxí.

metoda	Identifikátor URI žádosti	Popis případu použití syntaxe
GET	{baseURL}/v1/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period} HTTP/1.1	Tato syntaxe slouží k vrácení úplného seznamu každé řádkové položky pro danou fakturu.
GET	{baseURL}/v1/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period}&size={size} HTTP/1.1	Tuto syntaxi použijte pro velké faktury. Pomocí této syntaxe se zadanou velikostí a posunem na základě 0 vrátíte stránkovaný seznam řádků.
GET	{baseURL}/v1/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period}&size={size}&seekOperation=Next	Pomocí této syntaxe získáte další stránku položek řádku odsouhlasení pomocí `seekOperation = "Next"`.

Parametry identifikátoru URI

Při vytváření požadavku použijte následující identifikátor URI a parametry dotazu.

Name	Type	Požadováno	Popis
Zprostředkovatel	string	Ano	Zprostředkovatel: OneTime.
invoice-line-item-type	string	Ano	Typ podrobností faktury: UsageLineItems, UsageLineItems.
currencyCode	string	Ano	Kód měny pro nefakturované řádkové položky.
Období	string	Ano	Období nefakturované rekonce (například aktuální, předchozí). Předpokládejme, že potřebujete zadávat dotazy na nefakturované údaje o využití fakturačního období (1. 1. 2020 – 31. 1. 2020) v lednu, zvolte období jako Aktuální, jinak Předchozí.
size	Číslo	No	Maximální počet položek, které se mají vrátit. Výchozí velikost je 2000.
seekOperation	string	No	Nastavte `seekOperation=Next` , aby se na další stránce řádkových položek s vyrovnáním získaly.

Záhlaví žádosti

Další informace najdete v tématu Hlavičky REST Partnerského centra.

Text požadavku

Nezaokrouhlovat.

Odpověď REST

V případě úspěchu odpověď obsahuje kolekci podrobností o položce řádku.

U položky řádku ChargeType je hodnota Nákup namapována na Nový a hodnota Refundace je namapována na Storno.

Kódy úspěšnosti a chyb odpovědi

Každá odpověď obsahuje stavový kód HTTP, který označuje úspěch nebo selhání a další informace o ladění. Ke čtení tohoto kódu, typu chyby a dalších parametrů použijte nástroj pro trasování sítě. Úplný seznam najdete v tématu Kódy chyb REST v Partnerském centru.

Příklady odpovědí na žádosti

Příklad odpovědi požadavku 1

Následující podrobnosti platí pro tento příklad:

Zprostředkovatel: OneTime
InvoiceLineItemType: UsageLineItems
Období: Předchozí

Příklad požadavku 1

GET https://api.partnercenter.microsoft.com/v1//invoices/unbilled/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