RH e Pessoas

Colaboradores, departamentos, cargos, benefícios e responsabilidades — automatize os fluxos de dados de RH.

Funcionário

Endpoints

GET	/employees	Recupera a coleção de recursos Employee.
POST	/employees	Cria um recurso Employee.
GET	/employees/{id}	Recupera um recurso Employee.
PATCH	/employees/{id}	Atualiza o recurso Employee.
DELETE	/employees/{id}	Remove o recurso Employee.
GET	/employees/{id}/documents	Recupera um recurso Employee.
GET	/employees/{id}/feedback-suggestion	Recupera um recurso Employee.
GET	/employees/{id}/project-rates	Recupera um recurso Employee.
POST	/employees/{id}/user	Cria um recurso Employee.
DELETE	/employees/{id}/user	Remove o recurso Employee.
GET	/employees/{id}/working-hours-stats/{date}	Recupera um recurso Employee.
GET	/employees/me	Recupera a coleção de recursos Employee.
GET	/employees/preview	Recupera a coleção de recursos Employee.
GET	/employees/search	Recupera a coleção de recursos Employee.
GET	/people	Recupera a coleção de recursos Employee.
POST	/people	Cria um recurso Employee.
GET	/people/{id}	Recupera um recurso Employee.
PATCH	/people/{id}	Atualiza o recurso Employee.
DELETE	/people/{id}	Remove o recurso Employee.
GET	/people/{id}/documents	Recupera um recurso Employee.
GET	/people/{id}/feedback-suggestion	Recupera um recurso Employee.
GET	/people/{id}/project-rates	Recupera um recurso Employee.
GET	/people/{id}/review-context-snapshot	Recupera um recurso Employee.
POST	/people/{id}/user	Cria um recurso Employee.
DELETE	/people/{id}/user	Remove o recurso Employee.
GET	/people/{id}/working-hours-stats/{date}	Recupera um recurso Employee.
GET	/people/me	Recupera a coleção de recursos Employee.
GET	/people/preview	Recupera a coleção de recursos Employee.
GET	/people/search	Recupera a coleção de recursos Employee.

Departamento

Endpoints

GET	/departments	Recupera a coleção de recursos Department.
POST	/departments	Cria um recurso Department.
GET	/departments/{id}	Recupera um recurso Department.
PATCH	/departments/{id}	Atualiza o recurso Department.

Campos de schema

Campo	Tipo	Descrição
name	string
code	stringnull
manager	string,null (iri-reference)

Posição

Endpoints

GET	/positions	Recupera a coleção de recursos Position.
POST	/positions	Cria um recurso Position.
GET	/positions/{id}	Recupera um recurso Position.
PATCH	/positions/{id}	Atualiza o recurso Position.
DELETE	/positions/{id}	Remove o recurso Position.

Campos de schema

Campo	Tipo	Descrição
name*	string
roles	array

Benefício

Endpoints

GET	/benefits	Recupera a coleção de recursos Benefit.
POST	/benefits	Cria um recurso Benefit.
GET	/benefits/{id}	Recupera um recurso Benefit.
PATCH	/benefits/{id}	Atualiza o recurso Benefit.

Campos de schema

Campo	Tipo	Descrição
name*	string
visible	boolean
benefitPrices	array

Nota do Funcionário

Endpoints

GET	/people-notes	Recupera a coleção de recursos EmployeeNote.
POST	/people-notes	Cria um recurso EmployeeNote.
GET	/people-notes/{id}	Recupera um recurso EmployeeNote.
PATCH	/people-notes/{id}	Atualiza o recurso EmployeeNote.
DELETE	/people-notes/{id}	Remove o recurso EmployeeNote.

Campos de schema

Campo	Tipo	Descrição
employee*	string (iri-reference)
note*	string

Responsabilidade

Endpoints

GET	/responsibilities	Recupera a coleção de recursos Responsibility.
POST	/responsibilities	Cria um recurso Responsibility.
GET	/responsibilities/{id}	Recupera um recurso Responsibility.
PATCH	/responsibilities/{id}	Atualiza o recurso Responsibility.

Campos de schema

Campo	Tipo	Descrição
parent	mixed
responsibilityGroup*	string (iri-reference)
name*	string
description	string
children	array

Feedback

Endpoints

GET	/feedback	Recupera a coleção de recursos Feedback.
POST	/feedback	Cria um recurso Feedback.
GET	/feedback/{id}	Recupera um recurso Feedback.

Campos de schema

Campo	Tipo	Descrição
employee*	string,null (iri-reference)
authorEmployee*	string,null (iri-reference)
description*	string
details	stringnull
visibility*	string
rate*	string

Benefício do Colaborador

Endpoints

GET	/people-benefits	Recupera a coleção de recursos EmployeeBenefit.
POST	/people-benefits	Cria um recurso EmployeeBenefit.
GET	/people-benefits/{id}	Recupera um recurso EmployeeBenefit.
PATCH	/people-benefits/{id}	Atualiza o recurso EmployeeBenefit.

Campos de schema

Campo	Tipo	Descrição
employee*	string (iri-reference)
benefit*	string (iri-reference)
dateFrom*	string (date-time)
dateTo	string,null (date-time)

BHP do Colaborador

Endpoints

GET	/people-bhps	Recupera a coleção de recursos EmployeeBhp.
POST	/people-bhps	Cria um recurso EmployeeBhp.
GET	/people-bhps/{id}	Recupera um recurso EmployeeBhp.
PATCH	/people-bhps/{id}	Atualiza o recurso EmployeeBhp.

Campos de schema

Campo	Tipo	Descrição
employee*	string,null (iri-reference)
dateFrom*	string (date-time)
dateTo	string,null (date-time)
note	stringnull

Preço do Benefício

Endpoints

POST	/benefit-prices	Cria um recurso BenefitPrice.
GET	/benefit-prices/{id}	Recupera um recurso BenefitPrice.
PATCH	/benefit-prices/{id}	Atualiza o recurso BenefitPrice.
DELETE	/benefit-prices/{id}	Remove o recurso BenefitPrice.

Campos de schema

Campo	Tipo	Descrição
id	integer
benefit*	string (iri-reference)
validFrom*	string (date-time)
validTo	string,null (date-time)
price*	number
taxPercent*	number
defaultCompanyCoverageAmount*	number
createdAt	string (date-time)
updatedAt	string (date-time)
dateFrom	string (date-time)
dateTo	string,null (date-time)
employee	string,null (iri-reference)

Responsabilidade do Cargo

Endpoints

GET	/position-responsibilities	Recupera a coleção de recursos PositionResponsibility.
POST	/position-responsibilities	Cria um recurso PositionResponsibility.
GET	/position-responsibilities/{id}	Recupera um recurso PositionResponsibility.
DELETE	/position-responsibilities/{id}	Remove o recurso PositionResponsibility.

Campos de schema

Campo	Tipo	Descrição
position	string,null (iri-reference)
responsibility	string,null (iri-reference)

Colaborador da Responsabilidade

Endpoints

GET	/responsibility-employees	Recupera a coleção de recursos ResponsibilityEmployee.
POST	/responsibility-employees	Cria um recurso ResponsibilityEmployee.
GET	/responsibility-employees/{id}	Recupera um recurso ResponsibilityEmployee.
PATCH	/responsibility-employees/{id}	Atualiza o recurso ResponsibilityEmployee.
DELETE	/responsibility-employees/{id}	Remove o recurso ResponsibilityEmployee.

Campos de schema

Campo	Tipo	Descrição
id	integer
responsibility*	string,null (iri-reference)
employee*	string,null (iri-reference)
percentage*	integer
targets	string
description	string
createdAt	string (date-time)
updatedAt	string (date-time)

Grupo de Responsabilidades

Endpoints

GET	/responsibility-groups	Recupera a coleção de recursos ResponsibilityGroup.
POST	/responsibility-groups	Cria um recurso ResponsibilityGroup.
GET	/responsibility-groups/{id}	Recupera um recurso ResponsibilityGroup.
PATCH	/responsibility-groups/{id}	Atualiza o recurso ResponsibilityGroup.

Campos de schema

Campo	Tipo	Descrição
responsibleEmployee*	string,null (iri-reference)
name*	string
description	string
responsibilities	array

Transação do Colaborador

Endpoints

GET	/employee-transactions	Recupera a coleção de recursos EmployeeTransaction.
POST	/employee-transactions	Cria um recurso EmployeeTransaction.
PATCH	/employee-transactions/{id}	Atualiza o recurso EmployeeTransaction.
DELETE	/employee-transactions/{id}	Remove o recurso EmployeeTransaction.

Campos de schema

Campo	Tipo	Descrição
employee	string (iri-reference)
amount	stringnull

Anexo de Transação do Colaborador

Endpoints

GET	/employee-transaction-attachments	Recupera a coleção de recursos EmployeeTransactionAttachment.
POST	/employee-transaction-attachments	Cria um recurso EmployeeTransactionAttachment.
PATCH	/employee-transaction-attachments/{id}	Atualiza o recurso EmployeeTransactionAttachment.
DELETE	/employee-transaction-attachments/{id}	Remove o recurso EmployeeTransactionAttachment.

Campos de schema

Campo	Tipo	Descrição
employee	string (iri-reference)
transactionAttachment	string (iri-reference)
netAmount	integernull
costType	stringnull	Cost component this allocation belongs to (App\Enum\EmployeeCostType value); null = untyped.

Pedido de Feedback

Endpoints

GET	/feedback-requests	Recupera a coleção de recursos FeedbackRequest.
POST	/feedback-requests	Cria um recurso FeedbackRequest.
GET	/feedback-requests/{id}	Recupera um recurso FeedbackRequest.

Campos de schema

Campo	Tipo	Descrição
id	string
requestedEmployee*	string,null (iri-reference)
employeeFor*	string,null (iri-reference)

Objetivo

Endpoints

GET	/objectives	Recupera a coleção de recursos Objective.
POST	/objectives	Cria um recurso Objective.
GET	/objectives/{id}	Recupera um recurso Objective.
PATCH	/objectives/{id}	Atualiza o recurso Objective.
DELETE	/objectives/{id}	Remove o recurso Objective.

Campos de schema

Campo	Tipo	Descrição
id	string
title*	string
owner*	string (iri-reference)
ownerLevel	string
department	string,null (iri-reference)
unit	string
periodStart	string,null (date-time)
periodEnd	string,null (date-time)
alignsTo	string,null (iri-reference)
reviewCycle	string,null (iri-reference)
tags	array
createdBy	string (iri-reference)
keyResults	array
createdAt	string (date-time)
updatedAt	string (date-time)
ownerName	stringnull	Owner's display name, embedded in the read payload so the UI never has to resolve it through a separately-permissioned /employees lookup (which a viewer may not have access to, leaving cards showing only the level chip).

Discussão

Endpoints

GET	/discussions	Recupera a coleção de recursos Discussion.
POST	/discussions	Cria um recurso Discussion.
GET	/discussions/{id}	Recupera um recurso Discussion.
PATCH	/discussions/{id}	Atualiza o recurso Discussion.
POST	/discussions/{id}/messages	Cria um recurso Discussion.
GET	/discussions/inbox	Recupera a coleção de recursos Discussion.

Campos de schema

Campo	Tipo	Descrição
status	string