Erstellen einer Einnahmenexportanforderung

Artikel
12/19/2023

Verwenden Sie diese API, um neue Einnahmen und zugrunde liegende Transaktionen/Zahlungsdatenexportanforderung mit optionalen Filtern in die Warteschlange zu stellen und die Einnahmen- und Transaktionsdaten zu würfeln. Er gibt einen 202 HTTP-Status und eine Anforderungs-ID zurück, die verwendet werden kann, um den Status der in die Warteschlange eingereihten Transaktionsexportanforderung zu überprüfen.

Senden Sie eine POST-Anforderung an den API-Endpunkt, um eine neue Exportanforderung für Transaktionen/Einnahmen in die Warteschlange zu stellen.

REST-Anforderung

Methode	Anforderungs-URI
POST	`https://api.partner.microsoft.com/v1.0/payouts/transactionhistory?$filter={$filter}&fileformat=csv`

Anforderungsparameter

Name	Geben Sie in	Erforderlich	Type	Beschreibung
$filter	Abfrage	Nein	String	Obwohl es sich um einen optionalen Filter handelt, empfehlen wir dringend, Filter für eine schnellere Leistung zu verwenden und Ihre Exportdaten zu beschränken, anstatt die letzten drei Jahre der Daten zu exportieren. Eine vollständige Reihe von $filter Optionen finden Sie in der folgenden Tabelle.
fileFormat	Abfrage	Nein	String	Unterstützte Werte sind CSV/.tsv. Standardwert ist CSV, wenn kein Wert angegeben wird.

Der $filter Abfrageparameter ist ein optionaler Parameter zum Erstellen eines Exportvorgangs. Es wird jedoch dringend empfohlen, $filters für eine bessere Leistung und schnellere Verfügbarkeit des Exportberichts zu verwenden. Im Folgenden sind einige der wichtigsten Attributfilter aufgeführt, die als Teil des Exportvorgangs verwendet werden können:

Name	Description	Typ	Beispiel
`enrollmentParticipantId`	Registrierte MPN-ID der Organisation.	Int	{baseUrl}`/v1.0/payouts/transactionhistory?$filter= enrollmentParticipantId=12345`
`EarningForDate`	Ertragszeitraumsdatum für den Exportvorgang.	Datetime	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=earningForDate ge 2023-03-01 and earningForDate le 2023-04-12`
`transactionAmount`	Transaktionsbetrag.	Double	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=transactionAmount ge 2000 and transactionAmount le 5000`
`earningAmount`	Einnahmenbetrag in Transaktionswährung.	Double	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=earningAmount ge 2000 and earningAmount le 5000`
`engagementName`	Gilt nur für Microsoft Commerce Incentives. Beispielwerte - `'Azure CSP motion incentives - Indirect Provider'`.	String	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=engagementName=’Azure CSP motion incentives’`
`payableSubType`	Filtern Sie nach dem Ertragstyp. Beispielwerte - `'REBATE'`, `'COOP'`, `'FEE''SELL'`	String	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=payableSubType=’REBATE’ or payableSubType=’FEE’`
`payoutStatus`	Filtern Sie Transaktionen nach dem Auszahlungsstatus. Beispielwerte - `'SENT'`, `'UPCOMING'`, `'IN PROGRESS'`.	String	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=payoutStatus=’IN PROGRESS’`

Beispiel für den Transaktionsverlaufsfilter mit mehreren Anforderungsparametern:

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

Anforderungsheader

Name	Erforderlich	Type	BESCHREIBUNG
Authorization	Ja	String	Autorisierungs bearertoken.
ms-correlationid	Nein	String	Eine interne Anforderungsverfolgung. Jede Anforderung generiert einen neuen Tracker (GUID).
ms-requestid	Nein	String	Die Anforderungs-Idempotency-ID.

Weitere Informationen finden Sie unter Partner Center-REST-Header

Anforderungstext

N/V.

API-Antwort

HTTP/1.1 202 Accepted

Die API-Antwortnutzlast gibt die folgenden Attribute zurück:

Name	Optional	Beschreibung
Wert	false	Mögliche Werte und Aktionen finden Sie in der folgenden Tabelle.

Mögliche Werte und Aktionen

Wert	Clientaktion
requestId	Anforderungs-ID der Exportanforderung
requestDateTime	Initiierungsdatum der Exportanforderung
requestPath	Abfragepfad der Exportanforderung.
requestQueryString	Filter, der als Teil der Exportanforderung verwendet wird.
blobLocation	Blob-Ressource mit Token, wenn die Exportdatei bereit ist
Status	Exportvorgangsstatus. Weitere Informationen finden Sie in der folgenden Liste möglicher Werte für den Status.

Mögliche Werte für den Status

In die Warteschlange gestellt: Der Exportvorgang wurde nicht gestartet.
Verarbeitung: Der Exportvorgang wird ausgeführt.
Fehler: Fehler beim Exportvorgang nach Wiederholungen, versuchen Sie, eine neue Anforderung in die Warteschlange zu stellen.
Abgeschlossen: Der Exportvorgang wurde abgeschlossen, und die Exportdatei kann heruntergeladen werden.

Beispiel für eine Antwort

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

DIE API gibt DEN HTTP-Status 202 zurück.

Name	Beschreibung
202 – Akzeptiert	Die Anforderung wurde akzeptiert. Fragen Sie die GET-Anforderungs-URL für den Anforderungsstatus ab.

Je nach Anforderung kann die API andere Standardstatus zurückgeben:

Name	Beschreibung
400 – ungültige Anforderung	Es fehlen oder falsche Daten.
401 – Nicht autorisiert	Der Aufrufer ist nicht authentifiziert und muss sich vor dem ersten Aufruf beim Partner-API-Dienst authentifizieren.
403 Verboten	Der Anrufer ist nicht berechtigt, die Anforderung zu stellen.
500: Interner Serverfehler	Die API oder eine ihrer Abhängigkeiten kann die Anforderung nicht erfüllen. Versuchen Sie es später noch einmal.
404 Seite nicht gefunden	Ressource mit Eingabeparametern nicht verfügbar.
429 Satzbegrenzung	Zu viele Anforderungen desselben Typs. Versuchen Sie es nach einiger Zeit.

Freigeben über