Partner payouts - Creates a new payments export request

Ссылка

Service:: Partner Center Rest

API Version:: 1.0

Этот API позволяет создать новый запрос на экспорт платежей. Мы рекомендуем использовать параметр $filter для каждого запроса. Ниже приведены сведения об использовании фильтров, и все фильтры, доступные в интерфейсе страницы экспорта (UX), также доступны через этот API, обеспечивая гибкость и согласованность при фильтрации данных.

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}

Параметры URI

Имя	В	Обязательно	Тип	Описание
version	path	True	string
$filter	query		string	Параметр запроса $filter является необязательным параметром для создания операции экспорта. Однако мы настоятельно рекомендуем использовать $filter для повышения производительности и ускорения доступности отчета об экспорте. Ниже приведены некоторые фильтры ключевых атрибутов, которые можно использовать в рамках операции экспорта.
enrollmentParticipantId	query		int	Зарегистрированный фильтр идентификатора MPN для запроса на экспорт. Использование: {baseUrl}/payouts/payments?$filter=enrollmentParticipantId=12345
Multiple filters	query		string	Ниже приведен пример запроса с несколькими фильтрами для запроса на экспорт. Использование: {baseUrl}/payouts/payments?$filter=payoutStatusUpdateTS ge 2023-01-01 и payoutStatusUpdateTS le 2023-05-3 1 и (enrollmentParticipantId eq 'XXXXXXX') and (programName eq 'CSP Direct Bill Partner') and (payoutOrderType eq 'REBATE') и (paymentId eq 'xxxxxxx')
paymentAmount	query		double	Сумма платежа для фильтрации платежей по запросу на экспорт. Использование: {baseUrl}/payouts/payments?$filter=paymentAmount ge 2000 и paymentAmount le 5000
paymentId	query		int	Фильтр PaymentId для запроса на экспорт. Использование: {baseUrl}/payouts/payments?$filter=paymentId=123456
payoutOrderType	query		string	Тип заказа на выплату (Rebate, Coop, Fee, Sell) для фильтрации платежей по запросу на экспорт. Использование: {baseUrl}/payouts/payments?$filter=?$filter=payoutOrderType='REBATE'
payoutStatusUpdateTS	query		string	Дата состояния выплаты для фильтрации платежей по запросу на экспорт. Использование: {baseUrl}/payouts/transactionhistory?$filter=payoutStatusUpdateTS ge 2023-03-01 и payoutStatusUpdateTS le 2023-04-12

Заголовок запроса

Имя	Обязательно	Тип	Описание
Authorization	True	string	Маркер носителя авторизации
Client-Request-ID		string	Идентификатор запроса, предоставленного пользователем

Ответы

Имя	Тип	Описание
202 Accepted	Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export	Запрос успешно принят для обработки. Headers Request-ID: string
400 Bad Request		Входные данные отсутствуют или недопустимы. В тексте ответа будут указаны сведения об ошибке.
401 Unauthorized		Запрос не прошел проверку подлинности. Сначала клиент должен пройти проверку подлинности в партнерской службе API.
403 Forbidden		Запрос прошел проверку подлинности, но ему было отказано, так как вызывающий объект не имеет прав на его вызов.
404 Not Found		Ресурс не найден.
429 Too Many Requests		Слишком много запросов.
500 Internal Server Error		Службе API партнера или одной из ее зависимостей не удалось выполнить запрос. Вызывающие абоненты могут повторить попытку.

Определения

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

Имя	Тип	Описание
blobLocation	string
processingStartDateTime	string
requestDateTime	string
requestId	string
requestPath	string
requestQueryString	string
status	enum: Completed Failed Processing Queued

Поделиться через