Exportar Folha de Atividades
Endpoint:
GET https://api1.tradingworks.net/v1/timecard/download
Headers:
AUTH-TOKEN: sua_chave_privada
Parâmetros (obrigatórios):
Campo | Tipo | Exemplo | Observações |
FromDate | date | "2023-10-01" | Data de início do período. O intervalo entre FromDate e ToDate não pode exceder 60 dias. |
ToDate | date | "2023-10-31" | Data final do período (limite de 60 dias junto com FromDate). |
EmployeeNumber | string | "123456" | Matrícula do colaborador. |
EmployerImportRef | string | "90" | Opcional: use se existir duplicidade de matrícula. Sem esta informação, o primeiro registro será usado. |
Resposta da API
A chamada retorna diretamente um arquivo PDF com a folha de atividades do colaborador para o período especificado — o mesmo que seria gerado via interface web.
Dicas e Observações Importantes
O PDF gerado pela API é idêntico ao disponível via interface em Relatórios > Central de Relatórios > Folha de Atividades.
Use o parâmetro EmployerImportRef quando a matrícula do colaborador não for única. Isso garante que o documento gerado corresponda exatamente ao colaborador desejado.
Respeite o limite de 60 dias entre FromDate e ToDate, caso contrário a requisição falhará.