Partner payouts - Creates a new payments export request

Service:

Partner Center Rest

API Version:

1.0

Esta API permite crear una nueva solicitud de exportación de pagos. Se recomienda usar $filter parámetro para cada solicitud. Consulte a continuación el uso de los filtros y todos los filtros disponibles en la interfaz de página de exportación (UX) también están disponibles a través de esta API, lo que proporciona flexibilidad y coherencia en el filtrado de datos.

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}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
version	path	True	string
$filter	query		string	El parámetro de consulta $filter es un parámetro opcional para crear una operación de exportación. Sin embargo, se recomienda encarecidamente usar $filter para mejorar el rendimiento y una disponibilidad más rápida del informe de exportación. A continuación se muestran algunos de los filtros de atributos clave que se pueden usar como parte de la operación de exportación.
enrollmentParticipantId	query		int	Filtro de identificador de MPN inscrito para una solicitud de exportación. Uso: {baseUrl}/paymentss/payments?$filter=enrollmentParticipantId=12345
Multiple filters	query		string	Esta es una consulta de ejemplo con varios filtros para una solicitud de exportación. Uso: {baseUrl}/payments/payments?$filter=paymentStatusUpdateTS ge 2023-01-01 y paymentStatusUpdateTS le 2023-05-31 y (enrollmentParticipantId eq 'XXXXXXX') y (programName eq 'CSP Direct Bill Partner') y (paymentOrderType eq 'REBATE') y (paymentId eq 'xxxxxxx')
paymentAmount	query		double	Importe de pago para filtrar los pagos de una solicitud de exportación. Uso: {baseUrl}/payments/payments?$filter=paymentAmount ge 2000 y paymentAmount le 5000
paymentId	query		int	Filtro PaymentId para una solicitud de exportación. Uso: {baseUrl}/payments/payments?$filter=paymentId=123456
payoutOrderType	query		string	Tipo de pedido de pago (reembolso, coop, cuota, venta) para filtrar los pagos de una solicitud de exportación. Uso: {baseUrl}/paymentss/payments?$filter=?$filter=payoutOrderType='REBATE'
payoutStatusUpdateTS	query		string	Fecha de estado de pago para filtrar los pagos de una solicitud de exportación. Uso: {baseUrl}/payouts/transactionhistory?$filter=payoutStatusUpdateTS ge 2023-03-01 y payoutStatusUpdateTS le 2023-04-12

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Authorization	True	string	Token de portador de autorización
Client-Request-ID		string	Identificador de la solicitud proporcionada por el usuario

Respuestas

Nombre	Tipo	Description
202 Accepted	Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export	La solicitud se aceptó correctamente para su procesamiento. Headers Request-ID: string
400 Bad Request		Faltaba o faltaba una entrada no válida. El cuerpo de la respuesta proporcionará los detalles del error.
401 Unauthorized		La solicitud no se autenticó. El cliente debe autenticarse primero con el servicio de API de asociado.
403 Forbidden		La solicitud se autenticó pero se rechazó, ya que el autor de la llamada no tiene los derechos para invocarla.
404 Not Found		No se encuentra el recurso.
429 Too Many Requests		Demasiadas solicitudes.
500 Internal Server Error		El servicio de API de asociado o una de sus dependencias no pudieron cumplir la solicitud. Los autores de llamadas pueden volver a intentarlo.

Definiciones

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

Nombre	Tipo	Description
blobLocation	string
processingStartDateTime	string
requestDateTime	string
requestId	string
requestPath	string
requestQueryString	string
status	enum: Completed Failed Processing Queued