Pular para o conteúdo principal

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étodoRotaO que faz
GET/external/v1/employee-profilesLista com paginação
GET/external/v1/employee-profiles/:idBusca um registro pelo ID
POST/external/v1/employee-profilesCria um registro
PUT/external/v1/employee-profiles/:idAtualiza 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.

CampoTipoObrigatórioDescrição
personIdstringSimID de pessoa. Representa o colaborador.
companyUserIdstringNãoID de usuário da empresa. Apenas se o colaborador acessa o sistema.
businessUnitIdstringNãoID de unidade de negócio. Unidade de negócio do colaborador.
admissionDatestring (data ISO 8601)SimData de admissão do colaborador.
employmentTypeenumSimTipo de vínculo empregatício. Valores: CLT, PJ, INTERN, FREELANCER, PARTNER.
contractTypeenumNãoTipo de contrato de trabalho (eSocial): prazo indeterminado, determinado, ou determinado vinculado a um fato. Valores: INDETERMINATE, DETERMINATE, DETERMINATE_EVENT.
contractEndDatestring (data ISO 8601)NãoContrato por prazo determinado: data de término PREVISTA do contrato (eSocial dtTerm). Diferente da data de desligamento real. ISO.
contractObjectstringNãoContrato por prazo determinado vinculado a um FATO/OBRA: objeto/descrição do fato determinante que encerra o contrato (eSocial objDet).
hasAssecuratoryClausebooleanNãoContrato por prazo determinado: possui cláusula assecuratória do direito recíproco de rescisão antecipada (eSocial clauseAssec).
esocialCategorystringNãoCategoria do trabalhador no eSocial (ex.: "104").
esocialCargoCodestringNãoCódigo do cargo no eSocial/CBO (ex.: "eSocial-001").
paymentUnitenumNãoUnidade de pagamento (eSocial): Mensal, Quinzenal, Semanal, Diária, Horária ou por Tarefa. Valores: MONTHLY, FORTNIGHTLY, WEEKLY, DAILY, HOURLY, TASK.
journeyTypeenumNãoTipo de jornada (eSocial): horário fixo, 12x36 ou outros. A carga horária é semanal (weeklyHours). Valores: FIXED, SHIFT_12_36, OTHER.
journeyDescriptionstringNãoDescrição livre da jornada de trabalho (eSocial "Descrição da jornada").
workShiftIdstringNãoID de jornada: turno. Turno do colaborador no nível do RH — funciona mesmo para colaborador sem usuário de sistema.
registrationNumberstringNãoMatrícula interna do colaborador.
rolestringSimCargo do colaborador.
departmentstringNãoSetor/departamento (texto livre).
monthlySalarynumberNãoSalário/valor mensal bruto em reais.
hourlyRatenumberNãoCusto por hora do colaborador. Calculado automaticamente se não informado.
billingRatenumberNãoTarifa de cobrança ao cliente por hora.
totalCostMultipliernumberNãoMultiplicador de custo total (encargos). CLT ~1.8, PJ ~1.0.
weeklyHoursnumberNãoHoras semanais contratadas.
requiresTimesheetbooleanNãoSe 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.
dependentsCountnumberNãoNúmero de dependentes do colaborador (alimenta o cálculo do IRRF na folha, 13º e rescisão).
metadataobjectNãoObjeto 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étodoRotaO que faz
GET/external/v1/timesheet-entriesLista com paginação
GET/external/v1/timesheet-entries/:idBusca um registro pelo ID
POST/external/v1/timesheet-entriesCria 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.

CampoTipoObrigatórioDescrição
companyUserIdstringNãoID do colaborador (CompanyUser). Se não informado, usa o usuário logado.
projectIdstringNãoID do projeto vinculado.
projectTaskIdstringNãoID da tarefa do projeto vinculada.
dealIdstringNãoID do negócio (Deal) vinculado.
contractIdstringNãoID do contrato vinculado.
activityIdstringNãoID da atividade vinculada.
ticketIdstringNãoID do ticket vinculado ao apontamento (chamado de Help Desk).
hourBankIdstringNãoID da bolsa de horas (banco de horas) que este apontamento consome.
timesheetPeriodIdstringNãoID do período de timesheet vinculado. Se não informado, será criado/vinculado automaticamente.
datestring (data ISO 8601)SimData do apontamento (ISO-8601).
startTimestringNãoHora de início no formato HH:mm. Se informado junto com endTime, a duração é calculada automaticamente.
endTimestringNãoHora de fim no formato HH:mm.
durationMinutesnumberNãoDuração em minutos. Obrigatório se startTime/endTime não forem informados.
breakMinutesnumberNãoMinutos de pausa (descontados da duração).
typeenumNãoTipo do apontamento. Valores: REGULAR, OVERTIME, ON_CALL, TRAVEL.
billablebooleanNãoIndica se o apontamento é cobrável do cliente.
hourlyRatenumberNãoTarifa por hora (R$). Se não informado, herda do contrato vinculado.
descriptionstringNãoDescrição do trabalho realizado.
tagsobjectNãoTags para categorização livre (JSON).
metadataobjectNãoCampo genérico para metadados adicionais.
originstringNãoOrigem 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étodoRotaO que faz
GET/external/v1/timesheet-periodsLista com paginação
GET/external/v1/timesheet-periods/:idBusca um registro pelo ID
POST/external/v1/timesheet-periodsCria 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.

CampoTipoObrigatórioDescrição
companyUserIdstringNãoID do colaborador (CompanyUser). Se não informado, usa o usuário logado.
periodStartstring (data ISO 8601)SimData de início do período (ISO-8601).
periodEndstring (data ISO 8601)SimData de fim do período (ISO-8601).
Ainda com dúvida?

A nossa equipe ajuda você a configurar e usar esse recurso.