1. Listar eventos do Banco de Horas
Endpoint:
GET https://api1.tradingworks.net/v1/comptime/listevents
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 365 dias. |
ToDate | date | Sim | "2023-05-02" | Data de término. |
Exemplo de Requisição
GET https://api1.tradingworks.net/v1/comptime/listevents?FromDate=2022-01-01&ToDate=2022-01-31
Headers
Headers: AUTH-TOKEN: sua_chave_privada
Campos
Campo | Tipo | Exemplo | Observações |
FullName | string | "João Silva" | Nome completo do colaborador. |
BaseDate | Date | "2020-09-30" | Data de inicio do banco. |
PersonalDocument | string | "182.235.135-73" | Documento de Identificação do Colaborador (Ex: CPF). |
ComptTIme | decimal | -1.0 | Saldo do Banco de Horas |
CompTimeType | string | "Transf. folha" | Tipo de Evento |
Exemplo de resposta:
[
{
"EmployeeNumber": "8",
"FullName": "Marcos Silva",
"BaseDate": "2022-01-01T00:00:00",
"CompTime": 0.0,
"CompTimeTypeID": 1,
"CompTimeType": "Início do banco",
"CompTimeNotes": "Início do banco de horas"
},
{
"EmployeeNumber": "11072004",
"FullName": "Sergio Mota",
"PersonalDocument": "143.284.330-21",
"BaseDate": "2022-01-31T00:00:00",
"CompTime": 0.0,
"CompTimeTypeID": 4,
"CompTimeType": "Fechamento do banco",
"CompTimeNotes": "Fechamento de banco descontado em folha"
},
{
"EmployeeNumber": "8",
"FullName": "Marcos Silva",
"BaseDate": "2022-01-31T00:00:00",
"CompTime": -3.0,
"CompTimeTypeID": 4,
"CompTimeType": "Fechamento do banco",
"CompTimeNotes": "Fechamento de banco pago em folha"
},
{
"EmployeeNumber": "8",
"FullName": "Marcos Silva",
"BaseDate": "2022-01-31T00:00:00",
"CompTime": 6.0,
"CompTimeTypeID": 2,
"CompTimeType": "Transf. folha"
}
]
Dicas e Observações Importantes
Respeite o limite de 365 dias entre FromDate e ToDate, caso contrário a requisição falhará.