Partner payouts - Create a new transaction history export request

Service:

Partner Center Rest

API Version:

1.0

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

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

With optional parameters:

POST https://api.partnercenter.microsoft.com/v{version}/payouts/transactionhistory?$filter={$filter}&enrollmentParticipantId={enrollmentParticipantId}&earningForDate={earningForDate}&transactionAmount={transactionAmount}&earningAmount={earningAmount}&engagementName={engagementName}&Multiple filters={Multiple filters}

URI パラメーター

名前	/	必須	型	説明
version	path	True	string
$filter	query		string	$filter クエリ パラメーターは、エクスポート操作を作成するための省略可能なパラメーターです。 ただし、エクスポート レポートのパフォーマンスと可用性を向上させるために、$filterを使用することを強くお勧めします。 エクスポート操作の一部として使用できる主要な属性フィルターの一部を次に示します。
earningAmount	query		double	エクスポート要求の収益金額フィルター。 使用法: {baseUrl}/payments/transactionhistory?$filter=earningAmount ge 2000 and earningAmount le 5000
earningForDate	query		string	エクスポート要求の収益期間の日付フィルター。 使用法: {baseUrl}/payouts/transactionhistory?$filter=earningForDate ge 2023-03-01 and earningForDate le 2023-04-12
engagementName	query		string	エクスポート要求のエンゲージメント名フィルター。 使用法: {baseUrl}/payouts/transactionhistory?$filter=engagementName='Azure CSP モーション インセンティブ'
enrollmentParticipantId	query		int	エクスポート要求の登録された MPN ID フィルター。 使用法: {baseUrl}/payouts/transactionhistory?$filter=enrollmentParticipantId=12345
Multiple filters	query		string	複数のフィルターを使用してエクスポート要求を作成するサンプル クエリを次に示します。 使用法: {baseUrl}/payouts/transactionhistory?$filter=earningForDate ge 2023-01-01 and earningForDate le 2023-05-31 and (enrollmentParticipantId eq 'XXXXXXX') ) と (programName eq 'Microsoft Commerce Incentives') と (payableSubType eq 'QUICKSTART') と (paymentId eq 'xxxxxxx') と (engagementName eq 'Azure Enterprise and Self-Service インセンティブ' または engagementName eq 'Azure CSP モーション インセンティブ - 間接プロバイダー')"
transactionAmount	query		double	エクスポート要求のトランザクション量フィルター。 使用法: {baseUrl}/payments/transactionhistory?$filter=transactionAmount ge 2000 および transactionAmount le 5000

要求ヘッダー

名前	必須	型	説明
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