Partner payouts - Creates a new payments export request

  • 参考
Service:
Partner Center Rest
API Version:
1.0

此 API 允许创建新的付款导出请求。 建议对每个请求使用 $filter 参数。 请参阅以下内容，了解筛选器的用法，导出页界面中提供的所有筛选器 (UX) 也通过此 API 提供，从而在筛选数据方面提供了灵活性和一致性。

POST https://api.partner.microsoft.com/v{version}/payouts/payments
With optional parameters: 
POST https://api.partner.microsoft.com/v{version}/payouts/payments?$filter={$filter}&enrollmentParticipantId={enrollmentParticipantId}&paymentId={paymentId}&payoutStatusUpdateTS={payoutStatusUpdateTS}&paymentAmount={paymentAmount}&payoutOrderType={payoutOrderType}&Multiple filters={Multiple filters}

URI 参数

名称 在 必需 类型 说明
version
 path True

string

$filter
 query

string

$filter查询参数是用于创建导出操作的可选参数。 但是，我们强烈建议使用 $filter，以提高导出报表的性能和更快的可用性。 下面是一些可用作导出操作一部分的关键属性筛选器
enrollmentParticipantId
 query

int

为导出请求注册 MPN ID 筛选器。 用法：{baseUrl}/payouts/payments？$filter=enrollmentParticipantId=12345
Multiple filters
 query

string

下面是一个示例查询，其中包含导出请求的多个筛选器。 用法：{baseUrl}/payouts/payment？$filter=payoutStatusUpdateTS ge 2023-01-01 and payoutStatusUpdateTS le 2023-05-31 and (enrollmentParticipantId eq 'XXXXXXX') and (programName eq 'CSP Direct Bill Partner') and (payoutOrderType eq 'REBATE') 和 (paymentId eq 'xxxxxxx')

paymentAmount
 query

double

用于筛选导出请求付款的付款金额。 用法：{baseUrl}/payouts/payments？$filter=paymentAmount ge 2000 and paymentAmount le 5000
paymentId
 query

int

导出请求的 PaymentId 筛选器。 用法：{baseUrl}/payouts/payment？$filter=paymentId=123456
payoutOrderType
 query

string

付款订单类型 (回扣、合作、费用、销售) 来筛选导出请求的付款。 用法：{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

请求头

名称 必需 类型 说明
Authorization True

string

授权持有者令牌
Client-Request-ID

string

用户提供的请求 ID

响应

名称 类型 说明
202 Accepted

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

已成功接受请求进行处理。

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

名称 类型 说明
blobLocation

string

processingStartDateTime

string

requestDateTime

string

requestId

string

requestPath

string

requestQueryString

string

status enum:
  • Completed
  • Failed
  • Processing
  • Queued