Recent Posts

Recent Comments

Archives

Categories

Consolidated/Extended

Publicado
Updated
BySantiago






POST
https://customerapi.geovictoria.com/api/v1/Consolidated/Extended


Descripción

Muestra información consolidada (extendida) de uno o más usuarios en un periodo de tiempo.

 

Request

Request Body






Campos Largo Requerido Tipo de dato Descripción
StartDate 14 Sí String Indica la fecha de inicio en formato yyyyMMddHHmmss
EndDate 14 Sí String Indica la fecha de fin en formato yyyyMMddHHmmss
UserIds 16 Sí String Identificador del usuario separado por “,”
IncludeAll 1 No String Indica si se consideran todos los usuarios activos (“0”) o si se incluye todos los usuarios (“1”)


Importante

 

  • Se puede apreciar la información en Reportes > Remuneraciones.
  • 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",    
    "IncludeAll": 0 
}

Response

Response Body






Campos Tipo de dato Descripción
Total Objeto Contiene información que resume el periodo indicado
– PaidDays Integer Indica la cantidad de días trabajados que son remunerados
– NonPaidDays Integer Indica la cantidad de días trabajados que no son remunerados
PaidDays Objeto Contiene información respecto a los días remunerados
– RestDays Integer Indica la cantidad de días de descanso.
– WorkedDays Integer Indica la cantidad de días trabajados.
– Holidays Integer Indica la cantidad de días feriados.
– Vacations Integer Indica la cantidad de días de vacaciones.
– PaidTimeOffDays Integer Indica la cantidad de días con permisos remunerados.
NonPaidDays Integer Contiene información respecto a los días no remunerados
– UnjustifiedAbsenseDays Integer Indica la cantidad de días de inasistencia sin justificar
– Leaves Integer Indica la cantidad de días con licencia médica
– NonPaidTimeOffDays Integer Indica la cantidad de días con permisos no remunerados
– NonWorkedHolidays Integer Indica la cantidad de días que no se trabajo en feriados
WorkedSundays Integer Indica la cantidad de domingos trabajados
WorkedSundaysHours String Indica la cantidad de horas trabajadas los días domingos en formato HH:mm
ActuallyWorkedSundaysHours String Indica la cantidad de horas realmente trabajadas los días domingos en formato HH:mm
WorkedHolidays Integer Indica la cantidad de días trabajados en feriados
WorkedHolidaysHours String Indica la cantidad de horas trabajados en feriados en formato HH:mm
ActuallyWorkedHolidaysHours Integer Indica la cantidad de horas realmente trabajados en feriados en formato HH:mm
Identifier String Identificador único del usuario
WorkedHours String Cantidad de horas trabajadas en formato HH:mm
NonWorkedHours String Cantidad de horas no trabajadas
TotalAuthorizedExtraTime String Cantidad de tiempo extra cumplido en formato HH:mm
TotalAuthorizedOvertime String Cantidad de horas extra autorizadas en formato HH:mm
Absent Integer Cantidad de días ausentes
AccomplishedExtraTime String Indica el detalle del tiempo extra cumplidos del usuario en formato HH:mm


Importante

 

  • La información del objeto «AccomplishedExtraTime» va 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.

 

Códigos






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



Ejemplo response

[
    {
        "Totals": {
            "PaidDays": 2,
            "NonPaidDays": 0
        },
        "PaidDays": {
            "RestDays": 0,
            "WorkedDays": 1,
            "Holidays": 0,
            "Vacations": 1,
            "PaidTimeOffDays": 0
        },
        "NonPaidDays": {
            "UnjustifiedAbsenseDays": 0,
            "Leaves": 0,
            "NonPaidTimeOffDays": 0,
            "NonWorkedHolidays": 0
        },
        "WorkedSundays": 0,
        "WorkedSundaysHours": "00:00",
        "ActuallyWorkedSundaysHours": "00:00",
        "WorkedHolidays": 0,
        "WorkedHolidaysHours": "00:00",
        "ActuallyWorkedHolidaysHours": "00:00",
        "Identifier": "111111111",
        "WorkedHours": "09:30",
        "NonWorkedHours": "00:00",
        "TotalAuthorizedExtraTime": "02:00",
        "TotalAuthorizedOvertime": "00:00",
        "Absent": 0,
        "AccomplishedExtraTime": {
            "50": "02:00"
        }
    }
]

Postman

Ejemplo 1
Ejemplo 1

Tabla de contenidos