Obtener incidencias de un servicio

Este endpoint permite consultar las incidencias registradas vinculadas a un servicio dentro de un periodo de tiempo determinado no superior a 30 días.

GET /api/v2/businesses/{businessId}/services/{serviceId}/incidences/from/{yyyy-MM-dd}/to/{yyyy-MM-dd}

Si los datos incluidos en la petición son correctos —tanto el businessId como el serviceId—, la respuesta contendrá el listado de incidencias del servicio en el intervalo de tiempo definido.

Ejemplo de respuesta

[
    {
        "personId": "0001",
        "from": "2026-08-12",
        "to": "2026-08-12",
        "initTime": "10:00",
        "endTime": "10:30",
        "workedMinutes": 0,
        "type": {
            "name": "UNJUSTIFIED ABSENCE",
            "shortName": "UNJ",
            "fullDay": false,
            "color": "#51d9ff",
            "calculationType": "NOT_COMPUTABLE",
            "holidays": false
        }
    },
    {
        "id": "0712",
        "personId": "0002",
        "from": "2025-07-12",
        "to": "9999-12-31",
        "workedMinutes": 0,
        "type": {
            "id": "02",
            "name": "HOLIDAYS",
            "shortName": "HOL",
            "fullDay": true,
            "color": "#5ea226",
            "calculationType": "PROPORTIONAL",
            "workedDays": 7,
            "holidays": true
        }
    },
    {
        "personId": "0003",
        "from": "2026-08-12",
        "to": "2026-08-12",
        "initTime": "12:00",
        "endTime": "13:00",
        "workedMinutes": 0,
        "type": {
            "id": "01",
            "name": "MEDICAL APPOINTMENT",
            "shortName": "MED",
            "fullDay": false,
            "color": "#60b5ff",
            "calculationType": "DURATION",
            "holidays": false
        }
    }
]
Detalles

  • id: identificador externo de la incidencia.

  • personId: identificador externo del empleado vinculado con la incidencia.

  • reason: texto libre con el motivo de la incidencia.

  • from: fecha en la que comienza la incidencia, en formato yyyy-MM-dd.

  • to: fecha en la que finaliza la incidencia, en formato yyyy-MM-dd.

  • initTime: hora de inicio de la incidencia, en formato HH:mm. Se considera la hora local, es decir, la zona horaria del servicio.

  • endTime: hora de finalización de la incidencia, en formato HH:mm. Se considera la hora local, es decir, la zona horaria del servicio.

  • workedMinutes: tiempo, en minutos, que la incidencia computa.

  • type: tipo de incidencia, tal y como está configurado en el catálogo de incidencias del negocio. Contiene los siguientes campos:

    • id: identificador externo del tipo de incidencia.

    • name: nombre del tipo de incidencia.

    • shortName: abreviatura del tipo de incidencia.

    • fullDay: determina si la incidencia ocupa la jornada completa (true) o un intervalo horario concreto (false).

    • color: color configurado para el tipo de incidencia.

    • calculationType: método de cálculo del tiempo computado. Los posibles valores son DURATION, PROPORTIONAL, NOT_COMPUTABLE, FIXED, ASSIGNMENT o DAILY_LIMIT_AND_PATTERNS.

    • workedMinutes: minutos equivalentes que computa la incidencia cuando el calculationType es FIXED.

    • workedDays: días trabajables por semana que se asignan a este tipo de incidencia, usados como base para prorratear días laborables anuales.

    • holidays: determina si el tipo de incidencia representa vacaciones del empleado (usado en contadores e informes). Solo puede ser true si calculationType es PROPORTIONAL o NOT_COMPUTABLE.

Tal y como se aprecia en el ejemplo, la petición devolverá la información que se haya definido previamente en el catálogo de incidencias: nombre, abreviatura, etc., así como las especificaciones concretas del tipo de incidencia.

Consideraciones

Los campos initTime y endTime devuelven la hora local, es decir, la zona horaria configurada para el servicio.

Si no hay incidencias para el periodo de tiempo indicado en la URL, la petición devolverá un array vacío [].

Códigos de error

Además de los errores comunes, este endpoint puede devolver los siguientes códigos:

Código Mensaje Descripción

406 Not Acceptable

-

El intervalo indicado entre las fechas de la URL supera los 30 días permitidos. Se recomienda ajustar el rango de fechas de la consulta.

Enlaces de interés

¿Qué es una incidencia?

¿Cómo integrar incidencias?