Exportaanvraag voor inkomsten maken

Artikel
03/11/2025

Gebruik deze API om nieuwe exportverzoeken voor inkomsten en onderliggende transacties/betalingen in de wachtrij te plaatsen. Maak gebruik van optionele filters om de inkomsten- en transactiegegevens te analyseren en te categoriseren. Het retourneert een HTTP-status van 202 en een aanvraag-id, die kan worden gebruikt om de status van de exportaanvraag voor transacties in de wachtrij te controleren.

Dien een POST-aanvraag in bij het API-eindpunt om een nieuwe exportaanvraag voor transacties/inkomsten in de wachtrij te plaatsen.

REST-aanvraag

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

Aanvraagparameters

Naam	In	Vereist	Soort	Beschrijving
$filter	Vraag	Nee	Snaar	Hoewel het een optioneel filter is, raden we u ten zeerste aan filters te gebruiken voor snellere prestaties en het beperken van uw exportgegevens in plaats van de laatste drie jaar aan gegevens te exporteren. Zie de volgende tabel voor een volledige set $filter opties.
bestandsformaat	Vraag	Nee	Snaar	Ondersteunde waarden zijn .csv/.tsv. Standaard ingesteld op .csv als er geen waarde wordt opgegeven.

De $filter queryparameter is een optionele parameter voor het maken van een exportbewerking. We raden u echter ten zeerste aan om $filters te gebruiken voor betere prestaties en snellere beschikbaarheid van het exportrapport. Hier volgen enkele van de sleutelkenmerkfilters die kunnen worden gebruikt als onderdeel van de exportbewerking:

Naam	Beschrijving	Soort	Steekproef
`enrollmentParticipantId`	Ingeschreven MPN-ID van de organisatie.	Int	{baseUrl}`/v1.0/payouts/transactionhistory?$filter= enrollmentParticipantId=12345`
`EarningForDate`	Datum van inkomstenperiode voor de exportbewerking.	Datum/tijd	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=earningForDate ge 2023-03-01 and earningForDate le 2023-04-12`
`transactionAmount`	Transactiebedrag.	Dubbel	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=transactionAmount ge 2000 and transactionAmount le 5000`
`earningAmount`	Verdiend bedrag in transactievaluta.	Dubbel	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=earningAmount ge 2000 and earningAmount le 5000`
`engagementName`	Alleen van toepassing op Microsoft Commerce Incentives. Voorbeeldwaarden - `'Azure CSP motion incentives - Indirect Provider'`.	Snaar	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=engagementName=’Azure CSP motion incentives’`
`payableSubType`	Filter op het verdientype. Voorbeeldwaarden - `'REBATE'`, `'COOP'`, `'FEE'`, `'SELL'`	Snaar	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=payableSubType=’REBATE’ or payableSubType=’FEE’`
`payoutStatus`	Filter transacties op de uitbetalingsstatus. Voorbeeldwaarden: `'SENT'`, `'UPCOMING'`, `'IN PROGRESS'`.	Snaar	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=payoutStatus=’IN PROGRESS’`

Voorbeeldfilter voor transactiegeschiedenis met meerdere aanvraagparameters:

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

Aanvraagkoptekst

Naam	Vereist	Soort	Beschrijving
Machtiging	Ja	Snaar	Autorisatie drager-token.
ms-correlationid	Nee	Snaar	Een interne aanvraagtracker. Elke aanvraag genereert een nieuwe tracker (GUID).
ms-requestid	Nee	Snaar	Het idempotentie-id van het verzoek.

Zie Partnercentrum REST-headers voor meer informatie

Aanvraagtekst

N.V.T.

API-antwoord

HTTP/1.1 202 Accepted

De nettolading van het API-antwoord retourneert de volgende kenmerken:

Naam	Facultatief	Beschrijving
Waarde	vals	Zie de volgende tabel voor mogelijke waarden en acties.

Mogelijke waarden en acties

Waarde	Clientactie
aanvraag-ID	Aanvraag-id van de exportaanvraag
verzoekDatumTijd	Begindatum van de exportaanvraag
aanvraagpad	Pad van de query voor de exportaanvraag.
requestQueryString	Filter dat wordt gebruikt als onderdeel van de exportaanvraag.
blobLocation	Blob-resource met token wanneer het exportbestand gereed is
Status	Status van exportbewerking. Zie de volgende lijst met mogelijke waarden voor de status.

Mogelijke waarden voor status

In de wachtrij: De exportbewerking is nog niet begonnen
verwerking: de exportbewerking wordt uitgevoerd
mislukt: de exportbewerking is mislukt na nieuwe pogingen en probeer een nieuwe aanvraag in de wachtrij te plaatsen
voltooide: de exportbewerking is voltooid en het exportbestand kan worden gedownload.

Voorbeeldantwoord

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

API retourneert HTTP-status 202.

Naam	Beschrijving
202 Geaccepteerd	De aanvraag is geaccepteerd. Voer een query uit op de GET-aanvraag-URL voor de aanvraagstatus.

Afhankelijk van de aanvraag kan de API andere standaardstatussen retourneren:

Naam	Beschrijving
400 Foute aanvraag	Er ontbreken of onjuiste gegevens.
401 Niet geautoriseerd	De aanroeper wordt niet geverifieerd en moet worden geverifieerd met de partner-API-service voordat de eerste aanroep wordt uitgevoerd.
403 Verboden	De beller is niet gemachtigd om de aanvraag te doen.
500 Interne Serverfout	De API of een van de bijbehorende afhankelijkheden kan niet voldoen aan de aanvraag. Probeer het later opnieuw.
404 niet gevonden	Resource is niet beschikbaar met invoerparameters.
429 Snelheidsbeperking	Te veel aanvragen van hetzelfde type. Probeer het na een tijdje.

Delen via