Créer une demande d’exportation de revenus

Article
12/19/2023

Utilisez cette API pour mettre en file d’attente les nouveaux revenus et les transactions sous-jacentes/demande d’exportation de données de paiement avec des filtres facultatifs pour segmenter et déserer les données des revenus et des transactions. Il retourne un état HTTP 202 et un ID de requête, qui peut être utilisé pour interroger à nouveau pour case activée l’état de la demande d’exportation de transaction mise en file d’attente.

Envoyez une demande POST au point de terminaison de l’API pour mettre en file d’attente une nouvelle demande d’exportation pour les transactions/revenus.

Demande REST

Méthode	URI de demande
POST	`https://api.partner.microsoft.com/v1.0/payouts/transactionhistory?$filter={$filter}&fileformat=csv`

Paramètres de la demande

Nom	Dans	Obligatoire	Type	Description
$filter	Requête	Non	Chaîne	Même s’il s’agit d’un filtre facultatif, nous vous recommandons vivement d’utiliser des filtres pour accélérer les performances et limiter vos données d’exportation au lieu d’exporter les trois dernières années de données. Consultez le tableau suivant pour obtenir un ensemble complet d’options de $filter.
fileFormat	Requête	Non	Chaîne	Les valeurs prises en charge sont .csv/.tsv. La valeur par défaut est .csv si aucune valeur n’est fournie.

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 $filters 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 :

Nom	Description	Type	Exemple
`enrollmentParticipantId`	ID MPN inscrit de l’organisation.	Int	{baseUrl}`/v1.0/payouts/transactionhistory?$filter= enrollmentParticipantId=12345`
`EarningForDate`	Date de gain de l’opération d’exportation.	Date/Heure	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=earningForDate ge 2023-03-01 and earningForDate le 2023-04-12`
`transactionAmount`	Montant de la transaction.	Double	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=transactionAmount ge 2000 and transactionAmount le 5000`
`earningAmount`	Montant du revenu dans la devise des transactions.	Double	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=earningAmount ge 2000 and earningAmount le 5000`
`engagementName`	Applicable uniquement aux primes incitatives Microsoft Commerce. Exemples de valeurs - `'Azure CSP motion incentives - Indirect Provider'`.	Chaîne	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=engagementName=’Azure CSP motion incentives’`
`payableSubType`	Filtrez par type de gain. Exemples de valeurs - `'REBATE'`, , `'COOP''FEE''SELL'`	Chaîne	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=payableSubType=’REBATE’ or payableSubType=’FEE’`
`payoutStatus`	Filtrez les transactions par état de paiement. Exemples de valeurs - `'SENT'`, `'UPCOMING'`, `'IN PROGRESS'`.	Chaîne	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=payoutStatus=’IN PROGRESS’`

Exemple de filtre d’historique des transactions avec plusieurs paramètres de requête :

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

En-tête de requête

Nom	Requise	Type	Description
Autorisation	Oui	Chaîne	Jeton du porteur d’autorisation.
ms-correlationid	Non	Chaîne	Suivi de demande interne. Chaque requête génère un nouveau suivi (GUID).
ms-requestid	Non	Chaîne	ID d’idempotency de la requête.

Pour en savoir plus, consultez les en-têtes REST de l’Espace partenaires

Corps de la demande

N/A.

Réponse de l’API

HTTP/1.1 202 Accepted

La charge utile de réponse de l’API retourne les attributs suivants :

Nom	Facultatif	Description
active	false	Consultez le tableau suivant pour connaître les valeurs et les actions possibles.

Valeurs et actions possibles

Valeur	Action du client
requestId	ID de demande de la demande d’exportation
requestDateTime	Date d’initiation de la demande d’exportation
requestPath	Chemin d’accès de requête de la demande d’exportation.
requestQueryString	Filtre utilisé dans le cadre de la demande d’exportation.
blobLocation	Ressource d’objet blob avec jeton lorsque le fichier d’exportation est prêt
État	État de l’opération d’exportation. Consultez la liste suivante des valeurs possibles pour l’état.

Valeurs possibles pour l’état

Mis en file d’attente : l’opération d’exportation n’a pas démarré
Traitement : l’opération d’exportation est en cours
Échec : l’opération d’exportation a échoué après les nouvelles tentatives, essayez de mettre en file d’attente une nouvelle requête
Terminé : l’opération d’exportation est terminée et le fichier d’exportation est prêt à être téléchargé.

Exemple de réponse

{
    "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
}

L’API retourne l’état HTTP 202.

Nom	Description
202 Accepté	La demande a été acceptée. Interrogez l’URL de la requête GET pour obtenir l’état de la demande.

En fonction de la demande, l’API peut retourner d’autres états standard :

Nom	Description
400 Requête incorrecte	Il y avait des données manquantes ou incorrectes.
401 Non autorisé	L’appelant n’est pas authentifié et doit s’authentifier auprès du service d’API partenaire avant d’effectuer le premier appel.
403 Interdit	L’appelant n’est pas autorisé à effectuer la demande.
500 Erreur interne du serveur	L’API ou l’une de ses dépendances ne peut pas répondre à la demande. Réessayez ultérieurement.
404 Not Found	Ressource non disponible avec les paramètres d’entrée.
Limitation du taux de 429	Trop de requêtes du même type. Essayez après un certain temps.

Partager via