AttendanceBook/GetConsolidatedColombia
POST https://customerapi.geovictoria.com/api/v1/AttendanceBook/GetConsolidatedColombia
Descripción
Obtener el consolidado del libro de asistencia de Colombia con los valores calculados (horas extra, recargos y días especiales) para un periodo de tiempo y un conjunto de usuarios. Entrega un objeto por usuario con los totales del periodo.
Request
Request Body
| Campos | Tipo de dato | Descripción |
|---|---|---|
| StartDate | String | Fecha inicial de consulta. Formato yyyyMMddHHmmss. Requerido |
| EndDate | String | Fecha final de consulta. Formato yyyyMMddHHmmss. Requerido |
| UserIds | String | Lista de identificadores de usuario separados por coma. Requerido |
{
"StartDate": "20240501000000",
"EndDate": "20240531235959",
"UserIds": "1231231235,76831428"
}
Importante
- Este endpoint aplica únicamente a empresas configuradas como Colombia.
- Los montos de horas se devuelven en formato HH:MM.
Response
Response Body
| Campos | Tipo de dato | Descripción |
|---|---|---|
| Identifier | String | Identificador único del usuario |
| Absences | Number | Cantidad de inasistencias en el periodo |
| TotalOvertime | String | Total de horas extra del periodo (HH:MM), suma de todas las categorías |
| OrdinaryDiurnalOvertime | String | Horas extra diurnas ordinarias (HH:MM) |
| OrdinaryNocturnalOvertime | String | Horas extra nocturnas ordinarias (HH:MM) |
| SundayDiurnalOvertime | String | Horas extra diurnas dominicales (HH:MM) |
| SundayNocturnalOvertime | String | Horas extra nocturnas dominicales (HH:MM) |
| HolidayDiurnalOvertime | String | Horas extra diurnas festivas (HH:MM) |
| HolidayNocturnalOvertime | String | Horas extra nocturnas festivas (HH:MM) |
| OrdinaryNocturnalSurcharge | String | Recargo nocturno ordinario (HH:MM) |
| SundayDiurnalSurcharge | String | Recargo diurno dominical no compensado (HH:MM) |
| SundayNocturnalSurcharge | String | Recargo nocturno dominical no compensado (HH:MM) |
| HolidayDiurnalSurcharge | String | Recargo diurno festivo no compensado (HH:MM) |
| HolidayNocturnalSurcharge | String | Recargo nocturno festivo no compensado (HH:MM) |
| CompensatedSundayDiurnalSurcharge | String | Recargo diurno dominical compensado (HH:MM) |
| CompensatedSundayNocturnalSurcharge | String | Recargo nocturno dominical compensado (HH:MM) |
| CompensatedHolidayDiurnalSurcharge | String | Recargo diurno festivo compensado (HH:MM) |
| CompensatedHolidayNocturnalSurcharge | String | Recargo nocturno festivo compensado (HH:MM) |
| TotalSurcharge | String | Total de recargos del periodo (HH:MM) |
| SpecialDays | Array | Lista de días especiales del periodo (ver detalle abajo) |
SpecialDays
| Campos | Tipo de dato | Descripción |
|---|---|---|
| Date | String | Fecha del día (yyyyMMddHHmmss) |
| Absent | String | Indica si el usuario estuvo ausente ese día (True / False) |
| HasDelay | String | Indica si hubo atraso en la entrada (True / False) |
| Delay | String | Tiempo de atraso de la entrada (HH:MM) |
Códigos
| Código | Descripción |
|---|---|
| 200 | Éxito |
| 400 | Error en el request |
Ejemplo response
[
{
"Identifier": "12345678",
"Absences": 5,
"TotalOvertime": "65:13",
"OrdinaryDiurnalOvertime": "64:17",
"OrdinaryNocturnalOvertime": "00:56",
"SundayDiurnalOvertime": "00:00",
"SundayNocturnalOvertime": "00:00",
"HolidayDiurnalOvertime": "00:00",
"HolidayNocturnalOvertime": "00:00",
"OrdinaryNocturnalSurcharge": "00:00",
"SundayDiurnalSurcharge": "00:00",
"SundayNocturnalSurcharge": "00:00",
"HolidayDiurnalSurcharge": "00:00",
"HolidayNocturnalSurcharge": "00:00",
"CompensatedSundayDiurnalSurcharge": "00:00",
"CompensatedSundayNocturnalSurcharge": "00:00",
"CompensatedHolidayDiurnalSurcharge": "00:00",
"CompensatedHolidayNocturnalSurcharge": "00:00",
"TotalSurcharge": "00:00",
"SpecialDays": [
{
"Date": "20260401000000",
"Absent": "False",
"HasDelay": "True",
"Delay": "00:32"
},
{
"Date": "20260415000000",
"Absent": "False",
"HasDelay": "True",
"Delay": "01:07"
}
]
}
]