API - Folha de ponto

Objetivo

Descrever métodos de acesso à API de dados diários das folhas de ponto.

Listar dados das folhas de ponto

Lista tipo do dia (normal, N/T, compensado, falta, justificado, feriado ou férias), CH da regra diária e marcações de cada dia da folha de ponto do colaborador.

Endpoint

GET https://api1.tradingworks.net/v1/timecard/list

Parâmetros

FromDate - Obrigatório, período específico de início dos dados
ToDate - Obrigatório, período de término dos dados. Limite de 60 dias entre fromdate e todate
OnlyApproved - Opcional, padrão TRUE. Indica que somente folhas fechadas serão exportadas, se FALSE, todas as folhas aparecerão no resultado

Headers

AUTH-TOKEN = Sua Chave privada

Exemplo

GET https://api1.tradingworks.net/v1/timecard/list?fromdate=2023-05-01&todate=2023-05-02&onlyapproved=false
[
    {
        "EmployerCode": "01",
        "EmployeeNumber": "0012",
        "CH": 4,
        "PayrollAttendanceType": "Feriado",
        "BaseDate": "2023-05-01T00:00:00",
        "RegularHours": 0.0,
        "WorkedHoursNight": 0.0,
        "WorkedHoursNightCalc": 0.0,
        "LateHoursCalc": 0.0,
        "OvertimeHours1": 0.0,
        "OvertimeHours1Percent": 100,
        "OvertimeHours2": 0.0,
        "OvertimeHoursNight1": 0.0,
        "OvertimeHoursNight1Percent": 100,
        "OvertimeHoursNight2": 0.0,
        "CompTime": 0.0,
        "OnCall": 0.0,
        "OnCallWorked": 0.0,
        "Allowance": 0.0
    },
    {
        "EmployerCode": "01",
        "EmployeeNumber": "0012",
        "CH": 2,
        "PayrollAttendanceType": "Normal",
        "BaseDate": "2023-05-02T00:00:00",
        "IN1": "2023-05-02T09:00:00",
        "OUT1": "2023-05-02T12:00:00",
        "IN2": "2023-05-02T13:00:00",
        "OUT2": "2023-05-02T18:00:00",
        "IN3": "2023-05-02T20:00:00",
        "OUT3": "2023-05-03T03:00:00",
        "RegularHours": 8.0,
        "WorkedHoursNight": 0.0,
        "WorkedHoursNightCalc": 0.0,
        "LateHoursCalc": 0.0,
        "OvertimeHours1": 0.0,
        "OvertimeHours1Percent": 50,
        "OvertimeHours2": 0.0,
        "OvertimeHoursNight1": 0.0,
        "OvertimeHoursNight1Percent": 50,
        "OvertimeHoursNight2": 0.0,
        "CompTime": 0.0,
        "OnCall": 0.0,
        "OnCallWorked": 7.0,
        "Allowance": 0.0
    }
]