# API pública TiqueTaque

<h2>Autenticação</h2>
  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.
<h2>Rate limiting</h2>
  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 <code>429 Too Many Requests</code>.<br>


Version: 2.1

## Servers

```
https://api.tiquetaque.com/v2.1
```

## Security

### BasicAuth

Type: http
Scheme: basic

## Download OpenAPI description

[API pública TiqueTaque](https://api-docs.tiquetaque.app/_bundle/openapi.yaml)

## Afastamentos

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

### Cria um afastamento para um funcionário

 - [POST /work-leaves](https://api-docs.tiquetaque.app/openapi/afastamentos/paths/~1work-leaves/post.md)

### Retorna uma lista com os afastamentos de um funcionário

 - [GET /work-leaves](https://api-docs.tiquetaque.app/openapi/afastamentos/paths/~1work-leaves/get.md): Os afastamentos retornados, conforme os filtros aplicados são associados a um funcionário identificado por employee_id. Eles representam variados motivos que fazem com que o funcionário deixe de trabalhar o tempo previsto. Retorna todos os registros de afastamentos que contenham as  datas entre start_date e end_date. Resultado paginado

### Aprova um afastamento

 - [PATCH /work-leaves/{id}/approve](https://api-docs.tiquetaque.app/openapi/afastamentos/paths/~1work-leaves~1%7Bid%7D~1approve/patch.md)

### Reprova um afastamento

 - [PATCH /work-leaves/{id}/reject](https://api-docs.tiquetaque.app/openapi/afastamentos/paths/~1work-leaves~1%7Bid%7D~1reject/patch.md)

### Retorna os dados de um afastamento

 - [GET /work-leaves/{id}](https://api-docs.tiquetaque.app/openapi/afastamentos/paths/~1work-leaves~1%7Bid%7D/get.md): Retorna todos campos de

### Exclui um afastamento

 - [DELETE /work-leaves/{id}](https://api-docs.tiquetaque.app/openapi/afastamentos/paths/~1work-leaves~1%7Bid%7D/delete.md)

## Escalas

Informações dos cadastros de escalas de trabalho.

### Lista com sumário de escalas de trabalho

 - [GET /work-schedules/summary](https://api-docs.tiquetaque.app/openapi/escalas/paths/~1work-schedules~1summary/get.md): Retorna a listagem paginada de nomes de escalas de trabalho ativas e visíveis, com o correspondente ID.

## Funcionários

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

### Cadastra um novo funcionário

 - [POST /employees](https://api-docs.tiquetaque.app/openapi/funcionarios/paths/~1employees/post.md): Para detalhes dos formatos de dados do corpo da requisição, veja a descrição do schema.

### Lista o cadastro dos funcionários ativos

 - [GET /employees](https://api-docs.tiquetaque.app/openapi/funcionarios/paths/~1employees/get.md): Resultado paginado. A ausência de um campo na resposta indica que seu valor ainda não foi definido.

### Atualiza um funcionário

 - [PATCH /employees/{id}](https://api-docs.tiquetaque.app/openapi/funcionarios/paths/~1employees~1%7Bid%7D/patch.md)

### Retorna os detalhes de um funcionário

 - [GET /employees/{id}](https://api-docs.tiquetaque.app/openapi/funcionarios/paths/~1employees~1%7Bid%7D/get.md): São retornados os funcionário ativos apenas.

### Exclui um funcionário

 - [DELETE /employees/{id}](https://api-docs.tiquetaque.app/openapi/funcionarios/paths/~1employees~1%7Bid%7D/delete.md)

## Registros de ponto

Informações referentes aos registros de ponto.

### Adiciona um registro de ponto

 - [POST /times](https://api-docs.tiquetaque.app/openapi/registros-de-ponto/paths/~1times/post.md): Adiciona um registro por vez para o funcionário na data e hora passada. Este registro é armazenado como um registro com type='registro externo'.

 IMPORTANTE: Os registros de um funcionário mesmo que inseridos com
sucesso por este endpoint, serão exibidos na interface do admin TiqueTaque apenas se o cadastro do  funcionário possuir uma escala e um empregador configurados. Depois de configurados os campos os registros  previamente adicionados serão exibidos também. 
 Os campos employee_id e employee_external_id são mutuamente exclusivos no corpo da requisição.

### Registros de ponto

 - [GET /times](https://api-docs.tiquetaque.app/openapi/registros-de-ponto/paths/~1times/get.md): Retorna os detalhes dos registros para o funcionário solicitado, dentro do intervalo, o formato da resposta é o seguinte:
 
{
    "employee_id": "5f5bc225b511a6e44c2891f6",
    "times": [
        { 
            "approved": true, 
            "justification": "Esqueci de registrar", 
            "time": "2024-09-02T07:32", 
            "type": "ajuste manual" 
        },
        { 
            "approved": true, 
            "justification": "Registro via app com geolocalização", 
            "time": "2024-09-02T11:59", 
            "type": "app" 
        } 
    ] 
}


 | Chave         | Descrição                                                                           | 
|---------------|-------------------------------------------------------------------------------------| 
| employee      | ID do funcionário.                                                                  | 
| times         | Lista de registros de ponto encontrados para o funcionário.                         | 
 Os valores para cada um dos itens da lista de times são: 
* approved: [true, false]. Indica se o registro já está aprovado pelo gestor. 
* type: [pré-assinalado, aparelho, web, desconsiderado,app, reconhecimento facial, ajuste manual, offline, registro externo] 
* time: Data e hora no format YYYY-MM-DDTHH:MM 
* justification: justificativa do registro, caso exista.

## Empregadores

Operações relacionadas aos empregadores.

### Lista os empregadores

 - [GET /payment-sources](https://api-docs.tiquetaque.app/openapi/empregadores/paths/~1payment-sources/get.md): Lista todos empregadores ativos da conta.

### Dados de um empregador

 - [GET /payment-sources/{id}](https://api-docs.tiquetaque.app/openapi/empregadores/paths/~1payment-sources~1%7Bid%7D/get.md): Retorna um empregador pelo ID.

### Atualiza um empregador

 - [PATCH /payment-sources/{id}](https://api-docs.tiquetaque.app/openapi/empregadores/paths/~1payment-sources~1%7Bid%7D/patch.md): Atualiza um empregador.

### Exclui um empregador

 - [DELETE /payment-sources/{id}](https://api-docs.tiquetaque.app/openapi/empregadores/paths/~1payment-sources~1%7Bid%7D/delete.md)

## Espelhos de ponto

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


### Totais do espelho

 - [GET /timesheets](https://api-docs.tiquetaque.app/openapi/espelhos-de-ponto/paths/~1timesheets/get.md): 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)

## Unidades

Cadastros de unidades.

### Cria uma nova unidade

 - [POST /sites](https://api-docs.tiquetaque.app/openapi/unidades/paths/~1sites/post.md): Cria uma nova unidade. Unidades agrupam funcionários e podem ser utilizadas para vincular funcionários aos aparelhos TiqueTaque

### Retorna uma lista com as unidades ativas da conta.

 - [GET /sites](https://api-docs.tiquetaque.app/openapi/unidades/paths/~1sites/get.md): Lista as unidades ativas

### Detalhes de  uma unidade

 - [GET /sites/{id}](https://api-docs.tiquetaque.app/openapi/unidades/paths/~1sites~1%7Bid%7D/get.md): Retorna uma unidade específica.

### Atualiza uma unidade

 - [PATCH /sites/{id}](https://api-docs.tiquetaque.app/openapi/unidades/paths/~1sites~1%7Bid%7D/patch.md): Atualiza uma unidade específica.

### Exclui uma unidade

 - [DELETE /sites/{id}](https://api-docs.tiquetaque.app/openapi/unidades/paths/~1sites~1%7Bid%7D/delete.md)

## Usuários

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

### Cria um novo usuário.

 - [POST /users](https://api-docs.tiquetaque.app/openapi/usuarios/paths/~1users/post.md): Cria um novo usuário.

### Lista usuários da conta

 - [GET /users](https://api-docs.tiquetaque.app/openapi/usuarios/paths/~1users/get.md): Retorna uma lista com os usuários da conta.

### Detalhes de um usuário

 - [GET /users/{id}](https://api-docs.tiquetaque.app/openapi/usuarios/paths/~1users~1%7Bid%7D/get.md): Retorna um usuário específico.

### Atualiza um usuário

 - [PATCH /users/{id}](https://api-docs.tiquetaque.app/openapi/usuarios/paths/~1users~1%7Bid%7D/patch.md): Atualiza um usuário específico.

### Exclui um usuário

 - [DELETE /users/{id}](https://api-docs.tiquetaque.app/openapi/usuarios/paths/~1users~1%7Bid%7D/delete.md)