Vytvoření žádosti o export příjmů

Článek
03/11/2025

Pomocí tohoto rozhraní API můžete zařadit do fronty novou žádost o export dat týkajících se výdělků a podkladových transakcí/plateb s volitelnými filtry pro jejich zpracování a podrobné analýzování. Vrátí stavový kód HTTP 202 a ID požadavku, které lze použít k opakovanému dotazování pro kontrolu stavu exportní požadavku transakce ve frontě.

Odešlete požadavek POST do koncového bodu rozhraní API a zařadíte do fronty nový požadavek na export transakcí a příjmů.

Požadavek REST

Metoda	Identifikátor URI požadavku
POST	`https://api.partner.microsoft.com/v1.0/payouts/transactionhistory?$filter={$filter}&fileformat=csv`

Parametry požadavku

Jméno	V	Povinný	Typ	Popis
$filter	Dotaz	Ne	Řetězec	I když se jedná o volitelný filtr, důrazně doporučujeme používat filtry pro rychlejší výkon a omezení exportovaných dat místo exportu za poslední tři roky dat. Úplnou sadu možností $filter najdete v následující tabulce.
formát souboru	Dotaz	Ne	Řetězec	Podporované hodnoty jsou .csv/.tsv. Výchozí hodnota je .csv, pokud není zadaná žádná hodnota.

Parametr dotazu $filter je volitelný parametr pro vytvoření operace exportu. Důrazně doporučujeme použít $filters pro lepší výkon a rychlejší dostupnost exportní zprávy. Tady jsou některé z klíčových filtrů atributů, které je možné použít jako součást operace exportu:

Jméno	Popis	Typ	Ukázka
`enrollmentParticipantId`	Zaregistrované ID MPN organizace.	Int	{baseUrl}`/v1.0/payouts/transactionhistory?$filter= enrollmentParticipantId=12345`
`EarningForDate`	Datum období vydělávání pro operaci exportu	Datum a čas	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=earningForDate ge 2023-03-01 and earningForDate le 2023-04-12`
`transactionAmount`	Částka transakce.	Dvojitý	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=transactionAmount ge 2000 and transactionAmount le 5000`
`earningAmount`	Částka získaná v měně transakce.	Dvojitý	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=earningAmount ge 2000 and earningAmount le 5000`
`engagementName`	Platí pouze pro pobídky microsoftu pro obchodování. Příklady hodnot – `'Azure CSP motion incentives - Indirect Provider'`.	Řetězec	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=engagementName=’Azure CSP motion incentives’`
`payableSubType`	Vyfiltrujte podle typu získávání. Příklady hodnot – `'REBATE'`, `'COOP'`, `'FEE'`, `'SELL'`	Řetězec	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=payableSubType=’REBATE’ or payableSubType=’FEE’`
`payoutStatus`	Filtrujte transakce podle stavu výplaty. Příklady hodnot – `'SENT'`, `'UPCOMING'`, `'IN PROGRESS'`.	Řetězec	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=payoutStatus=’IN PROGRESS’`

Ukázkový filtr historie transakcí s více parametry požadavku:

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

Hlavička požadavku

Jméno	Povinný	Typ	Popis
Oprávnění	Ano	Řetězec	Autorizační nosný token
ms-correlationid (identifikátor korelace)	Ne	Řetězec	Interní systém pro sledování požadavků. Každý požadavek vygeneruje nový sledovací modul (GUID).
ms-requestid	Ne	Řetězec	ID požadavku pro idempotenci.

Další informace najdete v tématu hlavičky REST rozhraní v Partnerském centru

Text požadavku

Není k dispozici.

Odpověď rozhraní API

HTTP/1.1 202 Accepted

Datová část odpovědi rozhraní API vrátí následující atributy:

Jméno	Volitelný	Popis
Hodnota	falešný	Možné hodnoty a akce najdete v následující tabulce.

možné hodnoty a akce

Hodnota	Akce klienta
identifikátor požadavku	ID žádosti o exportování
requestDateTime	Datum zahájení žádosti o export
requestPath	Cesta dotazu na žádost o export
requestQueryString	Filtr použitý jako součást žádosti o export.
Umístění blobu	Zdroj datového objektu blob s tokenem, když je soubor exportu připravený
Stav	Stav operace exportu Stav najdete v následujícím seznamu možných hodnot.

Možné hodnoty stavu

ve frontě: Operace exportu se nezačala
Zpracování: Probíhá operace exportu
selhalo: Operace exportu se po opakování nezdařila, zkuste zařadit novou žádost do fronty.
Dokončeno: Operace exportu byla dokončena a soubor exportu je připravený ke stažení.

Ukázková odpověď

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

Rozhraní API (aplikační programovací rozhraní) vrátí stav HTTP 202.

Jméno	Popis
202 Přijato	Žádost byla přijata. Ověřte URL adresu požadavku GET pro stav požadavku.

V závislosti na požadavku může rozhraní API vrátit další standardní stavy:

Jméno	Popis
400 Chybný požadavek	Došlo k chybějícím nebo nesprávným datům.
401 Neautorizováno	Volající není ověřený a musí se před prvním voláním ověřit ve službě partnerského rozhraní API.
403 Zakázáno	Volající nemá oprávnění k provedení žádosti.
Vnitřní chyba serveru 500	Rozhraní API nebo některá z jeho závislostí nemůže požadavek splnit. Zkuste to znovu později.
404 Nenalezena	Prostředek není dostupný se vstupními parametry.
429 Omezování rychlosti	Příliš mnoho požadavků stejného typu. Zkuste to po nějaké době.

Sdílet prostřednictvím