计费发票对帐 API v2 （GA）

适用于： 合作伙伴中心（主权云中不可用）

我们的异步 API 提供了一种更快、更易管理的方式，用于通过 Azure Blob 访问计费和对帐数据。 使用此 API 时，无需将连接保持打开数小时，也无需一次循环访问包含 2,000 行项的批。

我们已使用代客密钥和异步请求-回复模式优化了新的商务计费发票对帐 API。 此 API 提供共享访问签名 （SAS） 令牌，可用于访问所有属性或计费发票对帐数据的子集。

API 概述

若要异步检索计费 的新商务 发票对帐数据，请使用两个 API 终结点。 下面介绍了该过程：

计费发票对帐终结点

使用此 API 检索 新的商务 计费发票对帐行项。 API 返回 202 HTTP 状态和包含 URL 的位置标头。 定期轮询此 URL，直到收到清单 URL 的成功状态。

操作状态终结点

若要获取成功状态，请定期调用此 API。 如果数据尚未准备就绪，API 响应将包含“重试后”标头，告知在重试之前等待多长时间。 操作完成后，你将获得包含存储文件夹的清单资源，可在其中下载使用情况数据。 响应将文件分解为较小的部分，以便优化吞吐量和 I/O 并行度。

序列图

下面是一个序列图，其中显示了下载新的商业发票对帐数据的步骤。

用户操作序列

若要检索计费的发票对帐数据，请执行以下步骤：

步骤 1：提交请求

将 POST 请求提交到 API 终结点。

获取计费发票对帐行项

API 请求

POST https://graph.microsoft.com/v1.0/reports/partners/billing/reconciliation/billed/export

Accept: application/json

Content-Type: application/json

{

"invoiceId": "G016907411",

"attributeSet": "basic"

}

Query parameters

空值

请求正文

请求标头

使用最佳做法中列出的 步骤为 API 请求标头，以使用 Microsoft Graph。

API 响应

HTTP/1.1 202 Accepted  
Location: <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>

API 通常以 HTTP 202 状态进行响应。 本文中的标准 API 响应状态中列出了其他可能的状态，具体取决于你的请求。

步骤 2：检查请求状态

若要检查请求的状态，请等待状态为“成功”或“失败”的 HTTP 200 响应。如果请求成功，则会在“resourceLocation”属性中获取清单 URL。

获取操作状态

检索请求的状态。

API 请求

GET <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>

请求参数

请求头文件

使用最佳做法中列出的 步骤为 API 请求标头，以使用 Microsoft Graph。

请求正文

不适用。

响应状态

除了本文中标准 API 响应状态中列出的 标准 HTTP 状态 外，API 还可以返回以下 HTTP 状态：

响应有效负载

API 响应有效负载包括以下属性：

资源位置对象

API 请求

GET <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>

API 响应

响应建议在数据仍在处理之前等待 10 秒。

HTTP/1.1 200 OK  
Retry-After: 10  
{  
"id": "9ab9cb54-d07f-4f52-9ea6-a09d7de52c14",  
"createdDateTime": "2022-06-1T10-01-03.4Z",  
"lastActionDateTime": "2022-06-1T10-01-05Z",  
"status": "running"  
}

API 请求

（上一个请求后的 10 秒...）

GET <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>

API 响应

API 返回“resourceLocation”的“成功”状态和 URI。

HTTP/1.1 200 OK  
Content-Type: application/json  
{

    "@odata.context": "https://graph.microsoft.com/v1.0/\$metadata#reports/partners/billing/operations/\$entity",

    "@odata.type": "#microsoft.graph.partners.billing.exportSuccessOperation",

    "id": "f2170b13-6a8e-47d6-b481-6988490dc0cb",

    "createdDateTime": "2023-12-05T21:17:29Z",

    "lastActionDateTime": "2023-12-05T21:18:00.8897902Z",

    "status": "succeeded",

    "resourceLocation": {

        "id": "44e8500b-ab92-490e-8ac3-90500a1d3427",

        "createdDateTime": "2023-11-06T19:58:47.513Z",

        "schemaVersion": "2",

        "dataFormat": "compressedJSON",

        "partitionType": "default",

        "eTag": "RwDrn7fbiTXy6UULE",

        "partnerTenantId": "0e195b37-4574-4539-bc42-0e539b9684c0",

        "rootDirectory": "https://adlsreconbuprodeastus201.blob.core.windows.net/path_id",

        "sasToken": "{token}",

        "blobCount": 1,

        "blobs": \[

            {

                "name": "part-00123-5a93fa5d-749f-48bc-a372-9b021d93c3fa.c000.json.gz",

                "partitionValue": "default"

            }

        \]

    }

}

步骤 3：从 Azure Blob 存储下载计费发票对帐数据

从清单有效负载 API 响应的“sasToken”和“rootDirectory”属性获取共享访问签名（SAS）令牌和 Blob 存储位置。 Azure 存储 SDK/tool 下载和解压缩 blob 文件。 它采用 JSONLines 格式。

标准 API 响应状态

可以从 API 的响应中获取这些 HTTP 状态：

计费发票对帐数据属性

若要比较“完整”或“基本”属性集的计费发票对帐 API 返回的属性，请参阅下表。 若要了解有关这些属性的详细信息，请参阅 “使用对帐文件”。

代码示例

有关使用 API 的指导，请参阅以下链接，其中包含 C# 中的示例代码。

Partner-Center-Billing-Recon-Samples：用于从合作伙伴中心获取计费对帐数据的 API 示例（github.com）。