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

Článek
12/19/2023

Pomocí tohoto rozhraní API můžete zařaďte do fronty nové příjmy a podkladové transakce nebo žádosti o export dat plateb s volitelnými filtry pro průřezy a dice dat o příjmech a transakcích. Vrátí stav HTTP 202 a ID požadavku, které lze použít k dotazování zpět ke kontrole stavu požadavku exportu 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 žádosti
POST	`https://api.partner.microsoft.com/v1.0/payouts/transactionhistory?$filter={$filter}&fileformat=csv`

Parametry požadavku

Název	In	Požaduje se	Type	Popis
$filter	Dotaz	No	String	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.
fileFormat	Dotaz	No	String	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ě ale doporučujeme použít $filters pro lepší výkon a rychlejší dostupnost sestavy exportu. Tady jsou některé z klíčových filtrů atributů, které je možné použít jako součást operace exportu:

Název	Popis	Typ	Vzorek
`enrollmentParticipantId`	Zaregistrované ID MPN organizace.	Int	{baseUrl}`/v1.0/payouts/transactionhistory?$filter= enrollmentParticipantId=12345`
`EarningForDate`	Datum období získání pro operaci exportu	DateTime	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=earningForDate ge 2023-03-01 and earningForDate le 2023-04-12`
`transactionAmount`	Částka transakce.	Hodnota s dvojitou přesností	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=transactionAmount ge 2000 and transactionAmount le 5000`
`earningAmount`	Získání částky v měně transakce.	Hodnota s dvojitou přesností	{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'`.	String	{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'`	String	{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'`.	String	{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

Název	Požadováno	Type	Popis
Autorizace	Ano	String	Autorizační nosný token
ms-correlationid	No	String	Interní sledování požadavků. Každý požadavek vygeneruje nový sledovací modul (GUID).
ms-requestid	No	String	ID idempotence požadavku.

Další informace najdete v hlavičce REST Partnerského centra.

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:

Název	Volitelné	Popis
Hodnota	false (nepravda)	Možné hodnoty a akce najdete v následující tabulce.

Možné hodnoty a akce

Hodnota	Akce klienta
requestId	ID žádosti o export
requestDateTime	Datum zahájení žádosti o export
requestPath	Cesta dotazu na žádost o export
requestQueryString	Filtr použitý jako součást žádosti o export.
BlobLocation	Prostředek 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

Zařazeno do fronty: Operace exportu nebyla spuštěna.
Zpracování: Probíhá operace exportu.
Selhání: Operace exportu selhala po opakovaných pokusech, 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 vrátí stav HTTP 202.

Název	Popis
202 Přijato	Žádost byla přijata. Zadejte dotaz na adresu URL požadavku GET pro stav požadavku.

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

Název	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.
500 – Vnitřní chyba serveru	Rozhraní API nebo jedna z jejích závislostí nemůže požadavek splnit. Zkuste to později.
404 – Nenalezeno	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