Partner payouts - Create a new transaction history export request
Cette API permet de créer une demande d’exportation d’historique des transactions. Nous vous recommandons d’utiliser $filter param pour chaque requête. Consultez ci-dessous l’utilisation des filtres et tous les filtres disponibles dans l’interface de page d’exportation (UX) sont également disponibles via cette API, ce qui offre une flexibilité et une cohérence dans le filtrage des données.
POST https://api.partnercenter.microsoft.com/v{version}/payouts/transactionhistoryPOST 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}Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
version
|
path | True |
string |
|
|
$filter
|
query |
string |
L'$filter l’analyseur de requête est un paramètre facultatif pour la création d’une opération d’exportation. Toutefois, nous vous recommandons vivement d’utiliser $filter pour améliorer les performances et accélérer la disponibilité du rapport d’exportation. Voici quelques-uns des filtres d’attributs clés qui peuvent être utilisés dans le cadre de l’opération d’exportation |
|
|
earning
|
query |
double |
Filtre de montant de gain pour une demande d’exportation. Utilisation : {baseUrl}/payouts/transactionhistory ?$filter=earningAmount ge 2000 et earningAmount le 5000 |
|
|
earning
|
query |
string |
Filtre de date de période de gain pour une demande d’exportation. Utilisation : {baseUrl}/payouts/transactionhistory ?$filter=earningForDate ge 2023-03-01 et gainForDate le 2023-04-12 |
|
|
engagement
|
query |
string |
Filtre de nom d’engagement pour une demande d’exportation. Utilisation : {baseUrl}/payouts/transactionhistory ?$filter=engagementName='Azure CSP motion incentives' |
|
|
enrollment
|
query |
int |
Filtre d’ID MPN inscrit pour une demande d’exportation. Utilisation : {baseUrl}/payouts/transactionhistory ?$filter=enrollmentParticipantId=12345 |
|
|
Multiple filters
|
query |
string |
Voici un exemple de requête pour créer une demande d’exportation avec plusieurs filtres. Utilisation : {baseUrl}/payouts/transactionhistory ?$filter=earningForDate ge 2023-01-01 et earningForDate le 2023-05-31 et (enrollmentParticipantId eq 'XXXXXXX') et (programName eq 'Microsoft Commerce Incentives') et (payableSubType eq 'REBATE') et (paymentId eq 'xxxxxxx') et (engagementName eq 'Azure Enterprise and Self-Service Incentive' ou engagementName eq 'Azure CSP motion incentives - Indirect Provider')" |
|
|
transaction
|
query |
double |
Filtre de quantité de transaction pour une demande d’exportation. Utilisation : {baseUrl}/payouts/transactionhistory ?$filter=transactionAmount ge 2000 et transactionAmount le 5000 |
En-tête de la demande
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| Authorization | True |
string |
Jeton du porteur d’autorisation |
| Client-Request-ID |
string |
ID de la demande fournie par l’utilisateur |
Réponses
| Nom | Type | Description |
|---|---|---|
| 202 Accepted |
La demande a été acceptée pour traitement. En-têtes Request-ID: string |
|
| 400 Bad Request |
Une entrée est manquante ou non valide. Le corps de la réponse fournit les détails de l’erreur. |
|
| 401 Unauthorized |
La demande n’a pas été authentifiée. Le client doit d’abord s’authentifier auprès du service d’API partenaire. |
|
| 403 Forbidden |
La demande a été authentifiée, mais a été refusée, car l’appelant n’a pas les droits de l’appeler. |
|
| 404 Not Found |
La ressource est introuvable. |
|
| 429 Too Many Requests |
Trop de demandes. |
|
| 500 Internal Server Error |
Le service d’API partenaire ou l’une de ses dépendances n’a pas pu répondre à la demande. Les appelants peuvent réessayer. |
Définitions
Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export
| Nom | Type | Description |
|---|---|---|
| blobLocation |
string |
|
| processingStartDateTime |
string |
|
| requestDateTime |
string |
|
| requestId |
string |
|
| requestPath |
string |
|
| requestQueryString |
string |
|
| status |
enum:
|