수익 내보내기 요청 만들기

아티클
11/13/2024

이 API를 사용하여 새 수익 및 기본 트랜잭션/결제 데이터 내보내기 요청을 선택적 필터와 함께 큐에 추가하여 수익 및 트랜잭션 데이터를 조각화하고 주사위합니다. 큐에 대기 중인 트랜잭션 내보내기 요청의 상태 검사 다시 폴링하는 데 사용할 수 있는 202 HTTP 상태 및 요청 ID를 반환합니다.

API 엔드포인트에 POST 요청을 제출하여 트랜잭션/수익에 대한 새 내보내기 요청을 큐에 대기합니다.

REST 요청

메서드	요청 URI
POST	`https://api.partner.microsoft.com/v1.0/payouts/transactionhistory?$filter={$filter}&fileformat=csv`

요청 매개 변수

이름	그런 다음	필수	Type	설명
$filter	쿼리	아니요	문자열	선택적 필터이지만 성능 향상을 위해 필터를 사용하고 지난 3년간의 데이터를 내보내는 대신 내보내기 데이터를 제한하는 것이 좋습니다. 전체 $filter 옵션 집합은 다음 표를 참조하세요.
fileFormat	쿼리	아니요	문자열	지원되는 값은 .csv/.tsv입니다. 값이 제공되지 않으면 기본적으로 .csv로 설정됩니다.

$filter 쿼리 매개 변수는 내보내기 작업을 만들기 위한 선택적 매개 변수입니다. 그러나 내보내기 보고서의 성능과 가용성을 높이기 위해 $filters 사용하는 것이 좋습니다. 다음은 내보내기 작업의 일부로 사용할 수 있는 몇 가지 주요 특성 필터입니다.

이름	Description	Type	샘플
`enrollmentParticipantId`	조직의 등록된 MPN ID입니다.	정수	{baseUrl}`/v1.0/payouts/transactionhistory?$filter= enrollmentParticipantId=12345`
`EarningForDate`	내보내기 작업의 수익 기간 날짜입니다.	DateTime	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=earningForDate ge 2023-03-01 and earningForDate le 2023-04-12`
`transactionAmount`	트랜잭션 금액입니다.	두 배	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=transactionAmount ge 2000 and transactionAmount le 5000`
`earningAmount`	거래 통화로 수익 금액입니다.	두 배	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=earningAmount ge 2000 and earningAmount le 5000`
`engagementName`	Microsoft 상거래 인센티브에만 적용됩니다. 예제 값 - `'Azure CSP motion incentives - Indirect Provider'`.	문자열	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=engagementName=’Azure CSP motion incentives’`
`payableSubType`	수익 유형별로 필터링합니다. 예제 값 - `'REBATE'`, `'COOP'`, `'FEE''SELL'`	문자열	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=payableSubType=’REBATE’ or payableSubType=’FEE’`
`payoutStatus`	지급 상태 따라 트랜잭션을 필터링합니다. 예제 값 - `'SENT'`, `'UPCOMING'`, `'IN PROGRESS'`	문자열	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=payoutStatus=’IN PROGRESS’`

여러 요청 매개 변수가 있는 샘플 트랜잭션 기록 필터:

”?$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')”

요청 헤더

이름	필수	Type	설명
Authorization	예	문자열	권한 부여 전달자 토큰입니다.
ms-correlationid	아니요	문자열	내부 요청 추적기입니다. 각 요청은 새 추적기(GUID)를 생성합니다.
ms-requestid	아니요	문자열	요청 idempotency ID입니다.

자세한 내용은 파트너 센터 REST 헤더를 참조 하세요.

요청 본문

해당 없음.

API 응답

HTTP/1.1 202 Accepted

API 응답 페이로드는 다음 특성을 반환합니다.

이름	선택 사항	설명
값	false	가능한 값과 동작은 다음 표를 참조하세요.

가능한 값 및 작업

값	클라이언트 작업
requestId	내보내기 요청의 요청 ID
requestDateTime	내보내기 요청의 시작 날짜/시간
requestPath	내보내기 요청의 쿼리 경로입니다.
requestQueryString	내보내기 요청의 일부로 사용되는 필터입니다.
blobLocation	내보내기 파일이 준비되면 토큰이 있는 Blob 리소스
상태	내보내기 작업 상태. 상태 가능한 값의 다음 목록을 참조하세요.

상태 가능한 값

대기 중: 내보내기 작업이 시작되지 않았습니다.
처리 중: 내보내기 작업이 진행 중입니다.
실패: 다시 시도한 후 내보내기 작업이 실패하고 새 요청을 큐에 대기해 봅니다.
완료됨: 내보내기 작업이 완료되고 내보내기 파일을 다운로드할 준비가 된 것입니다.

샘플 응답

{
    "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를 반환합니다.

이름	설명
202 수락됨	요청이 수락되었습니다. 요청 상태 대한 GET 요청 URL을 쿼리합니다.

요청에 따라 API는 다른 표준 상태 반환할 수 있습니다.

이름	설명
400 잘못된 요청	누락되거나 잘못된 데이터가 있습니다.
401 권한 없음	호출자는 인증되지 않으며 첫 번째 호출을 하기 전에 파트너 API 서비스를 사용하여 인증해야 합니다.
403 금지	호출자에게 요청을 할 권한이 없습니다.
500 내부 서버 오류	API 또는 해당 종속성 중 하나가 요청을 처리할 수 없습니다. 나중에 다시 시도하세요.
404 찾을 수 없음	입력 매개 변수와 함께 리소스를 사용할 수 없습니다.
429 속도 제한	동일한 형식의 요청이 너무 많습니다. 잠시 후에 시도해 보세요.

다음을 통해 공유