Skip to content

API pública TiqueTaque (2.1)

Autenticação

Para todas as requisições é necessária a autenticação com um token gerado a partir da plataforma do gestor, utilizando o token com autenticação **BasicAuth** sendo user=*public*, senha=*seu_token*. Verifique a seção de integrações do TiqueAdmin para gerar o token.

Rate limiting

Requisições são limitadas a 60 requisições por janela deslizante de 1 minuto. Se o limite for excedido, será retornada uma resposta HTTP 429 Too Many Requests.
Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://api-docs.tiquetaque.app/_mock/openapi
https://api.tiquetaque.com/v2.1

Afastamentos

Operações referentes aos afastamentos de um funcionário.

Operations

Escalas

Informações dos cadastros de escalas de trabalho.

Operations

Funcionários

Operações sobre os cadastros de funcionários.

Operations

Registros de ponto

Informações referentes aos registros de ponto.

Operations

Empregadores

Operações relacionadas aos empregadores.

Operations

Espelhos de ponto

Dados relativos à um período de espelho de ponto, como totais trabalhados, horas extras, banco de horas e afastamentos.

Operations

Totais do espelho

Request

Retorna os totais do espelho de para o funcionário e período solicitados, além do detalhamento dia a dia. Exemplo de formato de resposta:

{ 
   "employee_id": "5e3aaac1092731b3e921b957", 
   "period": { 
       "start_date": "2024-11-01", 
       "end_date": "2024-11-30" 
    }, 
   "totals": { 
         "falta_injustificada": "36.00", 
         "atraso": "6.32", 
         "dsr": "9.00", 
         "desconto_dsr": "34.50", 
         "atestado": "15.17", 
         "adicional_noturno": "8.42", 
         "hora_noturna_reduzida": "1.27", 
         "extra_50": "0.48", 
         "adicional_noturno_extra_50": "0.48" 
    }, 
   "hours_bank_summary": { 
         "previous_balance": "-2790.17", 
         "generated_balance": "0.00", 
         "created_balance": "0.00", 
         "final_balance": "-2790.17", 
         "period": { 
             "type": "cyclic", 
             "start_date": "2021-03-10" 
             "end_date": "2021-06-09" 
         } 
    } 
   "days": { 
           "2024-11-01": {"banco_horas": "1.20", "horarios": ["08:00", "18:00"], "total": "10.00"}, 
           "2024-11-02": { 
               "extra_50": "2.00", 
              "extra_75": "8.00", 
              "horarios": ["08:00", "18:00"], 
              "total": "10.00", 
          }, 
          "2024-11-03": {"extra_100": "10.00", "horarios": ["08:00", "18:00"], "total": "10.00"}, 
          "2024-11-04": {"banco_horas": "1.20", "horarios": ["08:00", "18:00"], "total": "10.00"}, 
          "2024-11-05": {"banco_horas": "1.20", "horarios": ["08:00", "18:00"], "total": "10.00"}, 
          "2024-11-06": {"banco_horas": "1.20", "horarios": ["08:00", "18:00"], "total": "10.00"}, 
          "2024-11-07": {"banco_horas": "1.20", "horarios": ["08:00", "18:00"], "total": "10.00"}, 
          "2024-11-08": {"banco_horas": "1.20", "horarios": ["08:00", "18:00"], "total": "10.00"}, 
          "2024-11-09": { 
              "extra_50": "2.00", 
              "extra_75": "8.00", 
              "horarios": ["08:00", "18:00"], 
              "total": "10.00", 
          }, 
}

As chaves possíveis em totals e days representam o total em horas centesimais de cada rubrica no período, e podem ser as seguintes:

  • total
  • horas_normais
  • banco_horas
  • falta_injustificada
  • falta_justificada
  • abono
  • folga
  • atraso
  • dsr
  • desconto_dsr
  • inss
  • atestado
  • dispensa_legal
  • adicional_noturno
  • adicional_noturno_extra_N (onde N é a faixa de horas extras em adicional noturno. e.g. adicional_noturno_extra_50)
  • hora_noturna_reduzida
  • afastamento_nao_remunerado
  • sobreaviso
  • suspensao
  • ferias
  • extra_N (onde N é a faixa de horas extras. e.g. extra_50)
Security
BasicAuth
Query
employee_idstring

ID do funcionário. Obrigatório caso employee_external_id não esteja presente.

employee_external_idstring

ID externo do funcionário. Obrigatório caso employee_id não esteja presente.

start_datestring(date)(DateParamModel)required

Data inicial da folha de ponto.

Example: start_date=YYYY-MM-DD
end_datestring(date)(DateParamModel)required

Data final da folha de ponto.

Example: end_date=YYYY-MM-DD
curl -i -X GET \
  -u <username>:<password> \
  'https://api-docs.tiquetaque.app/_mock/openapi/timesheets?employee_id=string&employee_external_id=string&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD'

Responses

Resposta de sucesso, com detalhes dos totais do período, parciais dos dias de horários de batida de ponto. Valores em horas centesimais. Para detalhes do formato veja a descrição do schema.

Bodyapplication/json
employee_idstring

ID do funcionário. Obrigatório caso employee_external_id não esteja presente.

Example: "5f5bc225b511a6e44c2891f6"
employee_external_idstring

ID externo do funcionário. Obrigatório caso employee_id não esteja presente.

periodobject

Período do espelho de ponto solicitado.

totalsobject

totais de cada rubrica dentro do período do espelho de ponto.

daysobject

Detalhes de cada um dos dias da folha de ponto, contendo os horários de batidas e rubricas parciais dos dias.

hours_bank_summaryobject

Resumo de banco de horas do período. Esta chave é retornada apenas se o período solicitado for de uma folha de ponto completa, do início ao fim.

Response
application/json
{
  "employee": "employee_id,",
  "period": {
    "start_date": "2024-11-01",
    "end_date": "2024-11-30"
  },
  "days": {
    "2024-11-03": { … },
    "2024-11-04": { … }
  },
  "totals": {
    "horas_normais": "128.40",
    "banco_horas": "-23.00",
    "falta_injustificada": "36.00",
    "falta_justificada": "12.00",
    "abono": "4.00",
    "folga": "1.00",
    "atraso": "22.13",
    "dsr": "8.00",
    "desconto_dsr": "16.00",
    "inss": "40.00",
    "atestado": "1.00",
    "dispensa_legal": "2.00",
    "adicional_noturno": "1.20",
    "extra_50": "1.00",
    "extra_75": "2.00",
    "extra_100": "3.00",
    "extra_200": "4.00",
    "adicional_noturno_extra_50": "1.40",
    "adicional_noturno_extra_75": "1.10",
    "adicional_noturno_extra_100": "1.10",
    "adicional_noturno_extra_200": "1.10",
    "hora_noturna_reduzida": "1.10",
    "afastamento_nao_remunerado": "1.10",
    "sobreaviso": "1.10",
    "suspensao": "1.10",
    "ferias": "1.10"
  },
  "hours_bank_summary": {
    "previous_balance": "-9.17",
    "generated_balance": "1.00",
    "created_balance": "3.00",
    "final_balance": "-5.17",
    "period": { … }
  }
}

Unidades

Cadastros de unidades.

Operations

Usuários

Operações sobre os cadastros de usuários.

Operations