API - Folha de atividades

Objetivo

Descrever métodos de acesso à API de exportação da folha de atividades.

Exportar folha de atividades

Exporta um arquivo da folha de atividades do colaborador.

Endpoint

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

Parâmetros

FromDate - Período específico de início dos dados
ToDate - Período de término dos dados. Limite de 60 dias entre FromDate e ToDate
EmployeeNumber - Matrícula do colaborador
EmployerImportRef - Código de importação do empregador. Opcional caso a matrícula seja única para o ambiente todo. Se não informado e existirem matrículas duplicadas, o primeiro colaborador com a matrícula encontrada será utilizado.

Headers

AUTH-TOKEN = Sua Chave privada

Retorno

O endpoint retorna um arquivo que pode ser salvo em PDF, com os registros de ponto e atividades do colaborador.

A folha de atividades exportada pela API é igual à que pode ser baixada em Relatórios > Central de Relatórios > Folha de atividades.