Recursos

Glossário

Termos, blocos de dados reutilizados e enums que aparecem em vários endpoints da API V2.

Bloco do colaborador

Vários endpoints (totalHours, point/getFromPeriod, tardiness, adjustment, overtime, inconsistency, absence/getFromPeriod) incluem o mesmo bloco com os 10 campos abaixo:

{
  "national_registry": "12345678900",
  "registration_number": "0042",
  "email": "[email protected]",
  "name": "João da Silva",
  "occupation": "Analista de RH",
  "department": "Recursos Humanos",
  "team": null,
  "business_unit": "Matriz",
  "admission_date": "2022-03-15",
  "pis": "12345678901",
  "company": {
    "name": "Filial São Paulo LTDA",
    "trading_name": "Filial SP",
    "national_registry": "12345678000288"
  }
}

Regimes de jornada

Regime	Significado
BH	Banco de horas. Saldo positivo/negativo é compensado.
HE	Hora extra paga. Excedentes viram crédito financeiro.
Híbrido (BH)	Combina BH e HE; o destino padrão é o banco.
Híbrido (HE)	Combina BH e HE; o destino padrão é a hora extra.

Tipos de horas (totalHours)

worked_time · horas trabalhadas computadas pela regra.
worked_actual_time · horas efetivamente registradas em batidas.
bank_time / bank_time_factored · saldo do banco bruto e com fator.
fault_full_time / fault_partial_time · faltas integrais e parciais.
justified_time / justified_not_paid_time · justificadas (com/sem remuneração).
medical_certificate_time · atestados.
night_time / night_time_reduced · horas noturnas e com redução.
over_time_1/2/3 (e variantes _day/_night/_night_reduced) · horas extras em faixas diferentes.

Status de ponto (origin)

O campo origin nas batidas de ponto identifica como a batida entrou no sistema:

App Mobile · batida via aplicativo no celular do colaborador.
Web · batida via interface web (Web Point).
REP · dispositivo físico (catraca/relógio).
Manual · lançada manualmente pelo gestor.
API · enviada via POST /customer/v2/point.

Tipos de afastamento

Em GET /absence/types cada tipo traz flags importantes:

paid_leave · afastamento remunerado.
comp_time · gera direito a compensação (folga).
compensation · é um abono compensatório.
can_request_app · pode ser solicitado pelo app pelo colaborador.