Obtener contadores por producto - solo asignaciones
Este endpoint permite consultar los datos de los contadores de un producto en un periodo no superior a 366 días. Para el cálculo, solo se tendrán en cuenta las asignaciones.
GET /api/v2/businesses/{businessId}/products/{productId}/counters-with-only-assignments?businessCounterIds={id}&from={yyyy-MM-dd}&to={yyyy-MM-dd}
|
Los identificadores que se deben utilizar en la URL ( |
Si los datos incluidos en la petición son correctos, la respuesta contendrá los datos de los contadores indicados en la URL.
Ejemplo de respuesta
GET /api/v2/businesses/BUSINESSID/products/PRODUCTID/counters-with-only-assignments?businessCounterIds=4035&from=2026-08-18&to=2026-08-21
[
{
"counter": {
"id": 4035,
"counterType": {
"id": 1,
"key": "counter.weekly_net_hours",
"shortName": "HNS",
"scope": "WEEK",
"dataType": "TIME"
},
"customName": "Horas netas",
"customShortName": "HN"
},
"counts": [
{
"key": "HNS_HN_20260817_20260823",
"from": "2026-08-17",
"to": "2026-08-23",
"total": [
{
"employeeId": "1006350",
"count": 360.0,
"dailyCount": [
{
"day": "2026-08-19",
"count": 120
},
{
"day": "2026-08-18",
"count": 240
}
]
},
{
"employeeId": "170326",
"count": 0.0,
"dailyCount": []
}
]
}
]
}
]
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.).
-
-
customName: nombre personalizado del contador, presente únicamente si se ha definido una parametrización personalizada.
-
customShortName: abreviatura personalizada del contador, presente únicamente si se ha definido una abreviatura personalizada.
-
-
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.
-
dailyCount: desglose diario del valor del contador para el empleado. Si no hay valores, aparecerá un array vacío
[].-
day: fecha a la que corresponde el valor.
-
count: valor del contador para ese día.
-
-
-
En el ejemplo, el contador muestra las horas netas semanales trabajadas por cada empleado, expresado en minutos.
Consideraciones
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 no hay datos que repercutan en el contador para el periodo indicado en la URL, indicará "count": 0.0.
Los empleados que no tengan configurado un identificador externo en el sistema (employeeId) aparecerán en la respuesta sin este campo.
Códigos de error
Además de los errores comunes, este endpoint puede devolver los siguientes códigos:
| Código | Mensaje | Descripción |
|---|---|---|
- |
No value present |
Alguno de los identificadores indicados en |
|
The request exceded the maximum number of days allowed (366 days max) |
El periodo solicitado entre |
Enlaces de interés
¿Qué es un contador?
¿Qué es una asignación?