Devuelve la cabecera de cada pago de nómina (una fila por liquidación: año, mes, período, totales y estado). No incluye el detalle por empleado — para eso ver Cómo obtener la nómina de un mes.

Reglas de negocio

• El parámetro params[estados] es obligatorio; su ausencia produce un error 500 (no está validado en el backend). Los corchetes son literales: se envía params[estados]=EP,PA, no estados=EP,PA.
• Siempre excluye del listado los pagos de tipo "Datos Iniciales", sin importar el filtro.
• El texto de búsqueda libre (filter) no solo busca en la descripción del pago: también hace match contra el nombre completo o el número de documento de cualquier empleado asociado a ese pago.
• No existe filtro por fecha, año ni mes. Los únicos filtros son params[estados], filter y la paginación/orden. Ver Filtrar por fecha o período.

Códigos de estado (estado)

Códigos de tipo de pago (tipoPago)

Formato de la respuesta

Convenciones verificadas contra el API. Conviene tenerlas en cuenta al tipar la integración:

Cómo obtener la nómina de un mes

Este endpoint es el primer paso de un flujo de tres:

El paso 3 no admite lote: hay que invocarlo una vez por empleado. Si en cambio basta con los totales por concepto de todo el pago sumando a todos los empleados, un solo llamado a Detalle de un pago específico — GET /pagoEmpleadoDetalles/detallePago/{idPago} reemplaza los pasos 2 y 3, pero pierde el desglose individual.

Si lo que se necesita es un solo llamado con los totales del período agregados por empleado, usar Conceptos acumulados en vez de este flujo.

⚠️

No usar GET /pagos/nominaelectronica/{ano}/{mes} como consulta del mes. A pesar del nombre, no es de solo lectura: consume el consecutivo de documento soporte de nómina electrónica de la compañía en cada llamada. Ver Estado nómina electrónica del periodo.

Filtrar por fecha o período

Este endpoint no acepta filtros por fecha. Las alternativas son:

• Conceptos acumulados — GET /pagoEmpleadoDetalles/conceptosacumulados/{fechaDesde}/{fechaHasta}/false. Es el único endpoint de pagos que filtra por rango de fechas real (sobre fechaDesde del pago) y solo considera pagos definitivos.
• Consultar GET /pagos con sort=fechaDesde,desc y filtrar del lado del cliente por los campos ano y mes, que vienen en cada fila de la respuesta. El orden por fechaDesde es el que usa la propia aplicación de Nómina.
• Para reportes puntuales ya acotados por período: Consolidado de vacaciones, Consolidado de prima, Consolidado de cesantías, Depuración de retefuente o Aportes acumulados del período.