Obtener contadores activos de un negocio

Este endpoint permite conocer los contadores activos de un negocio.

GET /api/v2/businesses/{businessId}/counter

Si los datos incluidos en la petición son correctos —businessId—, la respuesta contendrá el listado de contadores activos dentro del negocio, detallando la siguiente información:

  • id: identificador único que relaciona el negocio con el contador.

  • shortName: abreviatura del contador. Si no se proporciona una personalizada, se utilizará la abreviatura predeterminada del contador.

  • scope: alcance temporal del contador. Los posibles valores son YEAR, SEMESTER, MONTH, WEEK, DAY y CUSTOM, por lo que el parámetro determina si el contador mide los datos a nivel anual, semestral, mensual, semanal, diario o en un intervalo personalizado.

  • dataType: tipo de dato que maneja el contador. Los posibles valores son NONE, TIME, LOCALTIME, INTEGER, DECIMAL, BOOLEAN y PERCENTAGE.

A continuación, se muestra un ejemplo de respuesta:

[
    {
        "id": 4035,
        "shortName": "HNS",
        "scope": "WEEK",
        "dataType": "TIME"
    },
    {
        "id": 4036,
        "shortName": "DLM",
        "scope": "MONTH",
        "dataType": "INTEGER"
    },
    {
        "id": 4037,
        "shortName": "HNM",
        "scope": "MONTH",
        "dataType": "TIME"
    },
    {
        "id": 4038,
        "shortName": "DLS",
        "scope": "WEEK",
        "dataType": "INTEGER"
    }
]

Aspectos que tener en cuenta

La petición devuelve los contadores activos asociados al negocio, los cuales podrán ser luego seleccionados a nivel de servicio para visibilidad en determinadas pantallas.