Espelhos de ponto

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

Operations

Espelhos de ponto

Request

Retorna espelhos de ponto com totais e detalhamento dia a dia.

Modos de operação:

Com employee_id ou employee_external_id: retorna um único objeto de espelho para o funcionário informado.
Sem filtro de funcionário: retorna uma lista paginada de espelhos para todos os funcionários ativos que possuem espelho no período solicitado. Funcionários com cadastro incompleto são ignorados.
Informar employee_id e employee_external_id simultaneamente retorna erro.

Banco de horas e período parcial: os dados de banco de horas — banco_horas em totals e days, e o objeto hours_bank_summary — só são calculados quando o período solicitado corresponde exatamente a uma folha de ponto completa do funcionário (do início ao fim do período de pagamento). Para um período parcial (qualquer intervalo diferente da folha, inclusive um recorte que começa no início dela ou que abrange mais de uma folha), o espelho é retornado normalmente com as demais rubricas, porém sem nenhum dado de banco de horas. No modo lista, funcionários cujo período de pagamento não coincide exatamente com o intervalo solicitado também são incluídos, sem os dados de banco de horas.

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. Opcional. Se informado, retorna apenas o espelho deste funcionário. Não pode ser usado em conjunto com employee_external_id.

employee_external_idstring

ID externo do funcionário. Opcional. Se informado, retorna apenas o espelho deste funcionário. Não pode ser usado em conjunto com employee_id.

start_datestring, (date)(DateParamModel)required

Data inicial da folha de ponto.

Example:start_date=2023-09-27

end_datestring, (date)(DateParamModel)required

Data final da folha de ponto.

Example:end_date=2023-09-27

max_resultsinteger(MaxResultsParamModel)

Tamanho da página de resultados. Utilizado apenas quando nenhum filtro de funcionário é informado. O total reflete o número de funcionários com espelho no período, não o total de funcionários cadastrados.

Default:25

pageinteger(PageParamModel)

Número da página de resultados. Utilizado apenas quando nenhum filtro de funcionário é informado.

Default:1

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api-docs.tiquetaque.app/_mock/openapi/timesheets?employee_id=string&employee_external_id=string&start_date=2023-09-27&end_date=2023-09-27&max_results=25&page=1'

Responses

Resposta de sucesso. Quando employee_id ou employee_external_id é informado, retorna um único objeto de espelho. Quando nenhum filtro de funcionário é informado, retorna uma lista paginada de espelhos. Valores em horas centesimais.

Bodyapplication/json

One of:

Espelho de um único funcionário (quando employee_id ou employee_external_id é informado).

employee_idstring

ID do funcionário.

Example:"5f5bc225b511a6e44c2891f6"

employee_external_idstring

ID externo do funcionário. Presente apenas se o funcionário possuir ID externo cadastrado.

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. Presente apenas se o período solicitado corresponder a uma folha de ponto completa, do início ao fim. Não é retornado para períodos parciais.

Response

{
  "employee_id": "5f5bc225b511a6e44c2891f6",
  "employee_external_id": "string",
  "period": {
    "start_date": "2019-08-24",
    "end_date": "2019-08-24"
  },
  "totals": {
    "horas_normais": "6.00",
    "banco_horas": "123.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": "2.13",
    "adicional_noturno_extra_75": "1.12",
    "adicional_noturno_extra_100": "1.00",
    "adicional_noturno_extra_200": "2.89",
    "hora_noturna_reduzida": "2.30",
    "afastamento_nao_remunerado": "2.50",
    "sobreaviso": "5.55",
    "suspensao": "6.77",
    "ferias": "3.69"
  },
  "days": {
    "horarios": [ … ],
    "horas_normais": "6.00",
    "banco_horas": "123.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": "2.13",
    "adicional_noturno_extra_75": "1.12",
    "adicional_noturno_extra_100": "1.00",
    "adicional_noturno_extra_200": "2.89",
    "hora_noturna_reduzida": "2.30",
    "afastamento_nao_remunerado": "2.50",
    "sobreaviso": "5.55",
    "suspensao": "6.77",
    "ferias": "3.69"
  },
  "hours_bank_summary": {
    "previous_balance": "-9.17",
    "generated_balance": "1.00",
    "created_balance": "3.00",
    "final_balance": "-5.17",
    "period": { … }
  }
}