取得未開立發票的使用量明細項目

發行項
04/26/2024

注意

在 2024 年 9 月 30 日之後，此 API 將不再運作。使用資訊來預先選擇您的版本和計劃。

若要存取目前和先前計費期間未計費的每日使用量詳細數據，請使用此 API。除非在該日期之前切換到 v2 GA，否則您可以使用它，直到 2024 年 9 月 30 日為止。
若要取得目前和先前期間未計費的每日評等使用量，請在 2024 年 9 月 30 日之前切換至 API v2 GA。

針對 API v2 移轉步驟，請移至：

計費和未計費的每日評等使用量對帳 API v2 （GA）

如何取得未計費商業耗用量明細項目詳細數據的集合。

您可以使用下列方法，以程序設計方式取得未計費商業耗用量明細專案的詳細數據集合（也稱為開啟使用明細專案）。

重要

每日評等使用量數據不包含這些產品的費用：

Azure 保留
Azure 節省方案
Office
Dynamics
Microsoft Power Apps
永久軟體
軟體訂閱
Marketplace SaaS 產品

注意

您可以透過 API 或合作夥伴中心入口網站擷取每日未計費的使用量數據。最多可能需要 24 小時的時間，數據才會可供使用。不過，視您的位置和計量報告使用量而定，可能會有進一步的延遲。

有時候，在傳遞前一個月的計費使用量數據之前，您可能不會看到最新的未計費使用量數據。這樣做可確保已計費的使用量數據會在同意的時間內傳遞。收到計費使用量數據之後，您應該能夠從當月開始擷取所有已更新的未計費使用量數據。

必要條件

認證，如合作夥伴中心驗證所述。此案例支援使用獨立應用程式和 App+使用者認證進行驗證。

C#

若要取得指定發票的明細專案：

呼叫 ById 方法，以取得指定發票的發票作業介面。
呼叫 Get 或 GetAsync 方法來擷取發票物件。

invoice 物件包含指定發票的所有資訊。 提供者會識別未計費詳細資訊的來源（例如 OneTime）。 InvoiceLineItemType 會指定類型（例如 UsageLineItem）。

下列範例程式代碼會使用 foreach 循環來處理 InvoiceLineItems 集合。系統會 為每個 InvoiceLineItemType 擷取個別的明細專案集合。

若要取得對應至 InvoiceDetail 實例的明細專案集合：

將實例的 BillingProvider 和 InvoiceLineItemType 傳遞至 By 方法。
呼叫 Get 或 GetAsync 方法來擷取相關聯的明細專案。
建立列舉值以周游集合，如下列範例所示。

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

如需類似的範例，請參閱：

範例：控制台測試應用程式
專案： 合作夥伴中心 SDK 範例
類別： GetUnBilledConsumptionReconLineItemsPaging.cs

REST 要求

要求語法

視您的使用案例而定，您可以針對 REST 要求使用下列語法。如需詳細資訊，請參閱每個語法的描述。

方法	要求 URI	語法使用案例的描述
取得	{baseURL}/v1/invoices/unbilled/lineitems？provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period} HTTP/1.1	使用此語法可傳回指定發票之每個明細專案的完整清單。
取得	{baseURL}/v1/invoices/unbilled/lineitems？provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period}&size={size} HTTP/1.1	將此語法用於大型發票。使用此語法搭配指定的大小和以 0 為基礎的位移，可傳回分頁的明細項目清單。
取得	{baseURL}/v1/invoices/unbilled/lineitems？provider=onetime&invoicelineitemtype=usagelineitems¤cycode={currencycode}&period={period}&size={size}&seekOperation=Next	使用此語法，即可使用 `seekOperation = "Next"`取得對帳明細專案的下一頁。

URI 參數

建立要求時，請使用下列 URI 和查詢參數。

名稱	類型	必要	描述
Provider - 提供者	字串	Yes	提供者：「OneTime」。
invoice-line-item-type	字串	Yes	發票詳細數據的類型：「UsageLineItems」、“UsageLineItems”
currencyCode	字串	Yes	未計費明細項目的貨幣代碼。
Period	字串	Yes	未計費對帳的期間（例如：目前、上一個）。假設您需要查詢計費週期（2020/01/01/ 2020 – 01/31/2020）的未計費使用量數據，請選擇期間為「目前」，否則為「上一個」。
size	數值	No	要傳回的項目數上限。默認大小為 2000。
seekOperation	字串	No	設定 `seekOperation=Next` 為取得對帳明細專案的下一頁。

要求標頭

如需詳細資訊，請參閱合作夥伴中心 REST 標頭。

要求本文

無。

REST 回應

如果成功，回應會包含明細專案詳細數據的集合。

對於明細專案 ChargeType，[購買] 值會對應至 [新增]，而 [退款] 值會對應至 [取消]。

回應成功和錯誤碼

每個回應都有一個 HTTP 狀態代碼，指出成功或失敗和其他偵錯資訊。使用網路追蹤工具來讀取此程式代碼、錯誤類型等等參數。如需完整清單，請參閱合作夥伴中心的 REST 錯誤碼。

要求回應範例

要求回應範例 1

下列詳細資料適用於此範例：

提供者： OneTime
InvoiceLineItemType： UsageLineItems
期間：上一個

要求範例 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

重要

自 2023 年 6 月起，最新的合作夥伴中心 .NET SDK 3.4.0 版現已封存。您可以從 GitHub 下載 SDK 版本，以及包含實用資訊的自述檔。

鼓勵合作夥伴繼續使用合作夥伴中心 REST API。

回應範例 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"
    }
}

要求回應範例 2