建立收益匯出請求

使用此 API 將新的收益和基礎交易/付款數據匯出要求排入佇列，並搭配選擇性篩選來切割收益和交易數據。 它會傳回 202 HTTP 狀態和要求標識碼，可用來輪詢以檢查佇列交易導出要求的狀態。

將 POST 要求提交至 API 端點，以將交易/ 收益的新匯出要求排入佇列。

REST 要求

要求參數

$filter查詢參數是建立匯出作業的選擇性參數。 不過，強烈建議使用 $filters，以提升導出報表的效能和更快的可用性。 以下是一些可做為匯出作業一部分的索引鍵屬性篩選：

具有多個要求參數的交易歷程記錄篩選範例：

”?$filter=earningForDate ge 2019-01-27T23:16:31.009Z and earningForDate le 2019-09-25T23:16:31.009Z and (enrollmentParticipantId eq 'XXXXXXX') and (programName eq ‘Microsoft Commerce Incentives’) and (payableSubType eq 'REBATE') and (paymentId eq '000000000000') and (engagementName eq 'Azure Enterprise and Self-Service Incentive' or engagementName eq 'Azure CSP motion incentives - Indirect Provider') and (leverCode eq ‘Azure Enterprise and Self-Service Motion’) and (payoutStatus eq 'SENT')”

請求首部

若要深入瞭解，請參閱 合作夥伴中心 REST 標頭

請求主體

N/A.

API 回應

HTTP/1.1 202 Accepted

API 回應承載會傳回下列屬性：

可能的值和動作

狀態 的可能值

• 佇列：導出作業尚未啟動
• 處理：匯出作業正在進行中
• 失敗：重試後匯出作業失敗，請嘗試將新要求排入佇列
• 已完成：匯出作業已完成，且匯出檔案已可供下載。

範例回應

{
    "value": [
        {
            "requestId": "93c2b3cf-c6d8-4e7e-ade1-007768a6eba4",
            "requestDateTime": "2023-05-25T21:20:46.3727561Z",
            "requestPath": "/v1.0/payouts/transactionhistory",
            "requestQueryString": "earningForDate ge 2023-03-01 and earningForDate le 2023-04-12",
            "blobLocation": "",
            "status": "Queued"
        }
    ],
    "nextLink": null,
    "totalCount": 1
}

API 會傳回 HTTP 狀態 202。

根據要求，API 可以傳回其他標準狀態：