Partner payouts - Creates a new payments export request

Service:

Partner Center Rest

API Version:

1.0

この API を使用すると、新しい支払いエクスポート要求を作成できます。 要求ごとに $filter param を使用することをお勧めします。 フィルターの使用方法については、以下を参照してください。また、エクスポート ページ インターフェイス (UX) で使用できるすべてのフィルターもこの API を通じて利用でき、データのフィルター処理に柔軟性と一貫性を提供します。

POST https://api.partnercenter.microsoft.com/v{version}/payouts/payments

With optional parameters:

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 パラメーター

名前	/	必須	型	説明
version	path	True	string
$filter	query		string	$filter クエリ パラメーターは、エクスポート操作を作成するための省略可能なパラメーターです。 ただし、エクスポート レポートのパフォーマンスを向上させ、可用性を向上させるには、$filterを使用することを強くお勧めします。 エクスポート操作の一部として使用できる主要な属性フィルターの一部を次に示します。
enrollmentParticipantId	query		int	エクスポート要求の登録された MPN ID フィルター。 使用法: {baseUrl}/payments/payments?$filter=enrollmentParticipantId=12345
Multiple filters	query		string	エクスポート要求に対する複数のフィルターを含むサンプル クエリを次に示します。 使用法: {baseUrl}/payments?$filter=payoutStatusUpdateTS ge 2023-01-01 and payoutStatusUpdateTS le 2023-05-31 and (enrollmentParticipantId eq 'XXXXXXX') と (programName eq 'CSP Direct Bill Partner') and (paymentOrderType eq 'REBATE') and (paymentId eq 'xxxxxxx')
paymentAmount	query		double	エクスポート要求の支払いをフィルター処理する支払額。 使用法: {baseUrl}/payments?$filter=paymentAmount ge 2000 および paymentAmount le 5000
paymentId	query		int	エクスポート要求の PaymentId フィルター。 使用法: {baseUrl}/payments/payments?$filter=paymentId=123456
payoutOrderType	query		string	エクスポート要求の支払いをフィルター処理するための支払い注文の種類 (リベート、コープ、手数料、販売)。 使用法: {baseUrl}/payments/payments?$filter=?$filter=payoutOrderType='REBATE'
payoutStatusUpdateTS	query		string	エクスポート要求の支払いをフィルター処理するための支払い状態の日付。 使用法: {baseUrl}/payouts/transactionhistory?$filter=payoutStatusUpdateTS ge 2023-03-01 および 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