Partner payouts - Create a new transaction history export request

Reference

Služba:: Partner Center Rest

Verze rozhraní API:: 1.0

Toto rozhraní API umožňuje vytvořit novou žádost o export historie transakcí. Pro každou žádost doporučujeme použít $filter param. Níže se dozvíte, jak se používají filtry a všechny filtry dostupné v rozhraní pro export (UX) jsou také dostupné prostřednictvím tohoto rozhraní API a poskytují flexibilitu a konzistenci při filtrování dat.

POST https://api.partnercenter.microsoft.com/v{version}/payouts/transactionhistory

S volitelnými parametry:

POST https://api.partnercenter.microsoft.com/v{version}/payouts/transactionhistory?$filter={$filter}&enrollmentParticipantId={enrollmentParticipantId}&earningForDate={earningForDate}&transactionAmount={transactionAmount}&earningAmount={earningAmount}&engagementName={engagementName}&Multiple filters={Multiple filters}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
version	path	True	string
$filter	query		string	Parametr dotazu $filter je volitelný parametr pro vytvoření operace exportu. Důrazně ale doporučujeme použít $filter pro lepší výkon a rychlejší dostupnost sestavy exportu. Níže jsou uvedeny některé filtry klíčových atributů, které je možné použít jako součást operace exportu.
earningAmount	query		double	Filtr objemu příjmů pro žádost o export Využití: {baseUrl}/payouts/transactionhistory?$filter=earningAmount ge 2000 a získání Amount le 5000
earningForDate	query		string	Filtr data získání období pro žádost o export Využití: {baseUrl}/payouts/transactionhistory?$filter=earningForDate ge 2023-03-01 a příjmyForDate le 2023-04-12
engagementName	query		string	Filtr názvů rezervací pro žádost o export Využití: {baseUrl}/payouts/transactionhistory?$filter=engagementName='Azure CSP motion incentives'
enrollmentParticipantId	query		int	Zaregistrovaný filtr ID MPN pro žádost o export Využití: {baseUrl}/payouts/transactionhistory?$filter=enrollmentParticipantId=12345
Multiple filters	query		string	Tady je ukázkový dotaz pro vytvoření žádosti o export s více filtry. Využití: {baseUrl}/payouts/transactionhistory?$filter=earningForDate ge 2023-01-01 a získání hodnotyForDate le 2023-05-31 a (enrollmentParticipantId eq) XXXXXXX) a (programName eq 'Microsoft Commerce Incentives') a (payableSubType eq 'RABAT') a (paymentId eq 'xxxxxxx') a (engagementName eq 'Azure Enterprise a Self-Service Incentives' nebo engagementName eq 'Azure CSP motion incentives - Indirect Provider')"
transactionAmount	query		double	Filtr množství transakcí pro požadavek na export Použití: {baseUrl}/payouts/transactionhistory?$filter=transactionAmount ge 2000 a transactionAmount le 5000

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Autorizační nosný token
Client-Request-ID		string	ID požadavku poskytnutého uživatelem

Odpovědi

Name	Typ	Description
202 Accepted	Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export	Žádost byla úspěšně přijata ke zpracování. Hlavičky Request-ID: string
400 Bad Request		Došlo k chybě nebo neplatnému vstupu. Text odpovědi poskytne podrobnosti o chybě.
401 Unauthorized		Požadavek nebyl ověřen. Klient se musí nejprve ověřit ve službě partnerského rozhraní API.
403 Forbidden		Žádost byla ověřena, ale byla odmítnuta, protože volající nemá práva k jeho vyvolání.
404 Not Found		Prostředek nebyl nalezen.
429 Too Many Requests		Příliš mnoho požadavků.
500 Internal Server Error		Službě partnerského rozhraní API nebo některé z jejích závislostí se nepodařilo splnit požadavek. Volající to možná zkusí znovu.

Definice

Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export

Name	Typ	Description
blobLocation	string
processingStartDateTime	string
requestDateTime	string
requestId	string
requestPath	string
requestQueryString	string
status	enum: Completed Failed Processing Queued

Sdílet prostřednictvím