Partner payouts - Create a new transaction history export request

Servicio:

Partner Center Rest

Versión de la API:

1.0

Esta API permite crear una nueva solicitud de exportación del historial de transacciones. 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/transactionhistory

Con parámetros opcionales:

POST https://api.partnercenter.microsoft.com/v{version}/payouts/transactionhistory?$filter={$filter}&enrollmentParticipantId={enrollmentParticipantId}&earningForDate={earningForDate}&transactionAmount={transactionAmount}&earningAmount={earningAmount}&engagementName={engagementName}&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 mayor disponibilidad 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.
earningAmount	query		double	Filtro de importe de ganancias para una solicitud de exportación. Uso: {baseUrl}/payouts/transactionhistory?$filter=earningAmount ge 2000 y earningAmount le 5000
earningForDate	query		string	Filtro de fecha de período de ganancia para una solicitud de exportación. Uso: {baseUrl}/payouts/transactionhistory?$filter=earningForDate ge 2023-03-01 y earningForDate le 2023-04-12
engagementName	query		string	Filtro de nombre de interacción para una solicitud de exportación. Uso: {baseUrl}/payouts/transactionhistory?$filter=engagementName='Incentivos de movimiento de CSP de Azure'
enrollmentParticipantId	query		int	Filtro de identificador de MPN inscrito para una solicitud de exportación. Uso: {baseUrl}/payouts/transactionhistory?$filter=enrollmentParticipantId=12345
Multiple filters	query		string	Esta es una consulta de ejemplo para crear una solicitud de exportación con varios filtros. Uso: {baseUrl}/payouts/transactionhistory?$filter=earningForDate ge 2023-01-01 y earningForDate le 2023-05-31 y (enrollmentciPartipantId eq 'XXXXXXX') y (programName eq 'Microsoft Commerce Incentives') y (payableSubType eq 'REBATE') y (paymentId eq 'xxxxxxx') y (engagementName eq 'Azure Enterprise and Self-Service Incentive' o engagementName eq 'Azure CSP motion incentives - Indirect Provider')"
transactionAmount	query		double	Filtro de cantidad de transacción para una solicitud de exportación. Uso: {baseUrl}/payouts/transactionhistory?$filter=transactionAmount ge 2000 y transactionAmount le 5000

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Authorization	True	string	Token de portador de autorización
Client-Request-ID		string	Id. de 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. Encabezados 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 del 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 del 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