NominexDocs
Referencia de la APIAsistencia

Listar

Descripcion general

Este endpoint permite obtener un listado paginado de las incidencias de asistencia capturadas en tu organización. Los resultados se devuelven en formato JSON e incluyen metadatos de paginación. Ofrece filtros por razón social, tipo de incidencia, rango de fechas y búsqueda por empleado.

El listado devuelve únicamente las incidencias del registro global de asistencia. Las incidencias capturadas dentro de una corrida específica (y que pertenecen solo a esa corrida) no aparecen aquí. Los resultados se ordenan de la fecha más reciente a la más antigua.

Endpoint

GEThttps://app.integranom.com/api/v1/attendance

Consulta multiples incidencias


Devuelve todas las incidencias de asistencia de la organización, paginadas de 20 en 20 y ordenadas por fecha descendente.

Query params

Estos son todos los filtros disponibles: razón social, tipo de incidencia, periodo y búsqueda por empleado. Todos son opcionales y se pueden combinar.

ParametroTipoRepetibleDefaultDescripcion
pageinteger ≥ 1No1Página solicitada. El tamaño de página es fijo en 20.
legal_entity_numberintegerSí-Filtra por la razón social del empleado. Repite el parámetro para incluir varias.
incidence_codestringSí-Filtra por el código del tipo de incidencia (por ejemplo FALTA). Repite el parámetro para incluir varios.
date_fromstring (YYYY-MM-DD)No-Incluye incidencias con fecha mayor o igual a esta.
date_tostring (YYYY-MM-DD)No-Incluye incidencias con fecha menor o igual a esta.
searchstringNo-Búsqueda por empleado: nombre (sin distinguir acentos ni mayúsculas) o número de empleado exacto.
sourcestringSí-Filtra por el origen exacto de la captura. Repite el parámetro para incluir varios.
origininternal | externalNo-Filtra por la clasificación del origen. Se puede combinar con source.

Filtra por razon social, tipo y periodo


legal_entity_number e incidence_code son repetibles: envía el parámetro varias veces para filtrar por varias razones sociales o varios tipos de incidencia a la vez. El ejemplo trae las faltas y las vacaciones de la razón social 1 durante junio.

Los códigos de incidencia disponibles los obtienes de Tipos de incidencia → Listar. El catálogo es global y su código es único, así que cada incidence_code identifica un solo tipo.

Campos de cada fila

CampoTipoDescripcion
datestring (YYYY-MM-DD)Día en que ocurrió la incidencia.
employee_numberintegerNúmero del empleado dentro de la organización.
employee_namestringNombre completo del empleado.
legal_entity_numberintegerRazón social del empleado.
legal_entity_namestringNombre de la razón social.
incidence_codestringCódigo del tipo de incidencia.
incidence_namestringNombre del tipo de incidencia.
unit"days" | "hours" | "count"Unidad del tipo de incidencia.
quantitynumberCantidad registrada. Los tipos de unidad days registran 1 por día, salvo las vacaciones de medio día, que registran 0.5.
notesstring | nullNotas de la captura.
approval_status"approved" | "pending" | "rejected"Estatus de autorización. Las horas extra dobles y triples quedan en pending hasta que las autorizan todos los niveles configurados, y en rejected si alguno las rechaza; la nómina solo paga las approved. Los demás tipos siempre son approved.
sourcestringOrigen exacto de la captura: attendance_module, payroll_run, employee_portal, api o time_clock.
origin"internal" | "external"Clasificación del origen: internal cuando la capturó el equipo de nómina en la plataforma; external en cualquier otro caso (portal de colaborador, reloj checador, integraciones).
captured_bystring | nullNombre de quien registró la incidencia: una persona, la integración que la envió o la plataforma. null si ese autor ya no existe.
updated_bystring | nullNombre de quien la modificó por última vez. null si nunca se ha editado.
created_atstring (ISO 8601)Fecha de captura.
updated_atstring (ISO 8601)Última modificación.

Origen de la captura


Cada incidencia registra de dónde vino. source es el origen exacto y origin lo resume en los dos grupos que importan para revisar una nómina:

originsourceSignificado
internalattendance_module, payroll_runLa capturó el equipo de nómina dentro de la plataforma.
externalemployee_portal, api, time_clockLlegó de fuera: portal de colaborador, una integración, o un reloj checador.

Filtra por cualquiera de los dos: ?origin=external para revisar todo lo que entró automáticamente, o ?source=time_clock para un origen puntual. Combinarlos los intersecta.

Estatus de autorización


Las horas extra (OVERTIME_DOUBLE_HOURS y OVERTIME_TRIPLE_HOURS) necesitan autorización antes de pagarse. approval_status dice en qué estatus está cada fila:

approval_statusSignificado
approvedAutorizada. La nómina la paga. Todos los tipos que no son horas extra llegan siempre así.
pendingPendiente de autorizar: falta la decisión del jefe directo, de Recursos Humanos o de los dos, según la configuración de asistencia. La nómina no la paga.
rejectedRechazada. La nómina no la paga.

Una hora extra que se autoriza después de cerrar su periodo entra como ajuste retroactivo en la siguiente nómina.

Una incidencia del registro global queda identificada de forma única por la combinación employee_number + date + incidence_code — la misma llave que usa el endpoint de captura para sobrescribirla.

Errores

StatusCausa
400Valor inválido en algún filtro (legal_entity_number, date_from o date_to con formato incorrecto, o date_to anterior a date_from).
401API key ausente o inválida.
Abrir Nominex