Partner payouts - Creates a new payments export request

Tjänst:

Partner Center Rest

API-version:

1.0

Med det här API:et kan du skapa en ny begäran om export av betalningar. Vi rekommenderar att du använder $filter param för varje begäran. Se nedan om användningen av filtren och alla filter som är tillgängliga i exportsidans gränssnitt (UX) också är tillgängliga via det här API:et, vilket ger flexibilitet och konsekvens vid filtrering av data.

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

Med valfria parametrar:

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}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
version	path	True	string
$filter	query		string	$filter-frågeparam är en valfri parameter för att skapa en exportåtgärd. Vi rekommenderar dock starkt att du använder $filter för bättre prestanda och snabbare tillgänglighet för exportrapporten. Nedan visas några av de nyckelattributfilter som kan användas som en del av exportåtgärden
enrollmentParticipantId	query		int	Registrerat MPN-ID-filter för en exportbegäran. Användning: {baseUrl}/payouts/payments?$filter=enrollmentParticipantId=12345
Multiple filters	query		string	Här är en exempelfråga med flera filter för en exportbegäran. Användning: {baseUrl}/payouts/payments?$filter=payoutStatusUpdateTS ge 2023-01-01 och payoutStatusUpdateTS le 2023-05-31 och (enrollmentParticipantId eq 'XXXXXXX') och (programName eq 'CSP Direct Bill Partner') och (payoutOrderType eq 'DISCOUNT') och (paymentId eq 'xxxxxxx')
paymentAmount	query		double	Betalningsbelopp för att filtrera betalningarna för en exportbegäran. Användning: {baseUrl}/payouts/payments?$filter=paymentAmount ge 2000 och paymentAmount le 5000
paymentId	query		int	PaymentId-filter för en exportbegäran. Användning: {baseUrl}/payouts/payments?$filter=paymentId=123456
payoutOrderType	query		string	Utbetalningsbeställningstyp (rabatt, coop, avgift, försäljning) för att filtrera betalningarna för en exportbegäran. Användning: {baseUrl}/payouts/payments?$filter=?$filter=payoutOrderType='DISCOUNT'
payoutStatusUpdateTS	query		string	Utbetalningsstatusdatum för att filtrera betalningarna för en exportbegäran. Användning: {baseUrl}/payouts/transactionhistory?$filter=payoutStatusUpdateTS ge 2023-03-01 och payoutStatusUpdateTS le 2023-04-12

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	Token för auktoriseringsbärare
Client-Request-ID		string	ID för begäran som tillhandahålls av användaren

Svar

Name	Typ	Description
202 Accepted	Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export	Begäran godkändes för bearbetning. Sidhuvuden Request-ID: string
400 Bad Request		Det saknades eller ogiltiga indata. Svarstexten innehåller felinformationen.
401 Unauthorized		Begäran autentiserades inte. Klienten måste autentisera med partner-API-tjänsten först.
403 Forbidden		Begäran autentiserades men nekades eftersom anroparen inte har behörighet att anropa den.
404 Not Found		Det går inte att hitta resursen.
429 Too Many Requests		För många begäranden.
500 Internal Server Error		Partner-API-tjänsten eller något av dess beroenden kunde inte uppfylla begäran. Anropare kan försöka igen.

Definitioner

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