Obtener contadores con fichajes (por servicio)

Este endpoint permite consultar los datos de los contadores de un servicio en un periodo no superior a 31 días. Para el cálculo, solo se tendrán en cuenta los fichajes consolidados.

GET /api/v2/businesses/{businessId}/services/{serviceId}/counters-with-only-clockguards?businessCounterIds={id}&from={yyyy-MM-dd}&to={yyyy-MM-dd}

Los identificadores que se deben utilizar en la URL (businessCounterIds) son los que vinculan al negocio con el contador. Estos identificadores se pueden consultar aquí.

Si los datos incluidos en la petición son correctos, la respuesta contendrá los datos de los contadores.

Ejemplo de respuesta

GET /api/v2/businesses/BUSINESSID/services/SERVICEID/counters-with-only-clockguards?businessCounterIds=4035&from=2024-11-18&to=2024-11-20
[
    {
        "counter": {
            "id": 4035,
            "counterType": {
                "id": 1,
                "key": "counter.weekly_net_hours",
                "shortName": "HNS",
                "scope": "WEEK",
                "dataType": "TIME"
            }
        },
        "counts": [
            {
                "key": "HNS_20241118_20241124",
                "from": "2024-11-18",
                "to": "2024-11-24",
                "total": [
                    {
                        "employeeId": "1006350",
                        "count": 0.0
                    },
                    {
                        "employeeId": "1006356",
                        "count": 120.0
                    },
                    {
                        "employeeId": "1006352",
                        "count": 0.0
                    }
                ]
            }
        ]
    }
]
Detalles

  • counter: información del contador.

    • id: identificador del Business Counter (vinculación del negocio con el tipo de contador).

    • counterType: información del tipo de contador.

      • id: identificador interno del tipo de contador.

      • key: clave del tipo de contador definida a nivel interno.

      • shortName: abreviatura del tipo de contador.

      • scope: ámbito temporal del contador (WEEK, MONTH, YEAR, etc.).

      • dataType: tipo de dato del contador (TIME, INTEGER, etc.).

  • counts: lista de periodos con los valores del contador.

    • key: clave que identifica el periodo de cálculo.

    • from: fecha de inicio del periodo de cálculo.

    • to: fecha de fin del periodo de cálculo.

    • total: lista de valores por empleado en el periodo.

      • employeeId: identificador externo del empleado.

      • count: valor del contador para el periodo indicado.

En el ejemplo, el contador muestra las horas netas semanales trabajadas por cada empleado del servicio. Este contador se representa en minutos: 120.0 equivale a dos horas.

Aspectos que tener en cuenta

La respuesta dependerá de la configuración del contador, como el ámbito (semanal, mensual, anual, etc.) o el tipo de dato (minutos, cantidad de días, etc.).

Se puede consultar la información de varios contadores en la misma petición incluyendo los diferentes identificadores en la URL, separados por comas: ?businessCounterIds=id1,id2,…​.

Si alguno de estos identificadores no se corresponde con los del negocio, la petición devolverá un error indicando No value present.

Si no hay fichajes consolidados que repercutan en el contador para el periodo indicado en la URL, el contador indicará 0.0.

Si el periodo de consulta es superior a 31 días, la petición devolverá un error 406 Not Acceptable, indicando The request exceded the maximum number of days allowed (31 days max).

Los empleados que no tengan configurado un identificador externo en el sistema (employeeId) no aparecerán en la respuesta.

Enlaces de interés

¿Qué es un contador?

¿Qué son los fichajes consolidados?