Ottenere le voci di utilizzo commerciale non fatturate

Articolo
04/26/2024

Nota

Dopo il 30 settembre 2024, questa API non funzionerà più. Usare le informazioni per scegliere la versione e pianificare in anticipo.

Per accedere ai dettagli di utilizzo giornalieri non fatturati per i periodi di fatturazione correnti e precedenti, usare questa API. È possibile usarlo fino al 30 settembre 2024, a meno che non si passi alla versione 2 ga prima di tale data.
Per ottenere un utilizzo giornaliero non fatturato per i periodi correnti e precedenti, passare all'API v2 GA entro il 30 settembre 2024.

Per i passaggi di migrazione dell'API v2, passare a:

API di riconciliazione dell'utilizzo con fatturazione e non fatturata giornaliera v2 (GA)

Come ottenere una raccolta di dettagli della riga di utilizzo commerciale non fatturati.

È possibile utilizzare i metodi seguenti per ottenere una raccolta di dettagli non fatturati voci di utilizzo commerciale (note anche come voci di utilizzo aperte) a livello di codice.

Importante

I dati di utilizzo valutati giornalieri non includono gli addebiti per questi prodotti:

Prenotazione di Azure
Piano di risparmio di Azure
Office
Dynamics
Microsoft Power Apps
Software perpetuo
Sottoscrizione software
Prodotto SaaS marketplace

Nota

È possibile recuperare i dati di utilizzo non fatturati giornalieri tramite l'API o il portale del Centro per i partner. La disponibilità dei dati può richiedere fino a 24 ore. Tuttavia, potrebbero verificarsi ulteriori ritardi a seconda della posizione e quando i contatori segnalano l'utilizzo.

In alcuni casi, è possibile che non vengano visualizzati i dati di utilizzo non fatturati più recenti fino a quando non vengono recapitati i dati di utilizzo fatturati per il mese precedente. Questa operazione viene eseguita per garantire che i dati di utilizzo fatturati vengano recapitati entro il tempo concordato. Dopo aver ricevuto i dati di utilizzo fatturati, dovrebbe essere possibile recuperare tutti i dati di utilizzo non fatturati aggiornati dall'inizio del mese.

Prerequisiti

Credenziali descritte in Autenticazione del Centro per i partner. Questo scenario supporta l'autenticazione con le credenziali app autonome e App+Utente.

C#

Per ottenere le voci per la fattura specificata:

Chiamare il metodo ById per ottenere un'interfaccia alle operazioni della fattura per la fattura specificata.
Chiamare il metodo Get o GetAsync per recuperare l'oggetto fattura.

L'oggetto fattura contiene tutte le informazioni per la fattura specificata. Il provider identifica l'origine delle informazioni dettagliate non fatturate, ad esempio OneTime. InvoiceLineItemType specifica il tipo , ad esempio UsageLineItem.

Il codice di esempio seguente usa un ciclo foreach per elaborare l'insieme InvoiceLineItems . Viene recuperata una raccolta separata di elementi riga per ogni InvoiceLineItemType.

Per ottenere una raccolta di voci che corrispondono a un'istanza invoiceDetail :

Passare l'oggetto BillingProvider e InvoiceLineItemType dell'istanza al metodo By.
Chiamare il metodo Get o GetAsync per recuperare gli elementi di riga associati.
Creare un enumeratore per attraversare la raccolta, come illustrato nell'esempio seguente.

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

Per un esempio simile, vedere:

Esempio: App di test della console
Progetto: Esempi di SDK del Centro per i partner
Classe: GetUnBilledConsumptionReconLineItemsPaging.cs

Richiesta REST

Sintassi della richiesta

È possibile usare le sintassi seguenti per la richiesta REST, a seconda del caso d'uso. Per altre informazioni, vedere le descrizioni per ogni sintassi.

metodo	URI della richiesta	Descrizione del caso d'uso della sintassi
GET	{baseURL}/v1/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period} HTTP/1.1	Utilizzare questa sintassi per restituire un elenco completo di ogni voce per la fattura specificata.
GET	{baseURL}/v1/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period}&size={size} HTTP/1.1	Usare questa sintassi per le fatture di grandi dimensioni. Utilizzare questa sintassi con una dimensione specificata e un offset basato su 0 per restituire un elenco di voci di paging.
GET	{baseURL}/v1/invoices/unbilled/lineitems?provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period}&size={size}&seekOperation=Next	Usare questa sintassi per ottenere la pagina successiva degli elementi della riga di riconciliazione usando `seekOperation = "Next"`.

Parametri URI

Usare gli URI e i parametri di query seguenti durante la creazione della richiesta.

Nome	Digita	Obbligatorio	Descrizione
provider	string	Sì	Provider: "OneTime".
invoice-line-item-type	string	Sì	Tipo di dettaglio fattura: "UsageLineItems", "UsageLineItems".
currencyCode	string	Sì	Codice di valuta per gli elementi di riga non fatturati.
period	string	Sì	Periodo di riconciliazione non fatturata (ad esempio: corrente, precedente). Si supponga di dover eseguire una query sui dati di utilizzo non fatturati del ciclo di fatturazione (01/01/2020 - 31/01/2020) nel mese di gennaio, scegliere periodo come "Corrente", altrimenti "Indietro".
size	number	No	Numero massimo di elementi da restituire. La dimensione predefinita è 2000.
seekOperation	string	No	Impostare `seekOperation=Next` per ottenere la pagina successiva delle voci di riconciliazione.

Intestazioni delle richieste

Per altre informazioni, vedi Intestazioni REST del Centro per i partner.

Corpo della richiesta

Nessuno.

Risposta REST

In caso di esito positivo, la risposta contiene la raccolta di dettagli dell'elemento di riga.

Per l'elemento riga ChargeType, il valore Purchase viene mappato a Nuovo e il valore Rimborso viene mappato a Annulla.

Codici di errore e di esito della risposta

Ogni risposta viene fornita con un codice di stato HTTP che indica l'esito positivo o negativo e altre informazioni di debug. Usare uno strumento di traccia di rete per leggere questo codice, il tipo di errore e altri parametri. Per l'elenco completo, vedi Codici di errore REST del Centro per i partner.

Esempi di richiesta-risposta

Esempio di richiesta-risposta 1

I dettagli seguenti si applicano a questo esempio:

Provider: OneTime
InvoiceLineItemType: UsageLineItems
Periodo: Precedente

Esempio di richiesta 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

Importante

A partire da giugno 2023, la versione più recente di .NET SDK del Centro per i partner 3.4.0 è ora archiviata. È possibile scaricare la versione dell'SDK da GitHub, insieme a un file leggimi che contiene informazioni utili.

I partner sono invitati a continuare a usare le API REST del Centro per i partner.

Esempio di risposta 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"
    }
}

Esempio di richiesta-risposta 2