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

Artikel
04/26/2024

Kommentar

Efter den 30 september 2024 kommer det här API:et inte längre att fungera. Använd informationen för att välja din version och planera i förväg.

Använd det här API:et för att få åtkomst till information om den dagliga användningen som inte fakturerats för aktuella och tidigare faktureringsperioder. Du kan använda den fram till den 30 september 2024, såvida du inte byter till v2 GA före det datumet.
Växla till API v2 GA senast den 30 september 2024 för att hämta ej fakturerad daglig användning för aktuella och tidigare perioder.

För API v2-migreringssteg går du till:

Fakturerad och ej fakturerad dagligen klassificerad användningsavstämning API v2 (GA)

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 med information som inte faktureras kommersiella förbrukningsradobjekt (kallas även öppna användningsradsobjekt) programmatiskt.

Viktigt!

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

Azure-reservation
Azure-besparingsprenumeration
Office
Dynamics
Microsoft Power Apps
Evig programvara
Prenumeration på programvara
Marketplace SaaS-produkt

Kommentar

Du kan hämta dina dagliga ej fakturerade användningsdata via API: et eller Partnercenter-portalen. Det kan ta upp till 24 timmar innan data blir tillgängliga. Det kan dock uppstå ytterligare fördröjningar beroende på din plats och när mätarna rapporterar användningen.

Ibland kanske du inte ser de senaste ofakturerade användningsdata förrän de fakturerade användningsdata för föregående månad har levererats. Detta görs för att säkerställa att fakturerade användningsdata levereras inom den överenskomna tiden. När du har fått de fakturerade användningsdata bör du kunna hämta alla uppdaterade ej fakturerade användningsdata från början av månaden.

Förutsättningar

Autentiseringsuppgifter enligt beskrivningen 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 hämta ett gränssnitt för fakturaåtgärder 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. Providernidentifierar källan till den ej fakturerade informationsinformationen (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 metoden By .
Anropa metoden Get eller GetAsync för att hämta de associerade radobjekten.
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ämningsradsobjekt 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
provider	sträng	Ja	Providern: "OneTime".
invoice-line-item-type	sträng	Ja	Typ av fakturainformation: "UsageLineItems", "UsageLineItems".
currencyCode	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.
seekOperation	sträng	Nej	Ange `seekOperation=Next` för att hämta nästa sida med avstämningsradobjekt.

Begärandehuvuden

Mer information finns i REST-huvuden för Partnercenter.

Begärandetext

Inga.

REST-svar

Om det lyckas innehåller svaret samlingen med radobjektsinformation.

För radartikeln ChargeType mappas värdet Köp till Nytt och värdet Återbetalning mappas till Avbryt.

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. Den fullständiga listan finns i Rest-felkoder för Partnercenter.

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: 5e612512-4345-4bb0-866e-47aeda031234
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.

Partner uppmuntras att fortsätta använda REST-API:er för Partnercenter.

Svarsexempel 1

HTTP/1.1 200 OK
Content-Length: 2484
Content-Type: application/json; charset=utf-8
MS-CorrelationId: 5e612512-4345-4bb0-866e-47aeda031234
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": "12345678-04d9-421c-baf8-e3b8dd62ddba",
            "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/12345678-04d9-421c-baf8-e3b8dd62ddba/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": "12345678-04d9-421c-baf8-e3b8dd62ddba",
            "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/12345678-04d9-421c-baf8-e3b8dd62ddba/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