Obtener bolsas de un negocio

Este endpoint devuelve todas las bolsas definidas a nivel de negocio, incluyendo los contadores que se toman en consideración y las bolsas relacionadas.

GET /api/v1/businesses/{businessId}/bags

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

  • id: identificador externo de la bolsa.

  • name: nombre definido para la bolsa.

  • defaultStartQuantity: cantidad inicial predeterminada de la bolsa.

  • expiration: caducidad de los datos de la bolsa (en días).

  • dataType: tipo de dato.

  • symbol: símbolo asociado al tipo de dato.

  • defaultStartDay: día de inicio predeterminado de la bolsa.

  • periodicity: periodicidad de la bolsa.

  • calculationMethod: procedencia de la información. Puede ser de las asignaciones (ASSIGNMENTS), de los fichajes (CLOCK_GUARDS) o de ambos (ASSIGNMENTS_AND_CLOCK_GUARDS).

  • positiveCounters: lista de contadores que afectan positivamente a la bolsa.

  • negativeCounters: lista de contadores que afectan negativamente a la bolsa.

  • bagRelationships: lista de identificadores de bolsas relacionadas.

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

[
    {
        "name": "Worked hours",
        "defaultStartQuantity": 0.0,
        "dataType": "TIME",
        "defaultStartDay": "2022-01-01",
        "periodicity": "YEAR",
        "calculationMethod": "ASSIGNMENTS",
        "positiveCounters": [
            "THM"
        ],
        "negativeCounters": [],
        "bagRelationships": [null]
    },
    {
        "id": "OT",
        "name": "Overtime",
        "defaultStartQuantity": 0.0,
        "dataType": "TIME",
        "defaultStartDay": "2024-01-01",
        "periodicity": "QUARTER",
        "calculationMethod": "ASSIGNMENTS_AND_CLOCK_GUARDS",
        "positiveCounters": [
            "HCM",
            "HNT1M"
        ],
        "negativeCounters": [
            "HNNM"
        ],
        "bagRelationships": []
    },
    {
        "id": "HPY",
        "name": "Holidays from the previous year",
        "defaultStartQuantity": 0.0,
        "dataType": "NUMERIC",
        "defaultStartDay": "2024-01-01",
        "periodicity": "YEAR",
        "calculationMethod": "ASSIGNMENTS_AND_CLOCK_GUARDS",
        "positiveCounters": [],
        "negativeCounters": [],
        "bagRelationships": []
    }
]

La respuesta contendrá los datos que se hayan definido para cada bolsa a nivel de negocio. Así, por ejemplo, si no se ha establecido el identificador externo de la bolsa, la petición no podrá devolver ese dato.

Aspectos que tener en cuenta

Si no hay bolsas para el negocio indicado en la URL, la petición devolverá un array vacío [].

Los contadores listados en la respuesta se identifican por el shortName, es decir, por la abreviatura del contador en el sistema.

Si alguna de las bolsas relacionadas (bagRelationships) no tiene definido el identificador externo en el sistema, en la respuesta aparecerá null.

Enlaces de interés

¿Qué es una bolsa?

¿Qué es un contador?