共用方式為

Partner payouts - Creates a new payments export request

  • 參考
服務:
Partner Center Rest
API 版本:
1.0

此 API 允許建立新的付款匯出要求。 我們建議針對每個要求使用$filter參數。 如需篩選的使用方式，請參閱下文，以及匯出頁面介面 （UX） 中所有可用的篩選，也可透過此 API 取得，以提供篩選數據的彈性和一致性。

POST https://api.partnercenter.microsoft.com/v{version}/payouts/payments
含選擇性參數: 
POST https://api.partnercenter.microsoft.com/v{version}/payouts/payments?$filter={$filter}&enrollmentParticipantId={enrollmentParticipantId}&paymentId={paymentId}&payoutStatusUpdateTS={payoutStatusUpdateTS}&paymentAmount={paymentAmount}&payoutOrderType={payoutOrderType}&Multiple filters={Multiple filters}

URI 參數

名稱 位於 必要 類型 Description
version
 path True

string

$filter
 query

string

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

int

匯出要求的已註冊 MPN 標識元篩選條件。 使用量： {baseUrl}/payouts/payments？$filter=enrollmentParticipantId=12345
Multiple filters
 query

string

以下是具有多個匯出要求篩選條件的範例查詢。 使用量：{baseUrl}/payouts/payments？$filter=payoutStatusUpdateTS ge 2023-01-01 和 payoutStatusUpdateTS le 2023-05-31 和 （enrollmentParticipantId eq 'XXXXXXX'） 和 （programName eq 'CSP Direct Bill Partner'） 和 （payoutOrderType eq 'REBATE'） 和 （paymentId eq 'xxxxxxx'）
paymentAmount
 query

double

用於篩選匯出要求的付款金額。 使用量：{baseUrl}/payouts/payment？$filter=paymentAmount ge 2000 and paymentAmount le 5000
paymentId
 query

int

匯出要求的 PaymentId 篩選條件。 使用量： {baseUrl}/payouts/payment？$filter=paymentId=123456
payoutOrderType
 query

string

支付訂單類型（回扣、coop、費用、銷售）以篩選匯出要求的付款。 使用量： {baseUrl}/payouts/payments？$filter=？$filter=payoutOrderType='REBATE'
payoutStatusUpdateTS
 query

string

用於篩選匯出要求的付款狀態日期。 使用量：{baseUrl}/payouts/transactionhistory？$filter=payoutStatusUpdateTS ge 2023-03-01 and payoutStatusUpdateTS le 2023-04-12

要求標頭

名稱 必要 類型 Description
Authorization True

string

授權持有人令牌
Client-Request-ID

string

使用者提供的要求識別碼

回應

名稱 類型 Description
202 Accepted

Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export

已成功接受要求進行處理。

標題

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:
  • Completed
  • Failed
  • Processing
  • Queued