Partner payouts - Create a new transaction history export request
此 API 允許建立新的交易歷程記錄匯出要求。 我們建議針對每個要求使用$filter參數。 請參閱下方有關篩選的使用方式,以及匯出頁面介面中可用的所有篩選, (UX) 也可透過此 API 取得,以提供篩選資料的彈性和一致性。
POST https://api.partnercenter.microsoft.com/v{version}/payouts/transactionhistory
POST https://api.partnercenter.microsoft.com/v{version}/payouts/transactionhistory?$filter={$filter}&enrollmentParticipantId={enrollmentParticipantId}&earningForDate={earningForDate}&transactionAmount={transactionAmount}&earningAmount={earningAmount}&engagementName={engagementName}&Multiple filters={Multiple filters}
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
version
|
path | True |
string |
|
$filter
|
query |
string |
$filter查詢參數是建立匯出作業的選擇性參數。 不過,強烈建議使用$filter,以提升匯出報表的效能和更快的可用性。 以下是一些可用來做為匯出作業一部分的主要屬性篩選 |
|
earning
|
query |
double |
匯出要求的收益金額篩選。 使用量:{baseUrl}/payouts/transactionhistory?$filter=earningAmount ge 2000 and earningAmount le 5000 |
|
earning
|
query |
string |
匯出要求的收益期間日期篩選。 使用量:{baseUrl}/payouts/transactionhistory?$filter=earningForDate ge 2023-03-01 and earningForDate le 2023-04-12 |
|
engagement
|
query |
string |
匯出要求的預訂名稱篩選。 使用量:{baseUrl}/payouts/transactionhistory?$filter=engagementName='Azure CSP 動作獎勵' |
|
enrollment
|
query |
int |
匯出要求的已註冊 MPN 識別碼篩選。 使用量:{baseUrl}/payouts/transactionhistory?$filter=enrollmentParticipantId=12345 |
|
Multiple filters
|
query |
string |
以下是建立具有多個篩選準則之匯出要求的範例查詢。 使用量:{baseUrl}/payouts/transactionhistory?$filter=earningForDate ge 2023-01-01 和 earningForDate le 2023-05-31 and (enrollmentParticipantId eq 'XXXXXXX') and (programName eq 'Microsoft Commerce Incentives') 和 (paymentSubType eq 'RESER加值稅ION') and (paymentId eq 'xxxxxxx') and (engagementName eq 'Azure Enterprise and Self-Service 獎勵' 或 engagementName eq 'Azure CSP 動作獎勵 - 間接提供者') 」 |
|
transaction
|
query |
double |
匯出要求的異動金額篩選。 使用量:{baseUrl}/payouts/transactionhistory?$filter=transactionAmount ge 2000 and transactionAmount le 5000 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
Authorization | True |
string |
授權持有人權杖 |
Client-Request-ID |
string |
使用者所提供的要求識別碼 |
回應
名稱 | 類型 | Description |
---|---|---|
202 Accepted |
已成功接受要求進行處理。 Headers Request-ID: string |
|
400 Bad Request |
遺漏或不正確輸入。 回應本文將提供錯誤詳細資料。 |
|
401 Unauthorized |
要求未經驗證。 用戶端必須先向合作夥伴 API 服務進行驗證。 |
|
403 Forbidden |
要求已經過驗證,但因為呼叫端沒有叫用要求的許可權而遭到拒絕。 |
|
404 Not Found |
找不到資源。 |
|
429 Too Many Requests |
太多要求。 |
|
500 Internal Server Error |
合作夥伴 API 服務或其其中一個相依性無法滿足要求。 來電者可能會重試此動作。 |
定義
Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export
名稱 | 類型 | Description |
---|---|---|
blobLocation |
string |
|
processingStartDateTime |
string |
|
requestDateTime |
string |
|
requestId |
string |
|
requestPath |
string |
|
requestQueryString |
string |
|
status |
enum:
|