RH e Timesheet
Dados de RH e de apontamento de horas.
Perfis de colaboradores
Recurso do plano: RH Básico / Gestão de Equipe.
| Método | Rota | O que faz |
|---|---|---|
GET | /external/v1/employee-profiles | Lista com paginação |
GET | /external/v1/employee-profiles/:id | Busca um registro pelo ID |
POST | /external/v1/employee-profiles | Cria um registro |
PUT | /external/v1/employee-profiles/:id | Atualiza um registro |
Listar
Aceita page, limit e relations, como descrito em Paginação e filtros.
curl -G "https://erp-api.ideros.api.br/external/v1/employee-profiles" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25"
Buscar por ID
curl "https://erp-api.ideros.api.br/external/v1/employee-profiles/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"
Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).
Criar
Responde 201 com o registro criado.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
personId | string | Sim | ID de pessoa. Representa o colaborador. |
companyUserId | string | Não | ID de usuário da empresa. Apenas se o colaborador acessa o sistema. |
businessUnitId | string | Não | ID de unidade de negócio. Unidade de negócio do colaborador. |
admissionDate | string (data ISO 8601) | Sim | Data de admissão do colaborador. |
employmentType | enum | Sim | Tipo de vínculo empregatício. Valores: CLT, PJ, INTERN, FREELANCER, PARTNER. |
contractType | enum | Não | Tipo de contrato de trabalho (eSocial): prazo indeterminado, determinado, ou determinado vinculado a um fato. Valores: INDETERMINATE, DETERMINATE, DETERMINATE_EVENT. |
contractEndDate | string (data ISO 8601) | Não | Contrato por prazo determinado: data de término PREVISTA do contrato (eSocial dtTerm). Diferente da data de desligamento real. ISO. |
contractObject | string | Não | Contrato por prazo determinado vinculado a um FATO/OBRA: objeto/descrição do fato determinante que encerra o contrato (eSocial objDet). |
hasAssecuratoryClause | boolean | Não | Contrato por prazo determinado: possui cláusula assecuratória do direito recíproco de rescisão antecipada (eSocial clauseAssec). |
esocialCategory | string | Não | Categoria do trabalhador no eSocial (ex.: "104"). |
esocialCargoCode | string | Não | Código do cargo no eSocial/CBO (ex.: "eSocial-001"). |
paymentUnit | enum | Não | Unidade de pagamento (eSocial): Mensal, Quinzenal, Semanal, Diária, Horária ou por Tarefa. Valores: MONTHLY, FORTNIGHTLY, WEEKLY, DAILY, HOURLY, TASK. |
journeyType | enum | Não | Tipo de jornada (eSocial): horário fixo, 12x36 ou outros. A carga horária é semanal (weeklyHours). Valores: FIXED, SHIFT_12_36, OTHER. |
journeyDescription | string | Não | Descrição livre da jornada de trabalho (eSocial "Descrição da jornada"). |
workShiftId | string | Não | ID de jornada: turno. Turno do colaborador no nível do RH — funciona mesmo para colaborador sem usuário de sistema. |
registrationNumber | string | Não | Matrícula interna do colaborador. |
role | string | Sim | Cargo do colaborador. |
department | string | Não | Setor/departamento (texto livre). |
monthlySalary | number | Não | Salário/valor mensal bruto em reais. |
hourlyRate | number | Não | Custo por hora do colaborador. Calculado automaticamente se não informado. |
billingRate | number | Não | Tarifa de cobrança ao cliente por hora. |
totalCostMultiplier | number | Não | Multiplicador de custo total (encargos). CLT ~1.8, PJ ~1.0. |
weeklyHours | number | Não | Horas semanais contratadas. |
requiresTimesheet | boolean | Não | Se o colaborador precisa ter folha de ponto (timesheet) fechada — governa a visibilidade/obrigatoriedade do lançamento de horas e a trava de fechamento da folha. Se omitido, o horista (valor/hora sem salário mensal) nasce como true; os demais como false. |
dependentsCount | number | Não | Número de dependentes do colaborador (alimenta o cálculo do IRRF na folha, 13º e rescisão). |
metadata | object | Não | Objeto JSON livre. |
Atualizar
Envie no corpo só os campos que mudam, com os mesmos nomes da tabela de criação. Responde 200 com o registro atualizado. Registro de outra empresa responde 403; registro inexistente, 404.
Apontamentos de horas
Recurso do plano: Timesheet e Apontamento de Horas.
| Método | Rota | O que faz |
|---|---|---|
GET | /external/v1/timesheet-entries | Lista com paginação |
GET | /external/v1/timesheet-entries/:id | Busca um registro pelo ID |
POST | /external/v1/timesheet-entries | Cria um registro |
Listar
Aceita page, limit e relations, como descrito em Paginação e filtros.
curl -G "https://erp-api.ideros.api.br/external/v1/timesheet-entries" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25"
Buscar por ID
curl "https://erp-api.ideros.api.br/external/v1/timesheet-entries/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"
Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).
Criar
Responde 201 com o registro criado.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
companyUserId | string | Não | ID do colaborador (CompanyUser). Se não informado, usa o usuário logado. |
projectId | string | Não | ID do projeto vinculado. |
projectTaskId | string | Não | ID da tarefa do projeto vinculada. |
dealId | string | Não | ID do negócio (Deal) vinculado. |
contractId | string | Não | ID do contrato vinculado. |
activityId | string | Não | ID da atividade vinculada. |
ticketId | string | Não | ID do ticket vinculado ao apontamento (chamado de Help Desk). |
hourBankId | string | Não | ID da bolsa de horas (banco de horas) que este apontamento consome. |
timesheetPeriodId | string | Não | ID do período de timesheet vinculado. Se não informado, será criado/vinculado automaticamente. |
date | string (data ISO 8601) | Sim | Data do apontamento (ISO-8601). |
startTime | string | Não | Hora de início no formato HH:mm. Se informado junto com endTime, a duração é calculada automaticamente. |
endTime | string | Não | Hora de fim no formato HH:mm. |
durationMinutes | number | Não | Duração em minutos. Obrigatório se startTime/endTime não forem informados. |
breakMinutes | number | Não | Minutos de pausa (descontados da duração). |
type | enum | Não | Tipo do apontamento. Valores: REGULAR, OVERTIME, ON_CALL, TRAVEL. |
billable | boolean | Não | Indica se o apontamento é cobrável do cliente. |
hourlyRate | number | Não | Tarifa por hora (R$). Se não informado, herda do contrato vinculado. |
description | string | Não | Descrição do trabalho realizado. |
tags | object | Não | Tags para categorização livre (JSON). |
metadata | object | Não | Campo genérico para metadados adicionais. |
origin | string | Não | Origem explícita do apontamento. Quando 'GENERAL', é uma marcação de presença (ponto) sem vínculo — dispensa a exigência de vínculo. |
Períodos de timesheet
Recurso do plano: Timesheet e Apontamento de Horas.
| Método | Rota | O que faz |
|---|---|---|
GET | /external/v1/timesheet-periods | Lista com paginação |
GET | /external/v1/timesheet-periods/:id | Busca um registro pelo ID |
POST | /external/v1/timesheet-periods | Cria um registro |
Listar
Aceita page, limit e relations, como descrito em Paginação e filtros.
curl -G "https://erp-api.ideros.api.br/external/v1/timesheet-periods" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25"
Buscar por ID
curl "https://erp-api.ideros.api.br/external/v1/timesheet-periods/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"
Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).
Criar
Responde 201 com o registro criado.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
companyUserId | string | Não | ID do colaborador (CompanyUser). Se não informado, usa o usuário logado. |
periodStart | string (data ISO 8601) | Sim | Data de início do período (ISO-8601). |
periodEnd | string (data ISO 8601) | Sim | Data de fim do período (ISO-8601). |
A nossa equipe ajuda você a configurar e usar esse recurso.