Passar para o conteúdo principal

API - Folha de Ponto

Neste artigo verá o uso do endpoint da API da TWO relacionados a Folha de Ponto.

Jorge Luis avatar
Escrito por Jorge Luis
Atualizado essa semana

1. Listar Folha de Ponto

Endpoint:

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

Headers:

AUTH-TOKEN: sua_chave_privada

Parâmetros:

Campo

Tipo

Requerido

Exemplo

Observações

FromDate

date

Sim

"2023-05-01"

Data de início. O período entre FromDate e ToDate não pode exceder 60 dias.

ToDate

date

Sim

"2023-05-02"

Data de término.

OnlyApproved

boolean

Não

false

Padrão: true. Se false, traz todas as folhas; se true, somente as fechadas.


Exemplo de Requisição

GET https://api1.tradingworks.net/v1/timecard/list?fromdate=2023-05-01&todate=2023-05-02&onlyapproved=false


Headers

Headers: AUTH-TOKEN: sua_chave_privada


Exemplo de resposta:

[
{
"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
}
]

Dicas e Observações Importantes

  • Respeite o limite de 60 dias entre FromDate e ToDate, caso contrário a requisição falhará.

  • O parâmetro OnlyApproved, quando omitido, retorna apenas folhas fechadas (aprovadas). Defina como false se quiser incluir também as folhas em aberto.

Respondeu à sua pergunta?