API - Apontamentos

Objetivo

Descrever métodos de acesso à API de Apontamentos ( Attendances).

Listar

Lista os 1.000 primeiros apontamentos que ainda não foram marcados como sincronizados.
Apenas apontamentos originais, aprovados ou inseridos pelo gestor/RH.

Endpoint

https://api1.tradingworks.net/v1/attendances

Método

GET

Parâmetros

Language - (opcional) Opções atuais 'en-US' (padrão) ou 'pt-BR'. Altera o nome das propriedades para a língua específica
Fromdate - (opcional) Data de início da pesquisa, retornará todos os registros do período. Limite máximo entre fromdate e todate de 120 dias.
Todate - (opcional) Data de término da pesquisa, retornará todos os registros do período.
Listall - (opcional) Lista os últimos 60 dias de marcações em qualquer situação de sincronização, dado o limite de 1.000 registros.

Exemplo ( português):

https://api1.tradingworks.net/v1/attendances?Language=pt-br&fromdate=2020-09-01&todate=2020-09-31
{
    "AttendanceRegisterID": 240341,
    "Matricula": "42345",
    "PIS": "8374823",
    "CPF": "1112223334444",
    "DataBase": "2018-09-03T00:00:00",
    "Data_Hora_Evento": "2018-09-03T13:45:00",
    "Sincronizado": false,
    "SituacaoID": 3,
    "Situacao": "Aprovado"
}

Exemplo ( inglês):

https://api1.tradingworks.net/v1/attendances?fromdate=2020-09-01&todate=2020-09-31
{
    "AttendanceRegisterID": 240341,
    "EmployeeNumber": "42345",
    "SocialSecurity": "8374823",
    "PersonalDocument": "1112223334444",
    "BaseDate": "2018-09-03T00:00:00",
    "EventDateTime": "2018-09-03T13:45:00",
    "Synced": false,
    "StatusID": 3,
    "Status": "Aprovado"
}

Headers

AUTH-TOKEN = Sua Chave privada

StatusID / SituacaoID

0	Inserido - Evento inserido pelo gestor ou por pré-assinalação de alimentação
1	Automático - Marcação original feita pelo colaborador
2	Aguardando - Requisição manual aguardando aprovação
3	Aprovado - Requisição manual aprovada
4	Reprovado - Requisição manual reprovada
5       Uso interno apenas
6	Descartado - Marcação que foi descartada, i.e., não é usada nos cálculos da folha

Marcar como sincronizado

Indica que o apontamento foi efetivado nos sistemas internos da empresa e não deve mais aparecer na listagem.
Limite de 1.000 apontamentos por requisição.

Endpoint
https://api1.tradingworks.net/v1/attendances/setsync


Método
POST


Headers
AUTH-TOKEN = Sua Chave privada
Content-Type = application/json

Dados

Campo Tipo Requerido Exemplo Observações
AttendanceRegisterID

integer

Sim "240341" Número do registro que se deseja marcar como sincronizado.

Exemplo

[
  {
   "AttendanceRegisterID": 240341
  },
  {
   "AttendanceRegisterID": 240348
  },
  {
   "AttendanceRegisterID": 240362
  }
]
Isto respondeu sua dúvida? Obrigado pelo retorno Houve um problema ao enviar seu feedback. Por favor tente novamente.

Ainda precisa de ajuda? Entre em contato Entre em contato