Partner payouts - Creates a new payments export request
이 API를 사용하면 새 결제 내보내기 요청을 만들 수 있습니다. 모든 요청에 $filter 매개 변수를 사용하는 것이 좋습니다. 필터 사용과 이 API를 통해 UX(내보내기 페이지 인터페이스)에서 사용할 수 있는 모든 필터를 사용하여 데이터를 필터링할 때 유연성과 일관성을 제공하는 경우 아래를 참조하세요.
POST https://api.partnercenter.microsoft.com/v{version}/payouts/paymentsPOST 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 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
version
|
path | True |
string |
|
|
$filter
|
query |
string |
$filter 쿼리 매개 변수는 내보내기 작업을 만들기 위한 선택적 매개 변수입니다. 그러나 내보내기 보고서의 성능과 가용성을 높이기 위해 $filter 사용하는 것이 좋습니다. 다음은 내보내기 작업의 일부로 사용할 수 있는 몇 가지 주요 특성 필터입니다. |
|
|
enrollment
|
query |
int |
내보내기 요청에 대해 등록된 MPN ID 필터입니다. 사용량: {baseUrl}/payments/payments?$filter=enrollmentParticipantId=12345 |
|
|
Multiple filters
|
query |
string |
다음은 내보내기 요청에 대한 여러 필터가 있는 샘플 쿼리입니다. 사용: {baseUrl}/payments/payments?$filter=paymentStatusUpdateTS ge 2023-01-01 및 payoutStatusUpdateTS le 2023-05-3 및 (enrollmentParticipantId eq 'XXXXXXX') and (programName eq 'CSP Direct Bill Partner') and (paymentOrderType eq 'REBATE') and (paymentId eq 'xxxxxxx') |
|
|
payment
|
query |
double |
내보내기 요청에 대한 지불을 필터링하는 지불 금액입니다. 사용: {baseUrl}/payments/payments?$filter=paymentAmount ge 2000 및 paymentAmount le 5000 |
|
|
payment
|
query |
int |
내보내기 요청에 대한 PaymentId 필터입니다. 사용량: {baseUrl}/payments/payments?$filter=paymentId=123456 |
|
|
payout
|
query |
string |
내보내기 요청에 대한 지급을 필터링하는 지급 주문 유형(리베이트, 쿠프, 수수료, 판매)입니다. 사용량: {baseUrl}/payments/payments?$filter=?$filter=paymentOrderType='REBATE' |
|
|
payout
|
query |
string |
내보내기 요청에 대한 지급을 필터링하는 지급 상태 날짜입니다. 사용량: {baseUrl}/payments/transactionhistory?$filter=paymentStatusUpdateTS ge 2023-03-01 and payoutStatusUpdateTS le 2023-04-12 |
요청 헤더
| Name | 필수 | 형식 | Description |
|---|---|---|---|
| Authorization | True |
string |
권한 부여 전달자 토큰 |
| Client-Request-ID |
string |
사용자가 제공한 요청의 ID |
응답
| Name | 형식 | Description |
|---|---|---|
| 202 Accepted |
처리를 위해 요청이 성공적으로 수락되었습니다. 헤더 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
| Name | 형식 | Description |
|---|---|---|
| blobLocation |
string |
|
| processingStartDateTime |
string |
|
| requestDateTime |
string |
|
| requestId |
string |
|
| requestPath |
string |
|
| requestQueryString |
string |
|
| status |
enum:
|