# Totais do espelho

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)

Endpoint: GET /timesheets
Version: 2.1
Security: BasicAuth

## Query parameters:

  - `employee_id` (string)
    ID do funcionário. Obrigatório caso employee_external_id não esteja presente.

  - `employee_external_id` (string)
    ID externo do funcionário. Obrigatório caso employee_id não esteja presente.

  - `start_date` (string, required)
    Data inicial da folha de ponto.
    Example: "YYYY-MM-DD"

  - `end_date` (string, required)
    Data final da folha de ponto.
    Example: "YYYY-MM-DD"

## Response 200 fields (application/json):

  - `employee_id` (string)
    ID do funcionário. Obrigatório caso employee_external_id não esteja presente.
    Example: "5f5bc225b511a6e44c2891f6"

  - `employee_external_id` (string)
    ID externo do funcionário. Obrigatório caso employee_id não esteja presente.

  - `period` (object)
    Período do espelho de ponto solicitado.

  - `period.start_date` (string)
    Data inicial do espelho

  - `period.end_date` (string)
    Data final do espelho

  - `totals` (object)
    totais de cada rubrica dentro do período do espelho de ponto.

  - `totals.horas_normais` (string)
    Example: "6.00"

  - `totals.banco_horas` (string)
    Example: "123.00"

  - `totals.falta_injustificada` (string)
    Example: "36.00"

  - `totals.falta_justificada` (string)
    Example: "12.00"

  - `totals.abono` (string)
    Example: "4.00"

  - `totals.folga` (string)
    Example: "1.00"

  - `totals.atraso` (string)
    Example: "22.13"

  - `totals.dsr` (string)
    Example: "8.00"

  - `totals.desconto_dsr` (string)
    Example: "16.00"

  - `totals.inss` (string)
    Example: "40.00"

  - `totals.atestado` (string)
    Example: "1.00"

  - `totals.dispensa_legal` (string)
    Example: "2.00"

  - `totals.adicional_noturno` (string)
    Example: "1.20"

  - `totals.extra_50` (string)
    Example: "1.00"

  - `totals.extra_75` (string)
    Example: "2.00"

  - `totals.extra_100` (string)
    Example: "3.00"

  - `totals.extra_200` (string)
    Example: "4.00"

  - `totals.adicional_noturno_extra_50` (string)
    Example: "2.13"

  - `totals.adicional_noturno_extra_75` (string)
    Example: "1.12"

  - `totals.adicional_noturno_extra_100` (string)
    Example: "1.00"

  - `totals.adicional_noturno_extra_200` (string)
    Example: "2.89"

  - `totals.hora_noturna_reduzida` (string)
    Example: "2.30"

  - `totals.afastamento_nao_remunerado` (string)
    Example: "2.50"

  - `totals.sobreaviso` (string)
    Example: "5.55"

  - `totals.suspensao` (string)
    Example: "6.77"

  - `totals.ferias` (string)
    Example: "3.69"

  - `days` (object)
    Detalhes de cada um dos dias da folha de ponto,  contendo os horários de batidas e rubricas parciais dos dias.

  - `days.horarios` (string)
    Horários de registro de ponto válidos no formato "HH:MM".
    Example: "08:12"

  - `hours_bank_summary` (object)
    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.

  - `hours_bank_summary.previous_balance` (string)
    Saldo anterior de banco de horas gerado até o início deste período.
    Example: "-9.17"

  - `hours_bank_summary.generated_balance` (string)
    Saldo de banco de horas gerado dentro deste período pelos registros.
    Example: "1.00"

  - `hours_bank_summary.created_balance` (string)
    Saldo de banco de horas adicionado manualmente dentro deste período.
    Example: "3.00"

  - `hours_bank_summary.final_balance` (string)
    Saldo final de banco de horas.
    Example: "-5.17"

  - `hours_bank_summary.period` (object)

  - `hours_bank_summary.period.type` (string)
    Tipo de banco de horas configurado, podendo ser aberto onde existe apenas start_date, cíclico, que se renova automaticamente após a quantidade de meses configurada, ou fixo, contendo start_date e end_date fixos.
    Enum: "fixed", "open", "cyclic"

  - `hours_bank_summary.period.start_date` (string)
    Data de ínicio do período de banco de horas ativo.
    Example: "2021-03-10"

  - `hours_bank_summary.period.end_date` (string)
    Data de fim do período de banco de horas ativo.
    Example: "2021-03-10"

## Response 401 fields (application/json):

  - `_code` (integer)
    Código de erro interno.

  - `_status` (string)
    Example: "ERR"

  - `_error` (object)

  - `_error.code` (integer)
    Codigo de erro HTTP.

  - `_error.message` (string)
    Mensagem de erro interna.

  - `_error._ui_message` (string)
    Mensagem de erro para o usuário.

## Response 409 fields (application/json):

  - `_code` (integer)
    Código de erro interno.

  - `_status` (string)
    Example: "ERR"

  - `_error` (object)

  - `_error.code` (integer)
    Codigo de erro HTTP.

  - `_error.message` (string)
    Mensagem de erro interna.

  - `_error._ui_message` (string)
    Mensagem de erro para o usuário.

## Response 422 fields (application/json):

  - `_code` (integer)
    Código de erro interno.

  - `_status` (string)
    Example: "ERR"

  - `_error` (object)

  - `_error.code` (integer)
    Codigo de erro HTTP.

  - `_error.message` (string)
    Mensagem de erro interna.

  - `_error._ui_message` (string)
    Mensagem de erro para o usuário.