Partner payouts - Creates a new payments export request

Reference

Service:: Partner Center Rest

API Version:: 1.0

Toto rozhraní API umožňuje vytvořit novou žádost o export plateb. Pro každý požadavek doporučujeme použít $filter param. Projděte si níže informace o použití filtrů a všech filtrů dostupných v rozhraní stránky exportu (UX) jsou k dispozici také prostřednictvím tohoto rozhraní API, což poskytuje flexibilitu a konzistenci filtrování dat.

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

With optional parameters:

POST https://api.partnercenter.microsoft.com/v{version}/payouts/payments?$filter={$filter}&enrollmentParticipantId={enrollmentParticipantId}&paymentId={paymentId}&payoutStatusUpdateTS={payoutStatusUpdateTS}&paymentAmount={paymentAmount}&payoutOrderType={payoutOrderType}&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 uvedené některé klíčové filtry atributů, které je možné použít jako součást operace exportu.
enrollmentParticipantId	query		int	Filtr zaregistrovaného ID MPN pro žádost o export. Použití: {baseUrl}/payouts/payments?$filter=enrollmentParticipantId=12345
Multiple filters	query		string	Tady je ukázkový dotaz s několika filtry pro žádost o export. Použití: {baseUrl}/payouts/payments?$filter=payoutStatusUpdateTS ge 2023-01-01 and payoutStatusUpdateTS le 2023-01 05-31 a (enrollmentParticipantId eq 'XXXXXXX') a (programName eq 'CSP Direct Bill Partner') a (payoutOrderType eq 'RABAT') a (paymentId eq 'xxxxxxx')
paymentAmount	query		double	Částka platby pro filtrování plateb pro žádost o export. Použití: {baseUrl}/payouts/payments?$filter=paymentAmount ge 2000 and paymentAmount le 5000
paymentId	query		int	Filtr PaymentId pro žádost o export. Použití: {baseUrl}/payouts/payments?$filter=paymentId=123456
payoutOrderType	query		string	Typ platební objednávky (Rabat, coop, Poplatek, Prodej) pro filtrování plateb pro žádost o export. Použití: {baseUrl}/payouts/payments?$filter=?$filter=payoutOrderType='RABAT'
payoutStatusUpdateTS	query		string	Datum stavu platby pro filtrování plateb pro žádost o export. Použití: {baseUrl}/payouts/transactionhistory?$filter=payoutStatusUpdateTS ge 2023-03-01 and payoutStatusUpdateTS le 2023-04-12

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Nosný token autorizace
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	Požadavek byl úspěšně přijat ke zpracování. Headers Request-ID: string
400 Bad Request		Chybí nebo je neplatný vstup. 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		Požadavek byl ověřen, ale byl odmítnut, protože volající nemá práva k jeho vyvolání.
404 Not Found		Prostředek se nenašel.
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 požadavek splnit. Volající to můžou zkusit 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