Obtener historial de beneficios
POST/api/branchs/history/benefits
Retorna los beneficios que recibió el comercio, con su orden, courier y el movimiento de saldo que generaron. Por ejemplo, el cashback por envío (CBE): un porcentaje del costo de envío que se devuelve al saldo al entregarse la orden, según el nivel de suscripción del comercio.
Incluye totales del periodo: cantidad y monto de beneficios, monto del mes actual y del anterior, monto revertido y desglose por tipo.
Todos los campos del body son opcionales: sin body retorna la primera página (20 beneficios), del más reciente al más antiguo.
Con export: 1 también genera un Excel con todos los resultados y retorna su URL en export.URLDataExcel.
Petición
Respuestas
- 200
- 400
- 401
- 500
Beneficios obtenidos
Filtro, ordenamiento o paginación inválidos. Se reporta el primer error encontrado, con el formato Error en campo "<campo>": <motivo>.
Motivos posibles: debe ser 0 o 1 (export, como número), debe ser un código de texto válido (máx 20 caracteres) (filters.movementCode), debe ser un UUID válido, texto inválido (máx N caracteres) (filters.comprobante, filters.status), debe ser una fecha válida (YYYY-MM-DD), dateFrom no puede ser mayor a dateTo, debe ser un entero mayor a 0 (pagination.page), debe ser un entero entre 1 y 50 (pagination.limit) y debe ser ASC o DESC (order.direction).
Falta el token, venció (dura 15 minutos) o no es válido. Repite el login para obtener uno nuevo.
Error interno