AttendanceBook/GetWeeklyAttendanceColombia

Descripción

Muestra la información del libro de asistencia de Colombia

 

Request

Request Body

Importante

 

  • Se puede ver la información en Reportes > Gestión de Asistencia.
  • Si se quiere consultar por más de un usuario en el campo “UserIds” se debe añadir más identificadores separados por “,”.
  • El campo “EndDate” debe ser como máximo 12 meses en el futuro a partir de la fecha actual.
  • El máximo de usuarios que se pueden consultar son 200.
  • El máximo de registros que se pueden devolver son 1500.
  • La máxima cantidad de días que se pueden solicitar entre la fecha de inicio y término son 62 días.

 

Ejemplo request

{
    "StartDate": "20241023000000",  
    "EndDate": "20241023235959",    
    "UserIds": "111111111"    
}

Response

Response Body

Importante

 

  • Los guiones permiten representar los campos que están en el interior de otro campo. Por ejemplo:
    Campo 1
    – Campo 1.1
    — Campo 1.1.1
  • La información en los campos “AccomplishedExtraTimeBefore”, “AccomplishedExtraTimeAfter”y  “AccomplishedExtraTime” van a tener campos basados en los valores de horas extras que haya registrado y asignado la empresa, y por ende, va a variar caso a caso el contenido de estos. Un ejemplo de como se muestra la información es: “ValorHoraExtra”:”HH:MM”, donde HH son las horas y MM minutos.
  • En el campo “Weeks” devuelve la información semanal (7 días) independiente del periodo seleccionado. En el ejemplo del response solo se muestra 1 día.

 

Códigos






Código Descripción
200 Éxito
400 Error en el request
500 Error no controlado, contactar a GV



Ejemplo response

{
    "Users": [
        {
            "PlannedInterval": [
                {
                    "Surcharge": {
                        "OrdinaryNocturnalSurchargeHours": "00:00",
                        "NonCompensatedSundayDiurnalSurchargeHours": "00:00",
                        "NonCompensatedSundayNocturnalSurchargeHours": "00:00",
                        "NonCompensatedHolidayDiurnalSurchargeHours": "00:00",
                        "NonCompensatedHolidayNocturnalSurchargeHours": "00:00",
                        "CompensatedSundayDiurnalSurchargeHours": "00:00",
                        "CompensatedSundayNocturnalSurchargeHours": "00:00",
                        "CompensatedHolidayDiurnalSurchargeHours": "00:00",
                        "CompensatedHolidayNocturnalSurchargeHours": "00:00",
                        "SurchargeRanges": {
                            "OrdinarySurcharge": [
                                {
                                    "Value": "05:30:00",
                                    "StartDate": "2024-10-23T14:00:00",
                                    "EndDate": "2024-10-23T19:30:00",
                                    "HourType": 0
                                }
                            ],
                            "NonCompesatedSundaySurcharge": [],
                            "NonCompesatedHolidaySurcharge": [],
                            "CompensatedSundaySurcharge": [],
                            "CompensatedHolidaySurcharge": []
                        },
                        "SurchargeRangesAggregate": {
                            "OrdinaryNightSurcharge": [],
                            "NonCompesatedSundayDaySurcharge": [],
                            "NonCompesatedSundayNightSurcharge": [],
                            "NonCompesatedHolidayDaySurcharge": [],
                            "NonCompesatedHolidayNightSurcharge": [],
                            "CompensatedSundayDaySurcharge": [],
                            "CompensatedSundayNightSurcharge": [],
                            "CompensatedHolidayDaySurcharge": [],
                            "CompensatedHolidayNightSurcharge": []
                        },
                        "CompensatedSunday": "False",
                        "CompensatedHoliday": "False"
                    },
                    "CompensatedDay": "False",
                    "AdditionalTimeBefore": "00:00",
                    "AdditionalTimeAfter": "00:00",
                    "OrdinaryDiurnalOvertime": "00:00",
                    "OrdinaryNocturnalOvertime": "00:00",
                    "SundayDiurnalOvertime": "00:00",
                    "SundayNocturnalOvertime": "00:00",
                    "HolidayDiurnalOvertime": "00:00",
                    "HolidayNocturnalOvertime": "00:00",
                    "PlannedShift": {
                        "Id": "8CM8Hc0xYN9wN7v_di_rAQ",
                        "StartTime": "09:00",
                        "MaxStartTime": "",
                        "ExitTime": "18:30",
                        "Type": "FixedShift",
                        "FixedShiftHours": "00:00",
                        "ShiftDisplay": "09:00 - 18:30 (60 mins)",
                        "BreakType": "FreeLunch",
                        "BreakMinutes": "60",
                        "BreakStart": "00:00",
                        "BreakEnd": "00:00",
                        "Status": "enabled",
                        "Custom": "base"
                    },
                    "OvertimeRanges": {
                        "OrdinaryOvertimeBeforeShift": [],
                        "OrdinaryOvertimeAfterShift": [],
                        "SundayOvertimeBeforeShift": [],
                        "SundayOvertimeAfterShift": [],
                        "HolidayOvertimeBeforeShift": [],
                        "HolidayOvertimeAfterShift": []
                    },
                    "OvertimeRangesAggregate": {
                        "OrdinaryDayOvertime": [],
                        "OrdinaryNightOvertime": [],
                        "SundayDayOvertime": [],
                        "SundayNightOvertime": [],
                        "HolidayDayOvertime": [],
                        "HolidayNightOvertime": []
                    },
                    "Date": "20241023000000",
                    "Punches": [
                        {
                            "Type": "Ingreso",
                            "Date": "20241023080000",
                            "Origin": "web",
                            "GroupDescription": "Grupo base",
                            "UploadDate": "20241023151229",
                            "ShiftPunchType": "Entrada",
                            "AssignedInBook": true,
                            "BoxSn": "",
                            "IdTask": "",
                            "IdProject": "",
                            "Checksum": "Or0W1Y0QTo_P6OU-CvheJr2SDs-S-v3yuAmLEx5tvxv6YwZYuP3cOSRHx8wxxt8YtdCKX1zs0Q--BXbSTxf_JogOA47iPTTp98fb7JemEwt18RG9xfKgRLMKd6ZRh8PR"
                        }
                    ],
                    "Shifts": [
                        {
                            "Ends": "20241023183000",
                            "Begins": "20241023090000",
                            "Id": "8CM8Hc0xYN9wN7v_di_rAQ",
                            "StartTime": "09:00",
                            "MaxStartTime": "",
                            "ExitTime": "18:30",
                            "Type": "FixedShift",
                            "FixedShiftHours": "00:00",
                            "ShiftDisplay": "09:00 - 18:30 (60 mins)",
                            "BreakType": "FreeLunch",
                            "BreakMinutes": "60",
                            "BreakStart": "00:00",
                            "BreakEnd": "00:00",
                            "Status": "enabled",
                            "Custom": "base"
                        }
                    ],
                    "Delay": "00:00",
                    "BreakDelay": "00:00",
                    "EarlyLeave": "00:00",
                    "DelayTimeAfterCompensation": "00:00",
                    "EarlyLeaveTimeAfterCompensation": "00:00",
                    "TimeOffs": [
                        {
                            "TimeOffTypeId": "V5H8zAbqqjup-FsKEDwDzw",
                            "Description": "aaa",
                            "Starts": "20241023000000",
                            "Ends": "20241023235959",
                            "TimeOffTypeDescription": "",
                            "TimeOffOrigin": "web",
                            "StartTime": "09:00:00",
                            "EndTime": "14:00:00",
                            "AmountHours": "00:00:00"
                        }
                    ],
                    "WorkedHours": "05:30",
                    "Absent": "False",
                    "Holiday": "False",
                    "Worked": "True",
                    "CoveredNonWorkingHours": "00:00",
                    "AuthorizedOvertimeBefore": "01:00",
                    "AuthorizedOvertimeAfter": "01:00",
                    "AccomplishedExtraTimeBefore": {
                        "50": "01:00"
                    },
                    "AccomplishedExtraTimeAfter": {
                        "50": "01:00"
                    },
                    "AccomplishedExtraTime": {
                        "50": "02:00"
                    }
                }
            ],
            "Weeks": [
                {
                    "Intervals": [
                        {
                            "Surcharge": {
                                "OrdinaryNocturnalSurchargeHours": "00:00",
                                "NonCompensatedSundayDiurnalSurchargeHours": "00:00",
                                "NonCompensatedSundayNocturnalSurchargeHours": "00:00",
                                "NonCompensatedHolidayDiurnalSurchargeHours": "00:00",
                                "NonCompensatedHolidayNocturnalSurchargeHours": "00:00",
                                "CompensatedSundayDiurnalSurchargeHours": "00:00",
                                "CompensatedSundayNocturnalSurchargeHours": "00:00",
                                "CompensatedHolidayDiurnalSurchargeHours": "00:00",
                                "CompensatedHolidayNocturnalSurchargeHours": "00:00",
                                "SurchargeRanges": {
                                    "OrdinarySurcharge": [
                                        {
                                            "Value": "00:00:00",
                                            "StartDate": "2024-10-21T18:30:00",
                                            "EndDate": "2024-10-21T18:30:00",
                                            "HourType": 0
                                        }
                                    ],
                                    "NonCompesatedSundaySurcharge": [],
                                    "NonCompesatedHolidaySurcharge": [],
                                    "CompensatedSundaySurcharge": [],
                                    "CompensatedHolidaySurcharge": []
                                },
                                "SurchargeRangesAggregate": {
                                    "OrdinaryNightSurcharge": [],
                                    "NonCompesatedSundayDaySurcharge": [],
                                    "NonCompesatedSundayNightSurcharge": [],
                                    "NonCompesatedHolidayDaySurcharge": [],
                                    "NonCompesatedHolidayNightSurcharge": [],
                                    "CompensatedSundayDaySurcharge": [],
                                    "CompensatedSundayNightSurcharge": [],
                                    "CompensatedHolidayDaySurcharge": [],
                                    "CompensatedHolidayNightSurcharge": []
                                },
                                "CompensatedSunday": "False",
                                "CompensatedHoliday": "False"
                            },
                            "CompensatedDay": "False",
                            "AdditionalTimeBefore": "00:00",
                            "AdditionalTimeAfter": "00:00",
                            "OrdinaryDiurnalOvertime": "00:00",
                            "OrdinaryNocturnalOvertime": "00:00",
                            "SundayDiurnalOvertime": "00:00",
                            "SundayNocturnalOvertime": "00:00",
                            "HolidayDiurnalOvertime": "00:00",
                            "HolidayNocturnalOvertime": "00:00",
                            "PlannedShift": {
                                "Id": "8CM8Hc0xYN9wN7v_di_rAQ",
                                "StartTime": "09:00",
                                "MaxStartTime": "",
                                "ExitTime": "18:30",
                                "Type": "FixedShift",
                                "FixedShiftHours": "00:00",
                                "ShiftDisplay": "09:00 - 18:30 (60 mins)",
                                "BreakType": "FreeLunch",
                                "BreakMinutes": "60",
                                "BreakStart": "00:00",
                                "BreakEnd": "00:00",
                                "Status": "enabled",
                                "Custom": "base"
                            },
                            "OvertimeRanges": {
                                "OrdinaryOvertimeBeforeShift": [],
                                "OrdinaryOvertimeAfterShift": [],
                                "SundayOvertimeBeforeShift": [],
                                "SundayOvertimeAfterShift": [],
                                "HolidayOvertimeBeforeShift": [],
                                "HolidayOvertimeAfterShift": []
                            },
                            "OvertimeRangesAggregate": {
                                "OrdinaryDayOvertime": [],
                                "OrdinaryNightOvertime": [],
                                "SundayDayOvertime": [],
                                "SundayNightOvertime": [],
                                "HolidayDayOvertime": [],
                                "HolidayNightOvertime": []
                            },
                            "Date": "20241021000000",
                            "Punches": [
                                {
                                    "Type": "Ingreso",
                                    "Date": "20241021080000",
                                    "Origin": "web",
                                    "GroupDescription": "Grupo base",
                                    "UploadDate": "20241024130908",
                                    "ShiftPunchType": "Entrada",
                                    "AssignedInBook": true,
                                    "BoxSn": "",
                                    "IdTask": "",
                                    "IdProject": "",
                                    "Checksum": "ez1yQbJ8ax-em48VnI6ZmgLb9Vg9m-9V-IzUZLfolom42NoPXYPLkoPbQylFi7dkvVdKM4rcx7AWut1mj0gMRy6WlP10uiQFFqekWKSExvkyAiErjz882HDkNz2dnQl-"
                                }
                            ],
                            "Shifts": [
                                {
                                    "Ends": "20241021183000",
                                    "Begins": "20241021090000",
                                    "Id": "8CM8Hc0xYN9wN7v_di_rAQ",
                                    "StartTime": "09:00",
                                    "MaxStartTime": "",
                                    "ExitTime": "18:30",
                                    "Type": "FixedShift",
                                    "FixedShiftHours": "00:00",
                                    "ShiftDisplay": "09:00 - 18:30 (60 mins)",
                                    "BreakType": "FreeLunch",
                                    "BreakMinutes": "60",
                                    "BreakStart": "00:00",
                                    "BreakEnd": "00:00",
                                    "Status": "enabled",
                                    "Custom": "base"
                                }
                            ],
                            "Delay": "00:00",
                            "BreakDelay": "00:00",
                            "EarlyLeave": "01:00",
                            "DelayTimeAfterCompensation": "00:00",
                            "EarlyLeaveTimeAfterCompensation": "01:00",
                            "TimeOffs": [
                                {
                                    "TimeOffTypeId": "V5H8zAbqqjup-FsKEDwDzw",
                                    "Starts": "20241021000000",
                                    "Ends": "20241021235959",
                                    "TimeOffTypeDescription": "",
                                    "TimeOffOrigin": "web",
                                    "StartTime": "17:30:00",
                                    "EndTime": "18:30:00",
                                    "AmountHours": "00:00:00"
                                }
                            ],
                            "WorkedHours": "00:00",
                            "Absent": "False",
                            "Holiday": "False",
                            "Worked": "True",
                            "CoveredNonWorkingHours": "00:00",
                            "AuthorizedOvertimeBefore": "01:00",
                            "AuthorizedOvertimeAfter": "00:00",
                            "AccomplishedExtraTimeBefore": {
                                "50": "01:00"
                            },
                            "AccomplishedExtraTimeAfter": {
                                "50": "01:00"
                            },
                            "AccomplishedExtraTime": {
                                "50": "01:00"
                            }
                        }
                    ],
                    "TimeOffWithEnjoyment": "09:30",
                    "TimeOffNonEnjoyment": "05:00",
                    "OrdinaryDiurnalOvertimeHours": "00:00",
                    "OrdinaryNocturnalOvertimeHours": "00:00",
                    "SundayDiurnalOvertimeHours": "00:00",
                    "SundayNocturnalOvertimeHours": "00:00",
                    "HolidayDiurnalOvertimeHours": "00:00",
                    "HolidayNocturnalOvertimeHours": "00:00",
                    "Surcharge": {
                        "OrdinaryNocturnalSurchargeHours": "00:00",
                        "NonCompensatedSundayDiurnalSurchargeHours": "00:00",
                        "NonCompensatedSundayNocturnalSurchargeHours": "00:00",
                        "NonCompensatedHolidayDiurnalSurchargeHours": "00:00",
                        "NonCompensatedHolidayNocturnalSurchargeHours": "00:00",
                        "CompensatedSundayDiurnalSurchargeHours": "00:00",
                        "CompensatedSundayNocturnalSurchargeHours": "00:00",
                        "CompensatedHolidayDiurnalSurchargeHours": "00:00",
                        "CompensatedHolidayNocturnalSurchargeHours": "00:00",
                        "SurchargeRanges": { 
                            "OrdinarySurcharge": [], 
                            "NonCompesatedSundaySurcharge": [], 
                            "NonCompesatedHolidaySurcharge": [], 
                            "CompensatedSundaySurcharge": [], 
                            "CompensatedHolidaySurcharge": [] 
                        }, 
                        "SurchargeRangesAggregate": { 
                            "OrdinaryNightSurcharge": [], 
                            "NonCompesatedSundayDaySurcharge": [], 
                            "NonCompesatedSundayNightSurcharge": [], 
                            "NonCompesatedHolidayDaySurcharge": [], 
                            "NonCompesatedHolidayNightSurcharge": [], 
                            "CompensatedSundayDaySurcharge": [], 
                            "CompensatedSundayNightSurcharge": [], 
                            "CompensatedHolidayDaySurcharge": [], 
                            "CompensatedHolidayNightSurcharge": [] 
                        },
                        "CompensatedSunday": "False",
                        "CompensatedHoliday": "False"
                    },
                    "WorkedHours": "24:30",
                    "NonWorkedHours": "00:00",
                    "ActualWorkedHours": "00:00",
                    "TotalOvertime": "00:00",
                    "TotalApprovedOvertime": "04:00",
                    "JustifiedHours": "00:00",
                    "PlannedHours": "19:00",
                    "SundaysWorkedHours": "00:00",
                    "HolidaysWorkedHours": "00:00",
                    "SundaysOvertime": "00:00",
                    "SpecialOvertime": "00:00",
                    "HoursPartTime": "00:00",
                    "HE7D": "00:00",
                    "ProfitHours": "00:00",
                    "AllDaysLocked": false,
                    "TotalLunchTimeTaken": "00:00",
                    "TotalPlannedLunchTime": "00:00",
                    "TotalExtraTime": "00:00",
                    "CompensatedWorkedTime": "00:00",
                    "TotalWeekOvertimeAssignment": "00:00"
                }
            ],
            "HoursLeaveWithPay": "09:30",
            "HoursLeaveWithOutPay": "05:00",
            "NonCompensatedSundayDiurnalSurchargeHours": "00:00",
            "NonCompensatedHolidayDiurnalSurchargeHours": "00:00",
            "NonCompensatedSundayNocturnalSurchargeHours": "00:00",
            "NonCompensatedHolidayNocturnalSurchargeHours": "00:00",
            "CompensatedSundayDiurnalSurchargeHours": "00:00",
            "CompensatedSundayNocturnalSurchargeHours": "00:00",
            "CompensatedHolidayDiurnalSurchargeHours": "00:00",
            "CompensatedHolidayNocturnalSurchargeHours": "00:00",
            "OrdinaryNocturnalSurchargeHours": "00:00",
            "Compensated": [],
            "CompensatedDaysAmount": "0",
            "CompensatedSundaysAmount": "0",
            "CompensatedHolidaysAmount": "0",
            "TotalOrdinaryDiurnalOvertime": "00:00",
            "TotalOrdinaryNocturnalOvertime": "00:00",
            "TotalSundayDiurnalOvertime": "00:00",
            "TotalSundayNocturnalOvertime": "00:00",
            "TotalHolidayDiurnalOvertime": "00:00",
            "TotalHolidayNocturnalOvertime": "00:00",
            "TotalHoursActuallyWorked": "00:00",
            "TotalsDaysCounted": {
                "DayWithPay": 2,
                "DayWithoutPay": 0,
                "AttendedDay": 2,
                "RestDay": 0,
                "ShouldNotWorkHoliday": 0,
                "TimeOffWithPay": 0,
                "Absences": 0,
                "TimeOffWithoutPay": 0,
                "ShouldWorkHoliday": 0,
                "AttendedHoliday": 0,
                "AttendedSunday": 0,
                "Vacations": 0,
                "MedicalLicense": 0
            },
            "TotalNonWorkedHours": "00:00",
            "TotalWorkedHours": "24:30",
            "WorkedDays": 2,
            "NonWorkedDays": 0,
            "Absences": 0,
            "TotalSundayWorkedHours": "00:00",
            "TotalSundayActualWorkedHours": "00:00",
            "TotalHolidayWorkedHours": "00:00",
            "TotalHolidayActualWorkedHours": "00:00",
            "TotalPlannedTime": "19:00",
            "TotalOvertime": {
                "50": "02:00:00"
            },
            "TotalOvertimeDiurnal": {},
            "TotalOvertimeNocturnal": {},
            "OvertimeAssigned": "00:00",
            "TotalOvertimeHoursAccomplished": "02:00",
            "TotalDiurnalWorkedHours": "19:00",
            "TotalNocturnalWorkedHours": "00:00",
            "TotalNocturnalActuallyWorkedHours": "00:00",
            "OvertimeAuthorizedBefore": "02:00",
            "OvertimeAuthorizedAfter": "02:00",
            "Holidays": 0,
            "TotalHoursProfit": "00:00",
            "Vacation": 0,
            "DaysLeaveWithPay": 1,
            "DaysLeaveWithoutPay": 1,
            "AbsenceDaysWithoutJustification": 0,
            "AbsenceDaysLicense": 0,
            "WorkedSundays": 0,
            "WorkedHolidays": 0,
            "DaysAttended": 2,
            "TotalWorkedHoursOnRest": "00:00",
            "TotalOvertimeAssignment": "00:00",
            "Id": "lHkQYOv3c87ClN0yWWSaLQ",
            "Identifier": "111111111",
            "Enabled": "1",
            "Name": "Eduardo",
            "LastName": "Sanchez",
            "Email": "correoejemplo2@gmail.com",
            "GroupDescription": "Grupo base",
            "PositionId": "sXRGS9wLs7E5zu09Yqyn3Q",
            "PositionDescription": "Desarrollo",
            "WeeklyWorkingHoursCodeId": "sDzBzlFnefikfhnZoFXLiw",
            "CustomColumn1": "1",
            "CustomColumn2": "1",
            "CustomColumn3": "1",
            "IsHiddenForReports": "False"
        }
    ]
}

Postman

Ejemplo 1
Ejemplo 1

Tabla de contenidos