Partner payouts - Creates a new payments export request

Odwołanie

Usługa:: Partner Center Rest

Wersja interfejsu API:: 1.0

Ten interfejs API umożliwia utworzenie nowego żądania eksportu płatności. Zalecamy używanie parametrów $filter dla każdego żądania. Zapoznaj się z poniższymi informacjami na temat użycia filtrów i wszystkich filtrów dostępnych w interfejsie użytkownika strony eksportu, które są również dostępne za pośrednictwem tego interfejsu API, zapewniając elastyczność i spójność filtrowania danych.

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

Z parametrami opcjonalnymi:

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 identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
version	path	True	string
$filter	query		string	Parametr zapytania $filter jest opcjonalnym parametrem służącym do tworzenia operacji eksportowania. Zdecydowanie zalecamy jednak użycie $filter w celu uzyskania lepszej wydajności i szybszej dostępności raportu eksportu. Poniżej przedstawiono niektóre filtry atrybutów klucza, które mogą być używane w ramach operacji eksportowania
enrollmentParticipantId	query		int	Filtr zarejestrowanego identyfikatora MPN dla żądania eksportu. Użycie: {baseUrl}/wypłaty/płatności?$filter=enrollmentParticipantId=12345
Multiple filters	query		string	Oto przykładowe zapytanie z wieloma filtrami dla żądania eksportu. Użycie: {baseUrl}/wypłaty/płatności?$filter=wypłatyStatusUpdateTS ge 2023-01-01 i wypłatyStatusUpdateTS le 2023-05-31 i (enrollmentParticipantId eq 'XXXXXXX') i (programName eq 'CSP Direct Bill Partner') i (paymentOrderType eq 'RABAT') i (paymentId eq 'xxxxxxx')
paymentAmount	query		double	Kwota płatności w celu filtrowania płatności dla żądania eksportu. Użycie: {baseUrl}/wypłaty/płatności?$filter=paymentAmount ge 2000 i paymentAmount le 5000
paymentId	query		int	Filtr PaymentId dla żądania eksportu. Użycie: {baseUrl}/wypłaty/płatności?$filter=paymentId=123456
payoutOrderType	query		string	Typ zamówienia wypłaty (rabat, współop, opłata, sprzedaż) w celu filtrowania płatności dla żądania eksportu. Użycie: {baseUrl}/wypłaty/płatności?$filter=?$filter=wypłatyOrderType='RABAT'
payoutStatusUpdateTS	query		string	Data stanu wypłaty w celu filtrowania płatności dla żądania eksportu. Użycie: {baseUrl}/wypłaty/transactionhistory?$filter=wypłatyStatusUpdateTS ge 2023-03-01 i wypłatyStatusUpdateTS le 2023-04-12

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token elementu nośnego autoryzacji
Client-Request-ID		string	Identyfikator żądania dostarczonego przez użytkownika

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted	Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export	Żądanie zostało pomyślnie zaakceptowane do przetworzenia. Nagłówki Request-ID: string
400 Bad Request		Brak danych wejściowych lub nieprawidłowy. Treść odpowiedzi udostępni szczegóły błędu.
401 Unauthorized		Żądanie nie zostało uwierzytelnione. Klient musi najpierw uwierzytelnić się za pomocą usługi interfejsu API partnera.
403 Forbidden		Żądanie zostało uwierzytelnione, ale zostało odrzucone, ponieważ obiekt wywołujący nie ma praw do jego wywołania.
404 Not Found		Nie można odnaleźć zasobu.
429 Too Many Requests		Zbyt wiele żądań.
500 Internal Server Error		Usługa interfejsu API partnera lub jedna z jego zależności nie spełniła żądania. Osoby wywołujące mogą ponowić próbę.

Definicje

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

Nazwa	Typ	Opis
blobLocation	string
processingStartDateTime	string
requestDateTime	string
requestId	string
requestPath	string
requestQueryString	string
status	enum: Completed Failed Processing Queued

Udostępnij za pośrednictwem