Hämta radobjekt för ofakturerad kommersiell förbrukning

Artikel
03/08/2025

Anmärkning

Datum och scenarier för nyckelmigrering

Övergångsstrategin för API-versionen är utformad för att säkerställa en smidig migrering från API v1 till API v2, med fokus på att upprätthålla funktionalitet och dataintegritet. Här är en guide som hjälper dig att välja lämplig API-version för dina behov:

Scenario A: Aktuella eller tidigare faktureringsperioder (före 21 april 2025):

Fortsätt använda det här API:et till den 21 april 2025, såvida du inte redan har övergått till API v2 GA.

scenario B: Aktuella eller tidigare faktureringsperioder (efter 21 april 2025):

Växla till API v2 GA- för all framtida datahämtning under faktureringsperioden.

Övergången från API v1 till API v2 omfattar detaljerad planering och exakt körning. För att säkerställa en smidig övergång till det nya API:t, besök: API för daglig avstämning av fakturerad och ej fakturerad användning v2 (GA).

Vi uppskattar din uppmärksamhet och har åtagit oss att stödja din fortsatta framgång med våra fakturerings-API:er.

Så här hämtar du en samling med information om icke-fakturerade kommersiella förbrukningsartiklar.

Du kan använda följande metoder för att hämta en samling av kommersiella förbrukningsradobjekt som inte är fakturerade (kallas även öppna förbrukningsradobjekt) programmässigt.

Viktigt!

De dagliga betygssatta användningsdata inkluderar inte avgifterna för dessa produkter:

Azure reservation
Azure-besparingsprenumeration
Kontor
Dynamik
Microsoft Power Apps
Permanent programvara
Prenumeration på programvara
SaaS-produkt som inte är från Microsoft eller marknadsplatsen

Kommentar

Du kan komma åt dina ofakturerade dagliga debiterade användningsobjekt genom API:t eller Partner Center-portalen. För att säkerställa datanoggrannhet kan du tillåta upp till 24 timmar för tillgänglighet. Beroende på din plats och när mätarna rapporterar användningen kan det uppstå ytterligare fördröjningar.

Vi prioriterar tidsleverans av fakturerade dagliga användningsdata först. Ibland kanske det senaste ej fakturerade dagliga debiterade användningsdatat inte visas förrän föregående månads fakturerade data är tillgängliga. När du har fått de fakturerade data kan du sedan komma åt alla uppdaterade ej fakturerade användningsdata från början av månaden.

Viktiga punkter:

Tillåt upp till 24 timmar för datatillgänglighet.
Det kan uppstå ytterligare fördröjningar beroende på din plats och mätarrapporteringstider.
Fakturerade dagliga användningsdata prioriteras framför ej fakturerade data.

Din förståelse och ditt tålamod uppskattas när vi strävar efter att tillhandahålla så exakt och snabb information som möjligt.

Förutsättningar

Autentiseringsuppgifter som beskrivs i Partnercenter-autentisering. Det här scenariot stöder autentisering med både fristående app- och App+User-autentiseringsuppgifter.

C#

Så här hämtar du radobjekten för den angivna fakturan:

Anropa metoden ById för att få ett gränssnitt till fakturaoperationer för den angivna fakturan.
Anropa metoden Get eller GetAsync för att hämta fakturaobjektet.

Fakturaobjektet innehåller all information för den angivna fakturan. Provider identifierar källan till den ej fakturerade detaljinformationen (till exempel OneTime). InvoiceLineItemType anger typen (till exempel UsageLineItem).

I följande exempelkod används en foreach-loop för att bearbeta samlingen InvoiceLineItems . En separat samling radobjekt hämtas för varje InvoiceLineItemType.

Så här hämtar du en samling radobjekt som motsvarar en InvoiceDetail-instans :

Skicka instansens BillingProvider och InvoiceLineItemType till By metoden.
Anropa metoden Get eller GetAsync för att hämta de associerade radposter.
Skapa en uppräknare för att bläddra i samlingen enligt följande exempel.

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

Ett liknande exempel finns i:

Exempel: Konsoltestapp
Projekt: SDK-exempel för Partnercenter
Klass: GetUnBilledConsumptionReconLineItemsPaging.cs

REST-begäran

Syntax för begäran

Du kan använda följande syntaxer för din REST-begäran, beroende på ditt användningsfall. Mer information finns i beskrivningarna för varje syntax.

Metod	URI för förfrågan	Beskrivning av användningsfall för syntax
GET	{baseURL}/v1/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period} HTTP/1.1	Använd den här syntaxen för att returnera en fullständig lista över varje radobjekt för den angivna fakturan.
GET	{baseURL}/v1/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period}&size={size} HTTP/1.1	Använd den här syntaxen för stora fakturor. Använd den här syntaxen med en angiven storlek och en 0-baserad förskjutning för att returnera en sidlista med radobjekt.
GET	{baseURL}/v1/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period}&size={size}&seekOperation=Next	Använd den här syntaxen för att hämta nästa sida med avstämningsposter med hjälp av `seekOperation = "Next"`.

URI-parametrar

Använd följande URI- och frågeparametrar när du skapar begäran.

Namn	Typ	Obligatoriskt	Beskrivning
leverantör	sträng	Ja	Leverantören: “OneTime”.
fakturaradsposttyp	sträng	Ja	Typ av fakturainformation: "UsageLineItems", "UsageLineItems".
valutakod	sträng	Ja	Valutakoden för de icke-fakturerade radobjekten.
period	sträng	Ja	Perioden för ej fakturerad rekognosering (till exempel aktuell, föregående). Anta att du behöver fråga dina ej fakturerade användningsdata för faktureringscykeln (01/01/2020 – 2020-01-31) i januari, välj period som "Aktuell", annars "Föregående".
storlek	Nummer	Nej	Det maximala antalet objekt som ska returneras. Standardstorleken är 2 000.
sökoperation	sträng	Nej	Ange `seekOperation=Next` för att få nästa sida med avstämningsposter.

Begäran-rubriker

För mer information, se Partnercenter REST-huvuden.

Förfrågans innehåll

Inga.

REST-svar

Om det lyckas innehåller svaret samlingen med radobjektsinformation.

För radobjektet ChargeType mappas värdet Purchase till New och värdet Refund mappas till Cancel.

Svarsframgång och felkoder

Varje svar levereras med en HTTP-statuskod som anger lyckad eller misslyckad och annan felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och fler parametrar. Se den fullständiga listan i Partner Center REST-felkoder.

Exempel på begärandesvar

Exempel på begäran-svar 1

Följande information gäller för det här exemplet:

Provider: OneTime
InvoiceLineItemType: UsageLineItems
Period: Föregående

Exempel på begäran 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: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
MS-PartnerCenter-Application: Partner Center .NET SDK Samples
Host: api.partnercenter.microsoft.com

Viktigt!

Från och med juni 2023 arkiveras nu den senaste Partner Center .NET SDK-versionen 3.4.0. Du kan ladda ned SDK-versionen från GitHub tillsammans med en readme-fil som innehåller användbar information.

Partners uppmuntras att fortsätta använda Partner Center REST-API:er.

Svarsexempel 1

HTTP/1.1 200 OK
Content-Length: 2484
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 1234ecb8-37af-45f4-a1a1-358de3ca2b9e
MS-CV: bpqyomePDUqrSSYC.0
MS-ServerId: 202010406
Date: Wed, 20 Feb 2019 19:59:27 GMT

{
    "totalCount": 2,
    "items": [
        {
            "partnerId": "00083575-bbd0-54de-b2ad-0f5b0e927d71",
            "partnerName": "MTBC",
            "customerId": "",
            "customerName": "",
            "customerDomainName": "",
            "invoiceNumber": "",
            "productId": "",
            "skuId": "",
            "availabilityId": "",
            "skuName": "VM-Series Next-Generation Firewall (Bundle 2 PAYG)",
            "productName": "VM-Series Next Generation Firewall",
            "publisherName": "Test Alto Networks, Inc.",
            "publisherId": "",
            "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
            "subscriptionDescription": "Pay-As-You-Go",
            "chargeStartDate": "2019-01-01T00:00:00Z",
            "chargeEndDate": "2019-02-01T00:00:00Z",
            "usageDate": "2019-01-01T00:00:00Z",
            "meterType": "1 Compute Hour - 4core",
            "meterCategory": "Virtual Machine Licenses",
            "meterId": "4core",
            "meterSubCategory": "VM-Series Next Generation Firewall",
            "meterName": "VM-Series Next Generation Firewall - VM-Series Next-Generation Firewall (Bundle 2 PAYG) - 4 Core Hours",
            "meterRegion": "",
            "unitOfMeasure": "1 Hour",
            "resourceLocation": "EASTUS",
            "consumedService": "Microsoft.Compute",
            "resourceGroup": "ECH-PAN-RG",
            "resourceUri": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/ECH-PAN-RG/providers/Microsoft.Compute/virtualMachines/echpanfw",
            "tags": "",
            "additionalInfo": "{  \"ImageType\": null,  \"ServiceType\": \"Standard_D3_v2\",  \"VMName\": null,  \"VMProperties\": null,  \"UsageType\": \"ComputeHR_SW\"}",
            "serviceInfo1": "",
            "serviceInfo2": "",
            "customerCountry": "",
            "mpnId": "1234567",
            "resellerMpnId": "",
            "chargeType": "",
            "unitPrice": 1.2799888920023,
            "quantity": 24.0,
            "unitType": "",
            "billingPreTaxTotal": 30.7197334080551,
            "billingCurrency": "USD",
            "pricingPreTaxTotal": 30.7197334080551,
            "pricingCurrency": "USD",
            "entitlementId": "3f47bcf1-965d-40a1-a2bc-3d5db3653250",
            "entitlementDescription": "Partner Subscription",
            "pcToBCExchangeRate": 1,
            "pcToBCExchangeRateDate": "2019-08-01T00:00:00Z",
            "effectiveUnitPrice": 0,
            "rateOfPartnerEarnedCredit": 0,
            "rateOfCredit": 0,
            "creditType": "Credit Not Applied",
            "invoiceLineItemType": "usage_line_items",
            "billingProvider": "marketplace",
        "benefitOrderId": "5ea053d6-4a0d-46ef-bc82-15065b475d01",
        "benefitId": "28ddab06-2c5b-479e-88bb-7b7bfda4e7fd",
        "benefitType": "SavingsPlan",
            "attributes": {
                "objectType": "DailyRatedUsageLineItem"
            }
         },
         {
            "partnerId": "00083575-bbd0-54de-b2ad-0f5b0e927d71",
            "partnerName": "MTBC",
            "customerId": "",
            "customerName": "",
            "customerDomainName": "",
            "invoiceNumber": "",
            "productId": "",
            "skuId": "",
            "availabilityId": "",
            "skuName": "VM-Series Next-Generation Firewall (Bundle 2 PAYG)",
            "productName": "VM-Series Next Generation Firewall",
            "publisherName": "Test Alto Networks, Inc.",
            "publisherId": "",
            "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
            "subscriptionDescription": "Pay-As-You-Go",
            "chargeStartDate": "2019-01-01T00:00:00Z",
            "chargeEndDate": "2019-02-01T00:00:00Z",
            "usageDate": "2019-01-02T00:00:00Z",
            "meterType": "1 Compute Hour - 4core",
            "meterCategory": "Virtual Machine Licenses",
            "meterId": "4core",
            "meterSubCategory": "VM-Series Next Generation Firewall",
            "meterName": "VM-Series Next Generation Firewall - VM-Series Next-Generation Firewall (Bundle 2 PAYG) - 4 Core Hours",
            "meterRegion": "",
            "unitOfMeasure": "1 Hour",
            "resourceLocation": "EASTUS",
            "consumedService": "Microsoft.Compute",
            "resourceGroup": "ECH-PAN-RG",
            "resourceUri": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/ECH-PAN-RG/providers/Microsoft.Compute/virtualMachines/echpanfw",
            "tags": "",
            "additionalInfo": "{  \"ImageType\": null,  \"ServiceType\": \"Standard_D3_v2\",  \"VMName\": null,  \"VMProperties\": null,  \"UsageType\": \"ComputeHR_SW\"}",
            "serviceInfo1": "",
            "serviceInfo2": "",
            "customerCountry": "",
            "mpnId": "1234567",
            "resellerMpnId": "",
            "chargeType": "",
            "unitPrice": 1.2799888920023,
            "quantity": 24.0,
            "unitType": "",
            "billingPreTaxTotal": 30.7197334080551,
            "billingCurrency": "USD",
            "pricingPreTaxTotal": 30.7197334080551,
            "pricingCurrency": "USD",
            "entitlementId": "31cdf47f-b249-4edd-9319-637862d12345",
            "entitlementDescription": "Partner Subscription",
            "pcToBCExchangeRate": 1,
            "pcToBCExchangeRateDate": "2019-08-01T00:00:00Z",
            "effectiveUnitPrice": 0,
            "rateOfPartnerEarnedCredit": 0,
            "rateOfCredit": 1,
            "creditType": "Azure Credit Applied",
            "invoiceLineItemTypce": "usage_line_items",
            "billingProvider": "marketplace",
        "benefitOrderId": "",
            "benefitId": "",
            "benefitType": "Charge",
            "attributes": {
                "objectType": "DailyRatedUsageLineItem"
            }
        }
    ],
    "links": {
        "self": {
            "uri": "/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems&currencycode=usd&period=previous&size=2000",
            "method": "GET",
            "headers": []
        },
        "next": {
            "uri": "/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems&currencycode=usd&period=previous&size=2000&seekOperation=Next",
            "method": "GET",
            "headers": [
                {
                    "key": "MS-ContinuationToken",
                    "value": "AQAAAA=="
                }
            ]
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
}

Exempel på begäran-svar 2