Referência

Recursos humanos

Os trabalhadores e tudo o que lhes diz respeito: estrutura, fichas, férias e assiduidade, ponto, remunerações e folha, cessações, processos disciplinares, contencioso, higiene e segurança, activos, avaliações, acordos colectivos e canal de denúncias. São dados sensíveis: uma chave só alcança esta área se o dono da empresa lhe der, ao criá-la, acesso reforçado, com consentimento registado, endereços de rede e validade curta. Cada pedido fica registado e o dono vê-o. Ver Dados sensíveis. A identidade de quem denuncia e a importação em massa de trabalhadores não se fazem por chave.

Operação	O que faz
GET `/api/rh/funcionarios`	Lista os trabalhadores da empresa.
GET `/api/rh/departamentos`	Lista os departamentos.
POST `/api/rh/departamentos`	Cria um departamento.
PUT `/api/rh/departamentos/{id}`	Altera um departamento.
PUT `/api/rh/departamentos/{id}/activo`	Activa ou desactiva um departamento.
GET `/api/rh/cargos`	Lista os cargos.
POST `/api/rh/cargos`	Cria um cargo.
PUT `/api/rh/cargos/{id}`	Altera um cargo.
PUT `/api/rh/cargos/{id}/activo`	Activa ou desactiva um cargo.
GET `/api/rh/funcionarios/resumo`	O resumo dos trabalhadores: quantos há, por estado.
GET `/api/rh/funcionarios/alertas-documentos`	Os alertas sobre documentos dos trabalhadores (por exemplo, os que estão a expirar).
GET `/api/rh/funcionarios/{id}`	A ficha de um trabalhador.
POST `/api/rh/funcionarios`	Cria um trabalhador (a ficha).
PUT `/api/rh/funcionarios/{id}`	Altera a ficha de um trabalhador.
POST `/api/rh/funcionarios/{id}/contratos`	Regista um contrato do trabalhador.
PUT `/api/rh/funcionarios/{id}/contas-bancarias`	Define as contas bancárias do trabalhador (onde recebe o salário).
PUT `/api/rh/funcionarios/{id}/dependentes`	Define os dependentes do trabalhador.
PUT `/api/rh/funcionarios/{id}/estado`	Muda o estado do trabalhador (activo, suspenso, de licença…).
GET `/api/rh/funcionarios/{id}/situacoes`	O histórico de suspensões e licenças da ficha: motivo, início, retorno previsto e regresso.
POST `/api/rh/funcionarios/{id}/cessar`	Cessa a relação de trabalho de um trabalhador.
GET `/api/rh/funcionarios/{id}/componentes`	Os componentes remuneratórios de um trabalhador (salário base, subsídios…).
POST `/api/rh/funcionarios/{id}/componentes`	Acrescenta um componente remuneratório a um trabalhador.
GET `/api/rh/funcionarios/{id}/habilitacoes`	As habilitações académicas e a formação profissional da ficha.
PUT `/api/rh/funcionarios/{id}/habilitacoes`	Define as habilitações académicas e a formação profissional da ficha.
GET `/api/rh/funcionarios/{id}/situacao-fiscal`	A situação fiscal e contributiva da ficha (isento de IRT, não sujeito à Segurança Social…), com a fonte legal e o histórico.
POST `/api/rh/funcionarios/{id}/situacao-fiscal`	Regista uma situação fiscal ou contributiva na ficha.
GET `/api/rh/funcionarios/{id}/recibos`	Os recibos de vencimento de um trabalhador.
POST `/api/rh/componentes/{id}/encerrar`	Encerra um componente remuneratório: deixa de contar a partir da data indicada.
GET `/api/rh/remuneracoes/trabalhadores`	Os trabalhadores para escolher nos ecrãs de remunerações (só nomes, sem salários).
GET `/api/rh/configuracao`	A configuração de recursos humanos da empresa: as respostas às perguntas que condicionam os cálculos.
GET `/api/rh/configuracao/historico`	O histórico das alterações à configuração de recursos humanos.
POST `/api/rh/configuracao/aceitar-padroes`	Aceita de uma vez todas as respostas padrão (e as por confirmar), com o nome de quem as validou.
PUT `/api/rh/configuracao/{pergunta}`	Define a resposta a uma pergunta da configuração de recursos humanos.
GET `/api/rh/calendario`	O calendário de recursos humanos: os feriados da empresa.
POST `/api/rh/calendario/feriados`	Regista um feriado ou uma tolerância no calendário da empresa.
GET `/api/rh/calendario/feriados-nacionais`	Os feriados nacionais da lei (e as pontes) propostos para um ano.
POST `/api/rh/calendario/feriados-nacionais`	Carrega os feriados nacionais propostos no calendário da empresa.
PUT `/api/rh/calendario/feriados/{id}`	Altera um feriado do calendário da empresa.
DELETE `/api/rh/calendario/feriados/{id}`	Remove um feriado do calendário da empresa.
GET `/api/rh/parametros-legais`	Os parâmetros legais em vigor que os cálculos de recursos humanos usam (só leitura).
GET `/api/rh/ausencias`	Lista as ausências dos trabalhadores.
POST `/api/rh/ausencias`	Regista uma ausência.
POST `/api/rh/ausencias/{id}/aprovar`	Aprova uma ausência.
POST `/api/rh/ausencias/{id}/rejeitar`	Rejeita uma ausência.
POST `/api/rh/ausencias/{id}/anular`	Anula uma ausência.
GET `/api/rh/ferias/saldos`	Os saldos de férias dos trabalhadores.
GET `/api/rh/ferias/funcionarios/{funcionarioId}`	As férias de um trabalhador: direitos, saldo e marcações.
POST `/api/rh/ferias/direitos`	Regista um movimento do direito a férias de um trabalhador num ano (o direito do ano, dias por acordo ou um ajuste).
GET `/api/rh/ferias/marcacoes`	Lista as marcações de férias.
POST `/api/rh/ferias/marcacoes`	Marca férias de um trabalhador.
POST `/api/rh/ferias/marcacoes/{id}/aprovar`	Aprova uma marcação de férias.
POST `/api/rh/ferias/marcacoes/{id}/rejeitar`	Rejeita uma marcação de férias.
POST `/api/rh/ferias/marcacoes/{id}/anular`	Anula uma marcação de férias.
GET `/api/rh/trabalho-suplementar`	Lista o trabalho suplementar (horas extra).
GET `/api/rh/trabalho-suplementar/resumo`	O resumo do trabalho suplementar.
POST `/api/rh/trabalho-suplementar`	Regista trabalho suplementar de um trabalhador.
POST `/api/rh/trabalho-suplementar/{id}/aprovar`	Aprova trabalho suplementar.
POST `/api/rh/trabalho-suplementar/{id}/rejeitar`	Rejeita trabalho suplementar.
POST `/api/rh/trabalho-suplementar/{id}/anular`	Anula trabalho suplementar.
GET `/api/rh/assiduidade/trabalhadores`	Os trabalhadores para escolher nos ecrãs de assiduidade (só nomes).
GET `/api/rh/assiduidade/calendario`	O calendário de assiduidade: as ausências, as férias e os feriados de um período.
GET `/api/rh/ponto/equipamentos`	Os equipamentos de ponto (relógios) da empresa.
POST `/api/rh/ponto/equipamentos`	Regista um equipamento de ponto.
PUT `/api/rh/ponto/equipamentos/{id}`	Altera um equipamento de ponto.
GET `/api/rh/ponto/codigos`	Os códigos dos trabalhadores nos equipamentos de ponto.
PUT `/api/rh/ponto/codigos/{funcionarioId}`	Define o código de um trabalhador nos equipamentos de ponto.
GET `/api/rh/ponto/marcacoes`	As marcações de ponto de um período.
POST `/api/rh/ponto/marcacoes`	Regista à mão uma marcação de ponto (esquecimento do trabalhador, equipamento avariado).
POST `/api/rh/ponto/importacoes/pre-visualizar`	Pré-visualiza a importação de um ficheiro extraído de um equipamento de ponto: não grava nada.
POST `/api/rh/ponto/importacoes`	Importa um ficheiro extraído de um equipamento de ponto: acrescenta as marcações novas.
GET `/api/rh/ponto/folha/{funcionarioId}`	A folha de ponto de um trabalhador num período.
GET `/api/rh/rubricas`	As rubricas de remuneração e de desconto.
GET `/api/rh/rubricas/para-lancamento`	As rubricas que se podem usar num lançamento variável.
POST `/api/rh/rubricas`	Cria uma rubrica.
PUT `/api/rh/rubricas/{id}`	Altera uma rubrica.
PUT `/api/rh/rubricas/{id}/activa`	Activa ou desactiva uma rubrica.
GET `/api/rh/subsidios-extraordinarios`	A proposta dos subsídios de férias e de Natal de um mês.
POST `/api/rh/subsidios-extraordinarios/gerar`	Gera os lançamentos dos subsídios de férias e de Natal de um mês, por aprovar.
GET `/api/rh/lancamentos`	Lista os lançamentos variáveis (prémios, comissões, faltas descontadas…).
POST `/api/rh/lancamentos`	Regista um lançamento variável.
POST `/api/rh/lancamentos/{id}/aprovar`	Aprova um lançamento variável.
POST `/api/rh/lancamentos/{id}/rejeitar`	Rejeita um lançamento variável.
POST `/api/rh/lancamentos/{id}/anular`	Anula um lançamento variável.
GET `/api/rh/descontos`	Lista os descontos programados (empréstimos, adiantamentos…).
GET `/api/rh/descontos/{id}`	Um desconto programado, com os movimentos e os eventos.
POST `/api/rh/descontos`	Cria um desconto programado.
POST `/api/rh/descontos/{id}/aprovar`	Aprova um desconto programado.
POST `/api/rh/descontos/{id}/rejeitar`	Rejeita um desconto programado.
POST `/api/rh/descontos/{id}/anular`	Anula um desconto programado.
POST `/api/rh/descontos/{id}/movimentos`	Regista um movimento manual no saldo de um desconto aprovado: um abatimento (o trabalhador pagou por outra via) ou um estorno.
POST `/api/rh/descontos/{id}/eventos`	Suspende ou retoma um desconto aprovado a partir de um mês (por exemplo, por ordem do tribunal).
GET `/api/rh/diuturnidades/rubricas`	As rubricas que se podem usar nas diuturnidades.
GET `/api/rh/diuturnidades/regras`	As regras de diuturnidades da empresa.
GET `/api/rh/diuturnidades`	As diuturnidades dos trabalhadores.
POST `/api/rh/diuturnidades/regras`	Cria uma regra de diuturnidades.
POST `/api/rh/diuturnidades/regras/{id}/anular`	Anula uma regra de diuturnidades.
POST `/api/rh/diuturnidades/aplicar`	Aplica as regras de diuturnidades aos trabalhadores.
GET `/api/rh/folhas`	Lista as folhas de salários.
GET `/api/rh/folhas/{id}`	Uma folha de salários, com os recibos.
GET `/api/rh/folhas/{id}/recibos/{reciboId}`	Um recibo de vencimento de uma folha.
GET `/api/rh/folhas/{id}/pdf`	A folha inteira em PDF.
GET `/api/rh/folhas/{id}/recibos/{reciboId}/pdf`	Um recibo de vencimento em PDF.
GET `/api/rh/folhas/{id}/mapa-pagamento`	O mapa de pagamento de uma folha aprovada: quanto pagar a cada trabalhador.
GET `/api/rh/folhas/{id}/mapa-pagamento/csv`	O mapa de pagamento de uma folha aprovada, em CSV.
GET `/api/rh/folhas/{id}/mapa-retencoes`	O mapa de retenções de uma folha aprovada: o IRT e a Segurança Social retidos.
GET `/api/rh/folhas/{id}/mapa-retencoes/csv`	O mapa de retenções de uma folha aprovada, em CSV.
GET `/api/rh/folhas/{id}/mapa-remuneracoes-agt`	O Mapa de Remunerações da AGT de uma folha aprovada: a pré-visualização, com avisos.
GET `/api/rh/folhas/{id}/mapa-remuneracoes-agt/xlsx`	O Mapa de Remunerações da AGT de uma folha aprovada, no modelo Excel oficial.
GET `/api/rh/folhas/trabalhadores`	Os trabalhadores que a folha de um mês pode incluir (só nomes, sem salários).
POST `/api/rh/folhas`	Calcula a folha de salários de um mês: um recibo por trabalhador com relação laboral nesse mês.
DELETE `/api/rh/folhas/{id}`	Descarta uma folha em rascunho.
POST `/api/rh/folhas/{id}/aprovar`	Aprova uma folha de salários.
POST `/api/rh/folhas/{id}/anular`	Anula uma folha de salários aprovada, com o motivo.
GET `/api/rh/cessacoes/trabalhadores`	Os trabalhadores para escolher nos ecrãs de cessação.
GET `/api/rh/cessacoes`	Lista as cessações e os acertos de contas.
GET `/api/rh/cessacoes/{id}`	Uma cessação, com o acerto de contas.
POST `/api/rh/cessacoes`	Inicia o processo de cessação de um trabalhador e calcula as sugestões do acerto de contas.
PUT `/api/rh/cessacoes/{id}/linhas`	Define as linhas do acerto de contas de uma cessação em rascunho.
DELETE `/api/rh/cessacoes/{id}`	Descarta uma cessação em rascunho.
POST `/api/rh/cessacoes/{id}/aprovar`	Aprova uma cessação e o seu acerto de contas.
GET `/api/rh/disciplinar/trabalhadores`	Os trabalhadores para escolher nos ecrãs disciplinares.
GET `/api/rh/disciplinar`	Lista os processos disciplinares.
GET `/api/rh/disciplinar/alertas`	Os alertas dos processos disciplinares (prazos a vencer).
GET `/api/rh/disciplinar/{id}`	Um processo disciplinar, com as fases.
POST `/api/rh/disciplinar`	Abre um processo disciplinar.
POST `/api/rh/disciplinar/{id}/fases`	Regista uma fase de um processo disciplinar.
POST `/api/rh/disciplinar/{id}/sancao`	Aplica uma sanção disciplinar.
POST `/api/rh/disciplinar/{id}/arquivar`	Arquiva um processo disciplinar.
GET `/api/rh/contencioso/trabalhadores`	Os trabalhadores para escolher nos ecrãs de contencioso.
GET `/api/rh/contencioso`	Lista os litígios laborais.
GET `/api/rh/contencioso/resumo`	O resumo dos litígios laborais e das provisões.
GET `/api/rh/contencioso/{id}`	Um litígio laboral, com os eventos e as provisões.
POST `/api/rh/contencioso`	Abre um litígio laboral.
POST `/api/rh/contencioso/{id}/eventos`	Regista um evento num litígio laboral.
POST `/api/rh/contencioso/{id}/risco`	Classifica o risco de um litígio laboral.
PUT `/api/rh/contencioso/{id}/numero-processo`	Define o número do processo judicial de um litígio.
POST `/api/rh/contencioso/{id}/encerrar`	Encerra um litígio laboral.
POST `/api/rh/contencioso/{id}/conta`	Regista uma conta (um custo ou um recebimento) num litígio laboral.
POST `/api/rh/contencioso/{id}/provisoes`	Propõe uma provisão para um litígio laboral.
POST `/api/rh/contencioso/provisoes/{provisaoId}/confirmar`	Confirma uma provisão proposta.
POST `/api/rh/contencioso/provisoes/{provisaoId}/rejeitar`	Rejeita uma provisão proposta.
GET `/api/rh/hst/trabalhadores`	Os trabalhadores para escolher nos ecrãs de higiene, segurança e saúde.
GET `/api/rh/hst/alertas`	Os alertas de higiene, segurança e saúde (por exemplo, exames por renovar).
GET `/api/rh/hst/exames`	Lista os exames médicos dos trabalhadores.
POST `/api/rh/hst/exames`	Regista um exame médico.
POST `/api/rh/hst/exames/{id}/anular`	Anula um exame médico registado.
GET `/api/rh/hst/acidentes`	Lista os acidentes de trabalho.
GET `/api/rh/hst/acidentes/{id}`	Um acidente de trabalho, com as actualizações.
POST `/api/rh/hst/acidentes`	Regista um acidente de trabalho.
POST `/api/rh/hst/acidentes/{id}/actualizacoes`	Regista uma actualização num acidente de trabalho.
GET `/api/rh/activos/trabalhadores`	Os trabalhadores para escolher nos ecrãs de activos.
GET `/api/rh/activos/alertas`	Os alertas dos activos entregues (por exemplo, devoluções em atraso).
GET `/api/rh/activos`	Lista os activos entregues aos trabalhadores (EPI, equipamentos).
POST `/api/rh/activos`	Regista a entrega de um activo a um trabalhador.
POST `/api/rh/activos/{id}/devolver`	Regista a devolução de um activo.
POST `/api/rh/activos/{id}/anular`	Anula o registo de um activo entregue.
GET `/api/rh/avaliacoes/trabalhadores`	Os trabalhadores para escolher nos ecrãs de avaliações.
GET `/api/rh/avaliacoes/resumo`	O resumo das avaliações de desempenho.
GET `/api/rh/avaliacoes/pendentes`	Os trabalhadores com avaliação de desempenho pendente.
GET `/api/rh/avaliacoes`	Lista as avaliações de desempenho.
GET `/api/rh/avaliacoes/{id}`	Uma avaliação de desempenho.
POST `/api/rh/avaliacoes`	Abre uma avaliação de desempenho.
PUT `/api/rh/avaliacoes/{id}`	Actualiza uma avaliação de desempenho em curso.
POST `/api/rh/avaliacoes/{id}/concluir`	Conclui uma avaliação de desempenho.
POST `/api/rh/avaliacoes/{id}/anular`	Anula uma avaliação de desempenho.
GET `/api/rh/acordos/trabalhadores`	Os trabalhadores para escolher nos ecrãs de acordos colectivos.
GET `/api/rh/acordos`	Lista os acordos colectivos de trabalho.
GET `/api/rh/acordos/{id}`	Um acordo colectivo, com os parâmetros, as categorias e as adesões.
POST `/api/rh/acordos`	Regista um acordo colectivo de trabalho.
PUT `/api/rh/acordos/{id}`	Actualiza um acordo colectivo.
POST `/api/rh/acordos/{id}/terminar`	Termina um acordo colectivo.
POST `/api/rh/acordos/{id}/parametros`	Acrescenta um parâmetro a um acordo colectivo.
POST `/api/rh/acordos/{id}/parametros/{parametroId}/anular`	Anula um parâmetro de um acordo colectivo.
POST `/api/rh/acordos/{id}/parametros/{parametroId}/confirmar`	Confirma um parâmetro de um acordo colectivo.
POST `/api/rh/acordos/{id}/categorias`	Acrescenta uma categoria profissional a um acordo colectivo.
POST `/api/rh/acordos/{id}/categorias/{categoriaId}/anular`	Anula uma categoria de um acordo colectivo.
POST `/api/rh/acordos/{id}/adesoes`	Regista a adesão de um trabalhador a um acordo colectivo.
POST `/api/rh/acordos/adesoes/{adesaoId}/encerrar`	Encerra a adesão de um trabalhador a um acordo colectivo.
GET `/api/rh/auditoria/acessos`	A auditoria de acessos a dados sensíveis de recursos humanos feitos dentro do Mucanda: quem consultou o quê e quando.
GET `/api/rh/denuncias/resumo`	O resumo das denúncias recebidas no canal de denúncias.
GET `/api/rh/denuncias`	Lista as denúncias recebidas no canal de denúncias.
GET `/api/rh/denuncias/{id}`	Uma denúncia, com as respostas e as notas de tratamento.
POST `/api/rh/denuncias/{id}/responder`	Responde ao autor de uma denúncia, pelo canal.
POST `/api/rh/denuncias/{id}/notas`	Regista uma nota interna no tratamento de uma denúncia.
POST `/api/rh/denuncias/{id}/concluir`	Conclui o tratamento de uma denúncia.
POST `/api/rh/denuncias/{id}/arquivar`	Arquiva uma denúncia.

GET/api/rh/funcionarios#

Lista os trabalhadores da empresa.

Permissão RH.FuncionariosLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

A resposta é uma página: itens e proximoCursor. Ver Paginação.

Parâmetros

Nome	Onde	Tipo
`filtro`	na pesquisa	texto
`estado`	na pesquisa	uma de: «Activo», «Suspenso», «EmLicenca», «Cessado», «null»
`cursor`	na pesquisa	texto
`tamanho`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/funcionarios' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/departamentos#

Lista os departamentos.

Permissão RH.EstruturaLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`incluirInactivos`	na pesquisa	verdadeiro/falso

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/departamentos' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/departamentos#

Cria um departamento.

Permissão RH.EstruturaEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id.

Corpo do pedido (JSON · CriarDepartamentoCommand)

Campo	Tipo	Obrigatório	Significado
`codigo`	texto	sim	O código curto.
`nome`	texto	sim	O nome.
`departamentoSuperiorId`	identificador (UUID) ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/departamentos' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "codigo": "texto",
  "nome": "texto"
}'

PUT/api/rh/departamentos/{id}#

Altera um departamento.

Permissão RH.EstruturaEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · DepartamentoRequest)

Campo	Tipo	Obrigatório	Significado
`codigo`	texto	sim	O código curto.
`nome`	texto	sim	O nome.
`departamentoSuperiorId`	identificador (UUID) ou nulo

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/departamentos/<id>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "codigo": "texto",
  "nome": "texto"
}'

PUT/api/rh/departamentos/{id}/activo#

Activa ou desactiva um departamento.

Permissão RH.EstruturaEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · ActivoRequest)

Campo	Tipo	Obrigatório	Significado
`activo`	verdadeiro/falso	sim	Se está activo.

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/departamentos/<id>/activo' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "activo": false
}'

GET/api/rh/cargos#

Lista os cargos.

Permissão RH.EstruturaLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`incluirInactivos`	na pesquisa	verdadeiro/falso

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/cargos' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/cargos#

Cria um cargo.

Permissão RH.EstruturaEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id.

Corpo do pedido (JSON · CriarCargoCommand)

Campo	Tipo	Obrigatório	Significado
`codigo`	texto	sim	O código curto.
`titulo`	texto	sim
`nivel`	uma de: «NaoQualificado», «Qualificado», «TecnicoMedio», «TecnicoSuperior», «Chefia»	sim
`departamentoId`	identificador (UUID) ou nulo
`descricao`	texto ou nulo		A descrição.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/cargos' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "codigo": "texto",
  "titulo": "texto",
  "nivel": "NaoQualificado"
}'

PUT/api/rh/cargos/{id}#

Altera um cargo.

Permissão RH.EstruturaEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · CargoRequest)

Campo	Tipo	Obrigatório	Significado
`codigo`	texto	sim	O código curto.
`titulo`	texto	sim
`nivel`	uma de: «NaoQualificado», «Qualificado», «TecnicoMedio», «TecnicoSuperior», «Chefia»	sim
`departamentoId`	identificador (UUID) ou nulo
`descricao`	texto ou nulo		A descrição.

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/cargos/<id>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "codigo": "texto",
  "titulo": "texto",
  "nivel": "NaoQualificado"
}'

PUT/api/rh/cargos/{id}/activo#

Activa ou desactiva um cargo.

Permissão RH.EstruturaEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · ActivoRequest)

Campo	Tipo	Obrigatório	Significado
`activo`	verdadeiro/falso	sim	Se está activo.

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/cargos/<id>/activo' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "activo": false
}'

GET/api/rh/funcionarios/resumo#

O resumo dos trabalhadores: quantos há, por estado.

Permissão RH.FuncionariosLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/funcionarios/resumo' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/funcionarios/alertas-documentos#

Os alertas sobre documentos dos trabalhadores (por exemplo, os que estão a expirar).

Permissão RH.FuncionariosLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`dias`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/funcionarios/alertas-documentos' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/funcionarios/{id}#

A ficha de um trabalhador.

Permissão RH.FuncionariosLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/funcionarios/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/funcionarios#

Cria um trabalhador (a ficha).

Permissão RH.FuncionariosEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id.

Corpo do pedido (JSON · CriarFuncionarioCommand)

Campo	Tipo	Obrigatório	Significado
`dados`	objecto	sim
`dados.nome`	texto	sim	O nome.
`dados.nomeUsual`	texto ou nulo
`dados.numeroContribuinte`	texto	sim	O número de contribuinte (NIF).
`dados.tipoDocumento`	uma de: «BilheteIdentidade», «Passaporte», «CartaoResidencia»	sim
`dados.numeroDocumento`	texto	sim
`dados.documentoEmitidoEm`	data (AAAA-MM-DD) ou nulo
`dados.documentoValidoAte`	data (AAAA-MM-DD) ou nulo
`dados.documentoEmitidoPor`	texto ou nulo
`dados.numeroInss`	texto ou nulo
`dados.genero`	uma de: «Masculino», «Feminino»	sim
`dados.dataNascimento`	data (AAAA-MM-DD)	sim
`dados.estadoCivil`	uma de: «Solteiro», «Casado», «Divorciado», «Viuvo», «UniaoDeFacto»	sim
`dados.nacionalidade`	texto	sim
`dados.grupoSanguineo`	texto ou nulo
`dados.telemovel`	texto	sim	O telemóvel.
`dados.telefoneAlternativo`	texto ou nulo
`dados.emailPessoal`	texto ou nulo
`dados.emailTrabalho`	texto ou nulo
`dados.endereco`	texto ou nulo		A morada.
`dados.municipioId`	identificador (UUID) ou nulo
`dados.numeroAutorizacaoTrabalho`	texto ou nulo
`dados.validadeAutorizacaoTrabalho`	data (AAAA-MM-DD) ou nulo
`dataAdmissao`	data (AAAA-MM-DD)	sim
`contrato`	objecto	sim
`contrato.tipo`	uma de: «Indeterminado», «TermoCerto», «TermoIncerto», «Estagio»	sim
`contrato.vigenteDesde`	data (AAAA-MM-DD)	sim
`contrato.dataFim`	data (AAAA-MM-DD) ou nulo
`contrato.periodoExperimentalDias`	número inteiro ou nulo
`contrato.salarioBase`	número	sim
`contrato.horasSemanais`	número	sim
`contrato.regime`	uma de: «FixoMensal», «PorTempos», «Misto»	sim
`contrato.formaPagamento`	uma de: «Transferencia», «Numerario», «Cheque»	sim
`contrato.isentoDeHorario`	verdadeiro/falso	sim
`contrato.cargoId`	identificador (UUID) ou nulo
`contrato.departamentoId`	identificador (UUID) ou nulo
`contrato.lojaId`	identificador (UUID) ou nulo		O estabelecimento.
`contasBancarias`	lista de objectos	sim
`contasBancarias[].banco`	texto	sim
`contasBancarias[].iban`	texto	sim
`contasBancarias[].principal`	verdadeiro/falso	sim
`contasBancarias[].percentagemDivisao`	número	sim
`dependentes`	lista de objectos	sim
`dependentes[].nome`	texto	sim	O nome.
`dependentes[].parentesco`	uma de: «Filho», «Conjuge», «Ascendente», «DependenteIncapacitado»	sim
`dependentes[].dataNascimento`	data (AAAA-MM-DD)	sim
`dependentes[].numeroDocumento`	texto ou nulo
`dependentes[].deficiencia`	verdadeiro/falso	sim
`dependentes[].estudante`	verdadeiro/falso	sim
`dependentes[].direitoAbonoFamilia`	verdadeiro/falso	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/funcionarios' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "dados": {
    "nome": "texto",
    "numeroContribuinte": "texto",
    "tipoDocumento": "BilheteIdentidade",
    "numeroDocumento": "texto",
    "genero": "Masculino",
    "dataNascimento": "2026-10-12",
    "estadoCivil": "Solteiro",
    "nacionalidade": "texto",
    "telemovel": "texto"
  },
  "dataAdmissao": "2026-10-12",
  "contrato": {
    "tipo": "Indeterminado",
    "vigenteDesde": "2026-10-12",
    "salarioBase": 0,
    "horasSemanais": 0,
    "regime": "FixoMensal",
    "formaPagamento": "Transferencia",
    "isentoDeHorario": false
  },
  "contasBancarias": [
    {
      "banco": "texto",
      "iban": "texto",
      "principal": false,
      "percentagemDivisao": 0
    }
  ],
  "dependentes": [
    {
      "nome": "texto",
      "parentesco": "Filho",
      "dataNascimento": "2026-10-12",
      "deficiencia": false,
      "estudante": false,
      "direitoAbonoFamilia": false
    }
  ]
}'

PUT/api/rh/funcionarios/{id}#

Altera a ficha de um trabalhador.

Permissão RH.FuncionariosEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · DadosFuncionario)

Campo	Tipo	Obrigatório	Significado
`nome`	texto	sim	O nome.
`nomeUsual`	texto ou nulo
`numeroContribuinte`	texto	sim	O número de contribuinte (NIF).
`tipoDocumento`	uma de: «BilheteIdentidade», «Passaporte», «CartaoResidencia»	sim
`numeroDocumento`	texto	sim
`documentoEmitidoEm`	data (AAAA-MM-DD) ou nulo
`documentoValidoAte`	data (AAAA-MM-DD) ou nulo
`documentoEmitidoPor`	texto ou nulo
`numeroInss`	texto ou nulo
`genero`	uma de: «Masculino», «Feminino»	sim
`dataNascimento`	data (AAAA-MM-DD)	sim
`estadoCivil`	uma de: «Solteiro», «Casado», «Divorciado», «Viuvo», «UniaoDeFacto»	sim
`nacionalidade`	texto	sim
`grupoSanguineo`	texto ou nulo
`telemovel`	texto	sim	O telemóvel.
`telefoneAlternativo`	texto ou nulo
`emailPessoal`	texto ou nulo
`emailTrabalho`	texto ou nulo
`endereco`	texto ou nulo		A morada.
`municipioId`	identificador (UUID) ou nulo
`numeroAutorizacaoTrabalho`	texto ou nulo
`validadeAutorizacaoTrabalho`	data (AAAA-MM-DD) ou nulo

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/funcionarios/<id>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "nome": "texto",
  "numeroContribuinte": "texto",
  "tipoDocumento": "BilheteIdentidade",
  "numeroDocumento": "texto",
  "genero": "Masculino",
  "dataNascimento": "2026-10-12",
  "estadoCivil": "Solteiro",
  "nacionalidade": "texto",
  "telemovel": "texto"
}'

POST/api/rh/funcionarios/{id}/contratos#

Regista um contrato do trabalhador.

Permissão RH.RemuneracoesEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · AlterarContratoRequest)

Campo	Tipo	Obrigatório	Significado
`contrato`	objecto	sim
`contrato.tipo`	uma de: «Indeterminado», «TermoCerto», «TermoIncerto», «Estagio»	sim
`contrato.vigenteDesde`	data (AAAA-MM-DD)	sim
`contrato.dataFim`	data (AAAA-MM-DD) ou nulo
`contrato.periodoExperimentalDias`	número inteiro ou nulo
`contrato.salarioBase`	número	sim
`contrato.horasSemanais`	número	sim
`contrato.regime`	uma de: «FixoMensal», «PorTempos», «Misto»	sim
`contrato.formaPagamento`	uma de: «Transferencia», «Numerario», «Cheque»	sim
`contrato.isentoDeHorario`	verdadeiro/falso	sim
`contrato.cargoId`	identificador (UUID) ou nulo
`contrato.departamentoId`	identificador (UUID) ou nulo
`contrato.lojaId`	identificador (UUID) ou nulo		O estabelecimento.
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/funcionarios/<id>/contratos' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "contrato": {
    "tipo": "Indeterminado",
    "vigenteDesde": "2026-10-12",
    "salarioBase": 0,
    "horasSemanais": 0,
    "regime": "FixoMensal",
    "formaPagamento": "Transferencia",
    "isentoDeHorario": false
  }
}'

PUT/api/rh/funcionarios/{id}/contas-bancarias#

Define as contas bancárias do trabalhador (onde recebe o salário).

Permissão RH.RemuneracoesEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Substitui a lista inteira.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON)

Campo	Tipo	Obrigatório
`[].banco`	texto	sim
`[].iban`	texto	sim
`[].principal`	verdadeiro/falso	sim
`[].percentagemDivisao`	número	sim

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/funcionarios/<id>/contas-bancarias' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '[
  {
    "banco": "texto",
    "iban": "texto",
    "principal": false,
    "percentagemDivisao": 0
  }
]'

PUT/api/rh/funcionarios/{id}/dependentes#

Define os dependentes do trabalhador.

Permissão RH.FuncionariosEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Substitui a lista inteira.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON)

Campo	Tipo	Obrigatório	Significado
`[].nome`	texto	sim	O nome.
`[].parentesco`	uma de: «Filho», «Conjuge», «Ascendente», «DependenteIncapacitado»	sim
`[].dataNascimento`	data (AAAA-MM-DD)	sim
`[].numeroDocumento`	texto ou nulo
`[].deficiencia`	verdadeiro/falso	sim
`[].estudante`	verdadeiro/falso	sim
`[].direitoAbonoFamilia`	verdadeiro/falso	sim

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/funcionarios/<id>/dependentes' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '[
  {
    "nome": "texto",
    "parentesco": "Filho",
    "dataNascimento": "2026-10-12",
    "deficiencia": false,
    "estudante": false,
    "direitoAbonoFamilia": false
  }
]'

PUT/api/rh/funcionarios/{id}/estado#

Muda o estado do trabalhador (activo, suspenso, de licença…).

Permissão RH.FuncionariosEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Fica no histórico de situações da ficha, com o motivo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · EstadoRequest)

Campo	Tipo	Obrigatório	Significado
`estado`	uma de: «Activo», «Suspenso», «EmLicenca», «Cessado», «null»	sim	O estado actual.
`motivo`	texto ou nulo
`dataInicio`	data (AAAA-MM-DD) ou nulo
`retornoPrevisto`	data (AAAA-MM-DD) ou nulo
`dataRetorno`	data (AAAA-MM-DD) ou nulo

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/funcionarios/<id>/estado' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "estado": "Activo"
}'

GET/api/rh/funcionarios/{id}/situacoes#

O histórico de suspensões e licenças da ficha: motivo, início, retorno previsto e regresso.

Permissão RH.FuncionariosLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/funcionarios/<id>/situacoes' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/funcionarios/{id}/cessar#

Cessa a relação de trabalho de um trabalhador.

Permissão RH.FuncionariosEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · CessarRequest)

Campo	Tipo	Obrigatório	Significado
`data`	data (AAAA-MM-DD)	sim	A data e hora (UTC).

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/funcionarios/<id>/cessar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "data": "2026-10-12"
}'

GET/api/rh/funcionarios/{id}/componentes#

Os componentes remuneratórios de um trabalhador (salário base, subsídios…).

Permissão RH.RemuneracoesLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/funcionarios/<id>/componentes' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/funcionarios/{id}/componentes#

Acrescenta um componente remuneratório a um trabalhador.

Permissão RH.RemuneracoesEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · DefinirComponenteRequest)

Campo	Tipo	Obrigatório	Significado
`rubricaId`	identificador (UUID)	sim
`valor`	número	sim	O valor.
`vigenteDesde`	data (AAAA-MM-DD)	sim
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/funcionarios/<id>/componentes' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "rubricaId": "00000000-0000-0000-0000-000000000000",
  "valor": 0,
  "vigenteDesde": "2026-10-12"
}'

GET/api/rh/funcionarios/{id}/habilitacoes#

As habilitações académicas e a formação profissional da ficha.

Permissão RH.FuncionariosLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/funcionarios/<id>/habilitacoes' \
  -H 'X-Api-Key: <a-sua-chave>'

PUT/api/rh/funcionarios/{id}/habilitacoes#

Define as habilitações académicas e a formação profissional da ficha.

Permissão RH.FuncionariosEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Substitui a lista inteira.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · DefinirHabilitacoesRequest)

Campo	Tipo	Obrigatório	Significado
`academicas`	lista de objectos ou nulo
`academicas[].nivel`	uma de: «EnsinoPrimario», «PrimeiroCicloSecundario», «SegundoCicloSecundario», «EnsinoMedioTecnico», «Bacharelato», «Licenciatura», «PosGraduacao», «Mestrado», «Doutoramento», «Outro»	sim
`academicas[].curso`	texto ou nulo
`academicas[].instituicao`	texto ou nulo
`academicas[].pais`	texto ou nulo
`academicas[].anoConclusao`	número inteiro ou nulo
`academicas[].emCurso`	verdadeiro/falso	sim
`academicas[].numeroDiploma`	texto ou nulo
`academicas[].observacao`	texto ou nulo		O texto livre.
`formacoes`	lista de objectos ou nulo
`formacoes[].titulo`	texto	sim
`formacoes[].entidade`	texto ou nulo
`formacoes[].dataConclusao`	data (AAAA-MM-DD)	sim
`formacoes[].validoAte`	data (AAAA-MM-DD) ou nulo
`formacoes[].cargaHoraria`	número inteiro ou nulo
`formacoes[].numeroCertificado`	texto ou nulo
`formacoes[].observacao`	texto ou nulo		O texto livre.

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/funcionarios/<id>/habilitacoes' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET/api/rh/funcionarios/{id}/situacao-fiscal#

A situação fiscal e contributiva da ficha (isento de IRT, não sujeito à Segurança Social…), com a fonte legal e o histórico.

Permissão RH.RemuneracoesLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/funcionarios/<id>/situacao-fiscal' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/funcionarios/{id}/situacao-fiscal#

Regista uma situação fiscal ou contributiva na ficha.

Permissão RH.RemuneracoesEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · DefinirSituacaoFiscalRequest)

Campo	Tipo	Obrigatório
`isentoIrt`	verdadeiro/falso	sim
`fonteIrt`	texto ou nulo
`naoSujeitoSegurancaSocial`	verdadeiro/falso	sim
`fonteSegurancaSocial`	texto ou nulo
`vigenteDesde`	data (AAAA-MM-DD)	sim
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/funcionarios/<id>/situacao-fiscal' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "isentoIrt": false,
  "naoSujeitoSegurancaSocial": false,
  "vigenteDesde": "2026-10-12"
}'

GET/api/rh/funcionarios/{id}/recibos#

Os recibos de vencimento de um trabalhador.

Permissão RH.FolhaLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/funcionarios/<id>/recibos' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/componentes/{id}/encerrar#

Encerra um componente remuneratório: deixa de contar a partir da data indicada.

Permissão RH.RemuneracoesEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · EncerrarComponenteRequest)

Campo	Tipo	Obrigatório
`ate`	data (AAAA-MM-DD)	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/componentes/<id>/encerrar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "ate": "2026-10-12"
}'

GET/api/rh/remuneracoes/trabalhadores#

Os trabalhadores para escolher nos ecrãs de remunerações (só nomes, sem salários).

Permissão RH.RemuneracoesLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/remuneracoes/trabalhadores' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/configuracao#

A configuração de recursos humanos da empresa: as respostas às perguntas que condicionam os cálculos.

Permissão RH.ConfiguracaoLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/configuracao' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/configuracao/historico#

O histórico das alterações à configuração de recursos humanos.

Permissão RH.ConfiguracaoLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/configuracao/historico' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/configuracao/aceitar-padroes#

Aceita de uma vez todas as respostas padrão (e as por confirmar), com o nome de quem as validou.

Permissão RH.ConfiguracaoEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Corpo do pedido (JSON · AceitarPadroesRequest)

Campo	Tipo	Obrigatório
`validadoPor`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/configuracao/aceitar-padroes' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

PUT/api/rh/configuracao/{pergunta}#

Define a resposta a uma pergunta da configuração de recursos humanos.

Permissão RH.ConfiguracaoEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`pergunta`	no caminho	uma de: «PorteEmpresa», «SemanaDeTrabalho», «ContagemDosDiasDeFerias», «AcordoColectivoTrabalho», «ProporcaoDoMesIncompleto», «CalculoDoValorHora», «InssDedutivelParaIrt», «BaseDosDescontosProgramados», «CanalDeDenuncias»	sim

Corpo do pedido (JSON · RespostaRhRequest)

Campo	Tipo	Obrigatório	Significado
`valor`	texto	sim	O valor.
`confirmada`	verdadeiro/falso	sim
`validadoPor`	texto ou nulo

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/configuracao/<pergunta>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "valor": "texto",
  "confirmada": false
}'

GET/api/rh/calendario#

O calendário de recursos humanos: os feriados da empresa.

Permissão RH.ConfiguracaoLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`ano`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/calendario' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/calendario/feriados#

Regista um feriado ou uma tolerância no calendário da empresa.

Permissão RH.ConfiguracaoEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id.

Corpo do pedido (JSON · FeriadoRequest)

Campo	Tipo	Obrigatório	Significado
`data`	data (AAAA-MM-DD)	sim	A data e hora (UTC).
`nome`	texto	sim	O nome.
`tipo`	uma de: «Nacional», «Municipal», «Empresa», «Tolerancia»	sim
`fonte`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/calendario/feriados' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "data": "2026-10-12",
  "nome": "texto",
  "tipo": "Nacional"
}'

GET/api/rh/calendario/feriados-nacionais#

Os feriados nacionais da lei (e as pontes) propostos para um ano.

Permissão RH.ConfiguracaoLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`ano`	na pesquisa	número inteiro
`pontes`	na pesquisa	verdadeiro/falso

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/calendario/feriados-nacionais' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/calendario/feriados-nacionais#

Carrega os feriados nacionais propostos no calendário da empresa.

Permissão RH.ConfiguracaoEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Nunca se sobrepõe ao que a empresa já registou.

Corpo do pedido (JSON · CarregarFeriadosNacionaisRequest)

Campo	Tipo	Obrigatório
`ano`	número inteiro	sim
`pontes`	verdadeiro/falso	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/calendario/feriados-nacionais' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "ano": 1,
  "pontes": false
}'

PUT/api/rh/calendario/feriados/{id}#

Altera um feriado do calendário da empresa.

Permissão RH.ConfiguracaoEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · FeriadoRequest)

Campo	Tipo	Obrigatório	Significado
`data`	data (AAAA-MM-DD)	sim	A data e hora (UTC).
`nome`	texto	sim	O nome.
`tipo`	uma de: «Nacional», «Municipal», «Empresa», «Tolerancia»	sim
`fonte`	texto ou nulo

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/calendario/feriados/<id>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "data": "2026-10-12",
  "nome": "texto",
  "tipo": "Nacional"
}'

DELETE/api/rh/calendario/feriados/{id}#

Remove um feriado do calendário da empresa.

Permissão RH.ConfiguracaoEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl -X DELETE 'https://<endereço-da-API>/api/rh/calendario/feriados/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/parametros-legais#

Os parâmetros legais em vigor que os cálculos de recursos humanos usam (só leitura).

Permissão RH.ParametrosLegaisLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/parametros-legais' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/ausencias#

Lista as ausências dos trabalhadores.

Permissão RH.AssiduidadeLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo
`funcionarioId`	na pesquisa	identificador (UUID)
`tipo`	na pesquisa	uma de: «FaltaJustificada», «FaltaInjustificada», «Doenca», «Maternidade», «Paternidade», «Casamento», «Luto», «LicencaSemVencimento», «AcidenteDeTrabalho», «TrabalhadorEstudante», «Outra», «null»
`estado`	na pesquisa	uma de: «Pendente», «Aprovado», «Rejeitado», «Anulado», «null»
`de`	na pesquisa	data (AAAA-MM-DD)
`ate`	na pesquisa	data (AAAA-MM-DD)
`cursor`	na pesquisa	texto
`tamanho`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/ausencias' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/ausencias#

Regista uma ausência.

Permissão RH.AssiduidadeEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id. Fica por aprovar.

Corpo do pedido (JSON · RegistarAusenciaCommand)

Campo	Tipo	Obrigatório	Significado
`funcionarioId`	identificador (UUID)	sim
`tipo`	uma de: «FaltaJustificada», «FaltaInjustificada», «Doenca», «Maternidade», «Paternidade», «Casamento», «Luto», «LicencaSemVencimento», «AcidenteDeTrabalho», «TrabalhadorEstudante», «Outra», «null»	sim
`dataInicio`	data (AAAA-MM-DD)	sim
`dataFim`	data (AAAA-MM-DD)	sim
`horas`	número ou nulo
`justificativo`	texto ou nulo
`observacao`	texto ou nulo		O texto livre.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/ausencias' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "funcionarioId": "00000000-0000-0000-0000-000000000000",
  "tipo": "FaltaJustificada",
  "dataInicio": "2026-10-12",
  "dataFim": "2026-10-12"
}'

POST/api/rh/ausencias/{id}/aprovar#

Aprova uma ausência.

Permissão RH.AssiduidadeAprovar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · AprovarAusenciaRequest)

Campo	Tipo	Obrigatório
`efeito`	uma de: «SemDesconto», «DescontoDoSalario», «PagoPelaSegurancaSocial»	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/ausencias/<id>/aprovar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "efeito": "SemDesconto"
}'

POST/api/rh/ausencias/{id}/rejeitar#

Rejeita uma ausência.

Permissão RH.AssiduidadeAprovar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/ausencias/<id>/rejeitar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST/api/rh/ausencias/{id}/anular#

Anula uma ausência.

Permissão RH.AssiduidadeAprovar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/ausencias/<id>/anular' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET/api/rh/ferias/saldos#

Os saldos de férias dos trabalhadores.

Permissão RH.AssiduidadeLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`ano`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/ferias/saldos' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/ferias/funcionarios/{funcionarioId}#

As férias de um trabalhador: direitos, saldo e marcações.

Permissão RH.AssiduidadeLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`funcionarioId`	no caminho	identificador (UUID)	sim
`ano`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/ferias/funcionarios/<funcionarioId>' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/ferias/direitos#

Regista um movimento do direito a férias de um trabalhador num ano (o direito do ano, dias por acordo ou um ajuste).

Permissão RH.AssiduidadeEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Só se acrescenta; nunca se edita.

Corpo do pedido (JSON · RegistarDireitoFeriasCommand)

Campo	Tipo	Obrigatório
`funcionarioId`	identificador (UUID)	sim
`ano`	número inteiro	sim
`origem`	uma de: «DireitoDoAno», «Acordo», «Ajuste»	sim
`dias`	número	sim
`motivo`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/ferias/direitos' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "funcionarioId": "00000000-0000-0000-0000-000000000000",
  "ano": 1,
  "origem": "DireitoDoAno",
  "dias": 0,
  "motivo": "texto"
}'

GET/api/rh/ferias/marcacoes#

Lista as marcações de férias.

Permissão RH.AssiduidadeLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo
`funcionarioId`	na pesquisa	identificador (UUID)
`ano`	na pesquisa	número inteiro
`estado`	na pesquisa	uma de: «Pendente», «Aprovado», «Rejeitado», «Anulado», «null»
`cursor`	na pesquisa	texto
`tamanho`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/ferias/marcacoes' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/ferias/marcacoes#

Marca férias de um trabalhador.

Permissão RH.AssiduidadeEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id. Fica por aprovar.

Corpo do pedido (JSON · MarcarFeriasCommand)

Campo	Tipo	Obrigatório	Significado
`funcionarioId`	identificador (UUID)	sim
`ano`	número inteiro	sim
`dataInicio`	data (AAAA-MM-DD)	sim
`dataFim`	data (AAAA-MM-DD)	sim
`observacao`	texto ou nulo		O texto livre.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/ferias/marcacoes' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "funcionarioId": "00000000-0000-0000-0000-000000000000",
  "ano": 1,
  "dataInicio": "2026-10-12",
  "dataFim": "2026-10-12"
}'

POST/api/rh/ferias/marcacoes/{id}/aprovar#

Aprova uma marcação de férias.

Permissão RH.AssiduidadeAprovar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/ferias/marcacoes/<id>/aprovar' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/ferias/marcacoes/{id}/rejeitar#

Rejeita uma marcação de férias.

Permissão RH.AssiduidadeAprovar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/ferias/marcacoes/<id>/rejeitar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST/api/rh/ferias/marcacoes/{id}/anular#

Anula uma marcação de férias.

Permissão RH.AssiduidadeAprovar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/ferias/marcacoes/<id>/anular' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET/api/rh/trabalho-suplementar#

Lista o trabalho suplementar (horas extra).

Permissão RH.AssiduidadeLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo
`funcionarioId`	na pesquisa	identificador (UUID)
`estado`	na pesquisa	uma de: «Pendente», «Aprovado», «Rejeitado», «Anulado», «null»
`de`	na pesquisa	data (AAAA-MM-DD)
`ate`	na pesquisa	data (AAAA-MM-DD)
`cursor`	na pesquisa	texto
`tamanho`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/trabalho-suplementar' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/trabalho-suplementar/resumo#

O resumo do trabalho suplementar.

Permissão RH.AssiduidadeLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`funcionarioId`	na pesquisa	identificador (UUID)	sim
`ano`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/trabalho-suplementar/resumo' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/trabalho-suplementar#

Regista trabalho suplementar de um trabalhador.

Permissão RH.AssiduidadeEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id. Fica por aprovar.

Corpo do pedido (JSON · RegistarTrabalhoSuplementarCommand)

Campo	Tipo	Obrigatório	Significado
`funcionarioId`	identificador (UUID)	sim
`data`	data (AAAA-MM-DD)	sim	A data e hora (UTC).
`horas`	número	sim
`horasNocturnas`	número	sim
`motivo`	texto	sim
`observacao`	texto ou nulo		O texto livre.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/trabalho-suplementar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "funcionarioId": "00000000-0000-0000-0000-000000000000",
  "data": "2026-10-12",
  "horas": 0,
  "horasNocturnas": 0,
  "motivo": "texto"
}'

POST/api/rh/trabalho-suplementar/{id}/aprovar#

Aprova trabalho suplementar.

Permissão RH.AssiduidadeAprovar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/trabalho-suplementar/<id>/aprovar' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/trabalho-suplementar/{id}/rejeitar#

Rejeita trabalho suplementar.

Permissão RH.AssiduidadeAprovar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/trabalho-suplementar/<id>/rejeitar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST/api/rh/trabalho-suplementar/{id}/anular#

Anula trabalho suplementar.

Permissão RH.AssiduidadeAprovar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/trabalho-suplementar/<id>/anular' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET/api/rh/assiduidade/trabalhadores#

Os trabalhadores para escolher nos ecrãs de assiduidade (só nomes).

Permissão RH.AssiduidadeLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/assiduidade/trabalhadores' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/assiduidade/calendario#

O calendário de assiduidade: as ausências, as férias e os feriados de um período.

Permissão RH.AssiduidadeLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`ano`	na pesquisa	número inteiro
`mes`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/assiduidade/calendario' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/ponto/equipamentos#

Os equipamentos de ponto (relógios) da empresa.

Permissão RH.PontoLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/ponto/equipamentos' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/ponto/equipamentos#

Regista um equipamento de ponto.

Permissão RH.PontoEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id.

Corpo do pedido (JSON · EquipamentoPontoRequest)

Campo	Tipo	Obrigatório	Significado
`nome`	texto	sim	O nome.
`marca`	uma de: «Hikvision», «ZKTeco», «Outro»	sim
`modelo`	texto ou nulo
`numeroSerie`	texto ou nulo
`lojaId`	identificador (UUID) ou nulo		O estabelecimento.
`observacao`	texto ou nulo		O texto livre.
`activo`	verdadeiro/falso ou nulo		Se está activo.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/ponto/equipamentos' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "nome": "texto",
  "marca": "Hikvision"
}'

PUT/api/rh/ponto/equipamentos/{id}#

Altera um equipamento de ponto.

Permissão RH.PontoEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · EquipamentoPontoRequest)

Campo	Tipo	Obrigatório	Significado
`nome`	texto	sim	O nome.
`marca`	uma de: «Hikvision», «ZKTeco», «Outro»	sim
`modelo`	texto ou nulo
`numeroSerie`	texto ou nulo
`lojaId`	identificador (UUID) ou nulo		O estabelecimento.
`observacao`	texto ou nulo		O texto livre.
`activo`	verdadeiro/falso ou nulo		Se está activo.

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/ponto/equipamentos/<id>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "nome": "texto",
  "marca": "Hikvision"
}'

GET/api/rh/ponto/codigos#

Os códigos dos trabalhadores nos equipamentos de ponto.

Permissão RH.PontoLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/ponto/codigos' \
  -H 'X-Api-Key: <a-sua-chave>'

PUT/api/rh/ponto/codigos/{funcionarioId}#

Define o código de um trabalhador nos equipamentos de ponto.

Permissão RH.PontoEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`funcionarioId`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · CodigoPontoRequest)

Campo	Tipo	Obrigatório	Significado
`codigo`	texto ou nulo		O código curto.

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/ponto/codigos/<funcionarioId>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET/api/rh/ponto/marcacoes#

As marcações de ponto de um período.

Permissão RH.PontoLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`de`	na pesquisa	data (AAAA-MM-DD)	sim
`ate`	na pesquisa	data (AAAA-MM-DD)	sim
`funcionarioId`	na pesquisa	identificador (UUID)
`apenasSemTrabalhador`	na pesquisa	verdadeiro/falso

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/ponto/marcacoes' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/ponto/marcacoes#

Regista à mão uma marcação de ponto (esquecimento do trabalhador, equipamento avariado).

Permissão RH.PontoEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Exige o motivo e fica identificada como manual, com quem a registou. As marcações dos equipamentos entram pela importação do ficheiro.

Corpo do pedido (JSON · MarcacaoManualRequest)

Campo	Tipo	Obrigatório
`funcionarioId`	identificador (UUID)	sim
`dataHoraLocal`	data e hora (ISO 8601)	sim
`tipo`	uma de: «Desconhecido», «Entrada», «Saida»	sim
`motivo`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/ponto/marcacoes' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "funcionarioId": "00000000-0000-0000-0000-000000000000",
  "dataHoraLocal": "2026-10-12T09:00:00Z",
  "tipo": "Desconhecido",
  "motivo": "texto"
}'

POST/api/rh/ponto/importacoes/pre-visualizar#

Pré-visualiza a importação de um ficheiro extraído de um equipamento de ponto: não grava nada.

Permissão RH.PontoImportar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

O corpo é um formulário multipart/form-data com o ficheiro e as opções (as colunas, quando indicadas, contam-se a partir de 1).

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/ponto/importacoes/pre-visualizar' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/ponto/importacoes#

Importa um ficheiro extraído de um equipamento de ponto: acrescenta as marcações novas.

Permissão RH.PontoImportar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Com o mesmo ficheiro e as mesmas opções da pré-visualização. As marcações que já existem (mesmo código, mesmo instante) ignoram-se, por isso importar duas vezes o mesmo ficheiro é inofensivo. O corpo é um formulário multipart/form-data.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/ponto/importacoes' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/ponto/folha/{funcionarioId}#

A folha de ponto de um trabalhador num período.

Permissão RH.PontoLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`funcionarioId`	no caminho	identificador (UUID)	sim
`ano`	na pesquisa	número inteiro	sim
`mes`	na pesquisa	número inteiro	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/ponto/folha/<funcionarioId>' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/rubricas#

As rubricas de remuneração e de desconto.

Permissão RH.ConfiguracaoLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`incluirInactivas`	na pesquisa	verdadeiro/falso

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/rubricas' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/rubricas/para-lancamento#

As rubricas que se podem usar num lançamento variável.

Permissão RH.RemuneracoesLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/rubricas/para-lancamento' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/rubricas#

Cria uma rubrica.

Permissão RH.ConfiguracaoEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id.

Corpo do pedido (JSON · DadosRubrica)

Campo	Tipo	Obrigatório	Significado
`codigo`	texto	sim	O código curto.
`nome`	texto	sim	O nome.
`natureza`	uma de: «Provento», «Desconto»	sim
`calculo`	uma de: «ValorFixo», «PorUnidade»	sim
`unidade`	texto ou nulo
`sujeitaIrt`	verdadeiro/falso	sim
`sujeitaInss`	verdadeiro/falso	sim
`limiteIsencao`	uma de: «Nenhum», «SubsidioAlimentacao», «SubsidioTransporte»	sim
`baseLegal`	texto ou nulo
`categoriaMapa`	uma de: «SubsidioAlimentacao», «SubsidioTransporte», «AbonoFamilia», «ReembolsoDespesas», «OutrosNaoSujeitos», «AbonoFalhas», «SubsidioRendaCasa», «CompensacaoRescisao», «SubsidioFerias», «HorasExtras», «SubsidioAtavio», «SubsidioRepresentacao», «Premios», «SubsidioNatal», «OutrosSujeitos», «null» ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/rubricas' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "codigo": "texto",
  "nome": "texto",
  "natureza": "Provento",
  "calculo": "ValorFixo",
  "sujeitaIrt": false,
  "sujeitaInss": false,
  "limiteIsencao": "Nenhum"
}'

PUT/api/rh/rubricas/{id}#

Altera uma rubrica.

Permissão RH.ConfiguracaoEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · DadosRubrica)

Campo	Tipo	Obrigatório	Significado
`codigo`	texto	sim	O código curto.
`nome`	texto	sim	O nome.
`natureza`	uma de: «Provento», «Desconto»	sim
`calculo`	uma de: «ValorFixo», «PorUnidade»	sim
`unidade`	texto ou nulo
`sujeitaIrt`	verdadeiro/falso	sim
`sujeitaInss`	verdadeiro/falso	sim
`limiteIsencao`	uma de: «Nenhum», «SubsidioAlimentacao», «SubsidioTransporte»	sim
`baseLegal`	texto ou nulo
`categoriaMapa`	uma de: «SubsidioAlimentacao», «SubsidioTransporte», «AbonoFamilia», «ReembolsoDespesas», «OutrosNaoSujeitos», «AbonoFalhas», «SubsidioRendaCasa», «CompensacaoRescisao», «SubsidioFerias», «HorasExtras», «SubsidioAtavio», «SubsidioRepresentacao», «Premios», «SubsidioNatal», «OutrosSujeitos», «null» ou nulo

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/rubricas/<id>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "codigo": "texto",
  "nome": "texto",
  "natureza": "Provento",
  "calculo": "ValorFixo",
  "sujeitaIrt": false,
  "sujeitaInss": false,
  "limiteIsencao": "Nenhum"
}'

PUT/api/rh/rubricas/{id}/activa#

Activa ou desactiva uma rubrica.

Permissão RH.ConfiguracaoEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · ActivaRubricaRequest)

Campo	Tipo	Obrigatório
`activa`	verdadeiro/falso	sim

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/rubricas/<id>/activa' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "activa": false
}'

GET/api/rh/subsidios-extraordinarios#

A proposta dos subsídios de férias e de Natal de um mês.

Permissão RH.RemuneracoesLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`tipo`	na pesquisa	uma de: «Natal», «Ferias»	sim
`modo`	na pesquisa	uma de: «Integral», «Duodecimos»	sim
`competencia`	na pesquisa	data (AAAA-MM-DD)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/subsidios-extraordinarios' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/subsidios-extraordinarios/gerar#

Gera os lançamentos dos subsídios de férias e de Natal de um mês, por aprovar.

Permissão RH.RemuneracoesEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Corpo do pedido (JSON · GerarSubsidiosExtraordinariosRequest)

Campo	Tipo	Obrigatório
`tipo`	uma de: «Natal», «Ferias»	sim
`modo`	uma de: «Integral», «Duodecimos»	sim
`competencia`	data (AAAA-MM-DD)	sim
`rubricaId`	identificador (UUID)	sim
`funcionarioIds`	lista de identificador (UUID) ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/subsidios-extraordinarios/gerar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "tipo": "Natal",
  "modo": "Integral",
  "competencia": "2026-10-12",
  "rubricaId": "00000000-0000-0000-0000-000000000000"
}'

GET/api/rh/lancamentos#

Lista os lançamentos variáveis (prémios, comissões, faltas descontadas…).

Permissão RH.RemuneracoesLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo
`funcionarioId`	na pesquisa	identificador (UUID)
`rubricaId`	na pesquisa	identificador (UUID)
`competencia`	na pesquisa	data (AAAA-MM-DD)
`estado`	na pesquisa	uma de: «Pendente», «Aprovado», «Rejeitado», «Anulado», «null»
`cursor`	na pesquisa	texto
`tamanho`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/lancamentos' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/lancamentos#

Regista um lançamento variável.

Permissão RH.RemuneracoesEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id. Fica por aprovar.

Corpo do pedido (JSON · RegistarLancamentoVariavelCommand)

Campo	Tipo	Obrigatório	Significado
`funcionarioId`	identificador (UUID)	sim
`rubricaId`	identificador (UUID)	sim
`competencia`	data (AAAA-MM-DD)	sim
`quantidade`	número	sim	A quantidade.
`valorUnitario`	número ou nulo
`descricao`	texto ou nulo		A descrição.
`observacao`	texto ou nulo		O texto livre.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/lancamentos' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "funcionarioId": "00000000-0000-0000-0000-000000000000",
  "rubricaId": "00000000-0000-0000-0000-000000000000",
  "competencia": "2026-10-12",
  "quantidade": 0
}'

POST/api/rh/lancamentos/{id}/aprovar#

Aprova um lançamento variável.

Permissão RH.RemuneracoesAprovar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/lancamentos/<id>/aprovar' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/lancamentos/{id}/rejeitar#

Rejeita um lançamento variável.

Permissão RH.RemuneracoesAprovar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/lancamentos/<id>/rejeitar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST/api/rh/lancamentos/{id}/anular#

Anula um lançamento variável.

Permissão RH.RemuneracoesAprovar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/lancamentos/<id>/anular' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET/api/rh/descontos#

Lista os descontos programados (empréstimos, adiantamentos…).

Permissão RH.RemuneracoesLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo
`funcionarioId`	na pesquisa	identificador (UUID)
`tipo`	na pesquisa	uma de: «Adiantamento», «Emprestimo», «Penhora», «Outro», «null»
`estado`	na pesquisa	uma de: «Pendente», «Aprovado», «Rejeitado», «Anulado», «null»
`cursor`	na pesquisa	texto
`tamanho`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/descontos' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/descontos/{id}#

Um desconto programado, com os movimentos e os eventos.

Permissão RH.RemuneracoesLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/descontos/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/descontos#

Cria um desconto programado.

Permissão RH.RemuneracoesEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id. Fica por aprovar.

Corpo do pedido (JSON · RegistarDescontoProgramadoCommand)

Campo	Tipo	Obrigatório	Significado
`funcionarioId`	identificador (UUID)	sim
`tipo`	uma de: «Adiantamento», «Emprestimo», «Penhora», «Outro», «null»	sim
`descricao`	texto	sim	A descrição.
`valorTotal`	número	sim
`modo`	uma de: «PrestacoesFixas», «PercentagemDoSalario»	sim
`numeroPrestacoes`	número inteiro ou nulo
`percentagem`	número ou nulo
`primeiroMes`	data (AAAA-MM-DD)	sim
`dataConcessao`	data (AAAA-MM-DD) ou nulo
`entidade`	texto ou nulo
`referencia`	texto ou nulo
`observacao`	texto ou nulo		O texto livre.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/descontos' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "funcionarioId": "00000000-0000-0000-0000-000000000000",
  "tipo": "Adiantamento",
  "descricao": "texto",
  "valorTotal": 0,
  "modo": "PrestacoesFixas",
  "primeiroMes": "2026-10-12"
}'

POST/api/rh/descontos/{id}/aprovar#

Aprova um desconto programado.

Permissão RH.RemuneracoesAprovar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/descontos/<id>/aprovar' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/descontos/{id}/rejeitar#

Rejeita um desconto programado.

Permissão RH.RemuneracoesAprovar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/descontos/<id>/rejeitar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST/api/rh/descontos/{id}/anular#

Anula um desconto programado.

Permissão RH.RemuneracoesAprovar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/descontos/<id>/anular' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST/api/rh/descontos/{id}/movimentos#

Regista um movimento manual no saldo de um desconto aprovado: um abatimento (o trabalhador pagou por outra via) ou um estorno.

Permissão RH.RemuneracoesEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MovimentoDescontoRequest)

Campo	Tipo	Obrigatório	Significado
`tipo`	uma de: «Folha», «AbatimentoManual», «Estorno»	sim
`valor`	número	sim	O valor.
`data`	data (AAAA-MM-DD)	sim	A data e hora (UTC).
`motivo`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/descontos/<id>/movimentos' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "tipo": "Folha",
  "valor": 0,
  "data": "2026-10-12",
  "motivo": "texto"
}'

POST/api/rh/descontos/{id}/eventos#

Suspende ou retoma um desconto aprovado a partir de um mês (por exemplo, por ordem do tribunal).

Permissão RH.RemuneracoesEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Só se suspende o que está activo e só se retoma o que está suspenso.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · EventoDescontoRequest)

Campo	Tipo	Obrigatório
`tipo`	uma de: «Suspensao», «Retoma»	sim
`aPartirDe`	data (AAAA-MM-DD)	sim
`motivo`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/descontos/<id>/eventos' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "tipo": "Suspensao",
  "aPartirDe": "2026-10-12",
  "motivo": "texto"
}'

GET/api/rh/diuturnidades/rubricas#

As rubricas que se podem usar nas diuturnidades.

Permissão RH.AcordosEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/diuturnidades/rubricas' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/diuturnidades/regras#

As regras de diuturnidades da empresa.

Permissão RH.AcordosLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/diuturnidades/regras' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/diuturnidades#

As diuturnidades dos trabalhadores.

Permissão RH.AcordosLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`referencia`	na pesquisa	data (AAAA-MM-DD)

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/diuturnidades' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/diuturnidades/regras#

Cria uma regra de diuturnidades.

Permissão RH.AcordosEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Corpo do pedido (JSON · CriarRegraDiuturnidadeCommand)

Campo	Tipo	Obrigatório	Significado
`acordoId`	identificador (UUID) ou nulo
`rubricaId`	identificador (UUID)	sim
`anosPorDiuturnidade`	número inteiro	sim
`modo`	uma de: «Fixo», «PercentagemDoSalarioBase»	sim
`valor`	número	sim	O valor.
`maximo`	número inteiro ou nulo
`vigenteDesde`	data (AAAA-MM-DD)	sim
`fonte`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/diuturnidades/regras' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "rubricaId": "00000000-0000-0000-0000-000000000000",
  "anosPorDiuturnidade": 1,
  "modo": "Fixo",
  "valor": 0,
  "vigenteDesde": "2026-10-12",
  "fonte": "texto"
}'

POST/api/rh/diuturnidades/regras/{id}/anular#

Anula uma regra de diuturnidades.

Permissão RH.AcordosEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/diuturnidades/regras/<id>/anular' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST/api/rh/diuturnidades/aplicar#

Aplica as regras de diuturnidades aos trabalhadores.

Permissão RH.RemuneracoesEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Corpo do pedido (JSON · AplicarDiuturnidadeRequest)

Campo	Tipo	Obrigatório
`funcionarioId`	identificador (UUID)	sim
`regraId`	identificador (UUID)	sim
`desde`	data (AAAA-MM-DD)	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/diuturnidades/aplicar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "funcionarioId": "00000000-0000-0000-0000-000000000000",
  "regraId": "00000000-0000-0000-0000-000000000000",
  "desde": "2026-10-12"
}'

GET/api/rh/folhas#

Lista as folhas de salários.

Permissão RH.FolhaLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`ano`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/folhas' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/folhas/{id}#

Uma folha de salários, com os recibos.

Permissão RH.FolhaLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/folhas/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/folhas/{id}/recibos/{reciboId}#

Um recibo de vencimento de uma folha.

Permissão RH.FolhaLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim
`reciboId`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/folhas/<id>/recibos/<reciboId>' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/folhas/{id}/pdf#

A folha inteira em PDF.

Permissão RH.FolhaLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

É o que ficou guardado na folha, nunca recalculado. Pesado: conta como pedido pesado.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Resposta

Devolve 200 com o ficheiro PDF (application/pdf).

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/folhas/<id>/pdf' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/folhas/{id}/recibos/{reciboId}/pdf#

Um recibo de vencimento em PDF.

Permissão RH.FolhaLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

É o que ficou guardado na folha, nunca recalculado.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim
`reciboId`	no caminho	identificador (UUID)	sim

Resposta

Devolve 200 com o ficheiro PDF (application/pdf).

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/folhas/<id>/recibos/<reciboId>/pdf' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/folhas/{id}/mapa-pagamento#

O mapa de pagamento de uma folha aprovada: quanto pagar a cada trabalhador.

Permissão RH.FolhaExportar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

É um mapa interno: não é o ficheiro oficial do banco.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/folhas/<id>/mapa-pagamento' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/folhas/{id}/mapa-pagamento/csv#

O mapa de pagamento de uma folha aprovada, em CSV.

Permissão RH.FolhaExportar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Resposta

Devolve 200 com o ficheiro CSV (text/csv).

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/folhas/<id>/mapa-pagamento/csv' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/folhas/{id}/mapa-retencoes#

O mapa de retenções de uma folha aprovada: o IRT e a Segurança Social retidos.

Permissão RH.FolhaExportar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

É um mapa interno: não é o ficheiro oficial do INSS nem da AGT.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/folhas/<id>/mapa-retencoes' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/folhas/{id}/mapa-retencoes/csv#

O mapa de retenções de uma folha aprovada, em CSV.

Permissão RH.FolhaExportar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Resposta

Devolve 200 com o ficheiro CSV (text/csv).

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/folhas/<id>/mapa-retencoes/csv' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/folhas/{id}/mapa-remuneracoes-agt#

O Mapa de Remunerações da AGT de uma folha aprovada: a pré-visualização, com avisos.

Permissão RH.FolhaExportar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Quem o submete no Portal do Contribuinte é a empresa.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim
`formato`	na pesquisa	uma de: «Simplificado», «Detalhado»	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/folhas/<id>/mapa-remuneracoes-agt' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/folhas/{id}/mapa-remuneracoes-agt/xlsx#

O Mapa de Remunerações da AGT de uma folha aprovada, no modelo Excel oficial.

Permissão RH.FolhaExportar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim
`formato`	na pesquisa	uma de: «Simplificado», «Detalhado»	sim

Resposta

Devolve 200 com o ficheiro Excel (.xlsx).

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/folhas/<id>/mapa-remuneracoes-agt/xlsx' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/folhas/trabalhadores#

Os trabalhadores que a folha de um mês pode incluir (só nomes, sem salários).

Permissão RH.FolhaProcessar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`competencia`	na pesquisa	data (AAAA-MM-DD)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/folhas/trabalhadores' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/folhas#

Calcula a folha de salários de um mês: um recibo por trabalhador com relação laboral nesse mês.

Permissão RH.FolhaProcessar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Fica em rascunho. Se já houver um rascunho desse mês, é substituído; se a folha desse mês já está aprovada, recusa-se. Devolve o id.

Corpo do pedido (JSON · ProcessarFolhaRequest)

Campo	Tipo	Obrigatório
`competencia`	data (AAAA-MM-DD)	sim
`funcionarioIds`	lista de identificador (UUID) ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/folhas' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "competencia": "2026-10-12"
}'

DELETE/api/rh/folhas/{id}#

Descarta uma folha em rascunho.

Permissão RH.FolhaProcessar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Uma folha aprovada nunca se apaga: anula-se.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl -X DELETE 'https://<endereço-da-API>/api/rh/folhas/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/folhas/{id}/aprovar#

Aprova uma folha de salários.

Permissão RH.FolhaAprovar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

A folha é conferida de novo contra o que está registado (se algo mudou desde o processamento, recusa-se e pede para a processar outra vez). A aprovação lança os descontos programados e as contas a pagar da folha.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · AprovarFolhaRequest)

Campo	Tipo	Obrigatório	Significado
`lojaId`	identificador (UUID) ou nulo		O estabelecimento.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/folhas/<id>/aprovar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST/api/rh/folhas/{id}/anular#

Anula uma folha de salários aprovada, com o motivo.

Permissão RH.FolhaAprovar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Anula as contas a pagar da folha e estorna os descontos programados. Recusa-se se alguma das contas já tiver pagamentos: estorne-os primeiro.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/folhas/<id>/anular' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET/api/rh/cessacoes/trabalhadores#

Os trabalhadores para escolher nos ecrãs de cessação.

Permissão RH.CessacaoEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/cessacoes/trabalhadores' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/cessacoes#

Lista as cessações e os acertos de contas.

Permissão RH.CessacaoLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`estado`	na pesquisa	uma de: «Rascunho», «Aprovada», «null»
`funcionarioId`	na pesquisa	identificador (UUID)

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/cessacoes' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/cessacoes/{id}#

Uma cessação, com o acerto de contas.

Permissão RH.CessacaoLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Mostra remunerações: precisa também da permissão de ler remunerações do perfil da chave, e a consulta fica na auditoria de acessos do módulo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/cessacoes/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/cessacoes#

Inicia o processo de cessação de um trabalhador e calcula as sugestões do acerto de contas.

Permissão RH.CessacaoEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Fica em rascunho: o trabalhador só cessa quando se aprovar. Nunca se sugerem valores da lei sem parâmetro. Devolve o id.

Corpo do pedido (JSON · RegistarCessacaoCommand)

Campo	Tipo	Obrigatório	Significado
`funcionarioId`	identificador (UUID)	sim
`dataCessacao`	data (AAAA-MM-DD)	sim
`motivo`	uma de: «AcordoMutuo», «CaducidadeDoContrato», «DespedimentoPorJustaCausa», «DespedimentoPorExtincaoDoPosto», «DemissaoDoTrabalhador», «PeriodoExperimental», «Reforma», «Falecimento», «Outro»	sim
`observacao`	texto ou nulo		O texto livre.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/cessacoes' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "funcionarioId": "00000000-0000-0000-0000-000000000000",
  "dataCessacao": "2026-10-12",
  "motivo": "AcordoMutuo"
}'

PUT/api/rh/cessacoes/{id}/linhas#

Define as linhas do acerto de contas de uma cessação em rascunho.

Permissão RH.CessacaoEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

As sugeridas (incluir, excluir, mudar o valor com justificação) e as acrescentadas à mão, com a fonte legal.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · ActualizarLinhasCessacaoRequest)

Campo	Tipo	Obrigatório	Significado
`linhas`	lista de objectos	sim
`linhas[].id`	identificador (UUID) ou nulo		Identificador único (UUID).
`linhas[].tipo`	uma de: «FeriasNaoGozadas», «SubsidioFeriasProporcional», «SubsidioNatalProporcional», «Indemnizacao», «SaldoDescontoProgramado», «Manual»	sim
`linhas[].natureza`	uma de: «Provento», «Desconto»	sim
`linhas[].descricao`	texto ou nulo		A descrição.
`linhas[].incluida`	verdadeiro/falso	sim
`linhas[].valor`	número	sim	O valor.
`linhas[].justificacao`	texto ou nulo
`linhas[].fonteLegal`	texto ou nulo

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/cessacoes/<id>/linhas' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "linhas": [
    {
      "tipo": "FeriasNaoGozadas",
      "natureza": "Provento",
      "incluida": false,
      "valor": 0
    }
  ]
}'

DELETE/api/rh/cessacoes/{id}#

Descarta uma cessação em rascunho.

Permissão RH.CessacaoEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Uma cessação aprovada não se descarta.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl -X DELETE 'https://<endereço-da-API>/api/rh/cessacoes/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/cessacoes/{id}/aprovar#

Aprova uma cessação e o seu acerto de contas.

Permissão RH.CessacaoAprovar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

É definitivo. O acerto é conferido de novo (se os dados mudaram, recusa-se); abate os saldos de descontos incluídos, lança a conta a pagar do líquido e cessa o trabalhador, fechando o contrato na data de cessação.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · AprovarFolhaRequest)

Campo	Tipo	Obrigatório	Significado
`lojaId`	identificador (UUID) ou nulo		O estabelecimento.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/cessacoes/<id>/aprovar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET/api/rh/disciplinar/trabalhadores#

Os trabalhadores para escolher nos ecrãs disciplinares.

Permissão RH.DisciplinarEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/disciplinar/trabalhadores' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/disciplinar#

Lista os processos disciplinares.

Permissão RH.DisciplinarLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`estado`	na pesquisa	uma de: «EmCurso», «Concluido», «Arquivado», «null»
`funcionarioId`	na pesquisa	identificador (UUID)

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/disciplinar' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/disciplinar/alertas#

Os alertas dos processos disciplinares (prazos a vencer).

Permissão RH.DisciplinarLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`dias`	na pesquisa	número inteiro
`referencia`	na pesquisa	data (AAAA-MM-DD)

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/disciplinar/alertas' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/disciplinar/{id}#

Um processo disciplinar, com as fases.

Permissão RH.DisciplinarLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/disciplinar/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/disciplinar#

Abre um processo disciplinar.

Permissão RH.DisciplinarEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id.

Corpo do pedido (JSON · AbrirProcessoDisciplinarCommand)

Campo	Tipo	Obrigatório	Significado
`funcionarioId`	identificador (UUID)	sim
`dataOcorrencia`	data (AAAA-MM-DD)	sim
`dataConhecimento`	data (AAAA-MM-DD)	sim
`descricao`	texto	sim	A descrição.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/disciplinar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "funcionarioId": "00000000-0000-0000-0000-000000000000",
  "dataOcorrencia": "2026-10-12",
  "dataConhecimento": "2026-10-12",
  "descricao": "texto"
}'

POST/api/rh/disciplinar/{id}/fases#

Regista uma fase de um processo disciplinar.

Permissão RH.DisciplinarEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · FaseDisciplinarRequest)

Campo	Tipo	Obrigatório	Significado
`tipo`	uma de: «Ocorrencia», «NotaDeCulpa», «ConvocatoriaAudicao», «AudicaoPrevia», «RespostaDoTrabalhador», «ParecerSindical», «RelatorioFinal», «Diligencia», «SancaoAplicada», «Arquivamento»	sim
`data`	data (AAAA-MM-DD)	sim	A data e hora (UTC).
`descricao`	texto	sim	A descrição.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/disciplinar/<id>/fases' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "tipo": "Ocorrencia",
  "data": "2026-10-12",
  "descricao": "texto"
}'

POST/api/rh/disciplinar/{id}/sancao#

Aplica uma sanção disciplinar.

Permissão RH.DisciplinarAprovar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · SancaoDisciplinarRequest)

Campo	Tipo	Obrigatório	Significado
`sancao`	uma de: «AdvertenciaVerbal», «CensuraEscrita», «Suspensao», «DespedimentoComJustaCausa»	sim
`data`	data (AAAA-MM-DD)	sim	A data e hora (UTC).
`descricao`	texto	sim	A descrição.
`diasSuspensao`	número inteiro ou nulo
`justificacaoForaDePrazo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/disciplinar/<id>/sancao' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "sancao": "AdvertenciaVerbal",
  "data": "2026-10-12",
  "descricao": "texto"
}'

POST/api/rh/disciplinar/{id}/arquivar#

Arquiva um processo disciplinar.

Permissão RH.DisciplinarAprovar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · ArquivarDisciplinarRequest)

Campo	Tipo	Obrigatório	Significado
`motivo`	uma de: «Caducidade», «Improcedencia», «Cancelamento»	sim
`data`	data (AAAA-MM-DD)	sim	A data e hora (UTC).
`descricao`	texto	sim	A descrição.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/disciplinar/<id>/arquivar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "motivo": "Caducidade",
  "data": "2026-10-12",
  "descricao": "texto"
}'

GET/api/rh/contencioso/trabalhadores#

Os trabalhadores para escolher nos ecrãs de contencioso.

Permissão RH.ContenciosoEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/contencioso/trabalhadores' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/contencioso#

Lista os litígios laborais.

Permissão RH.ContenciosoLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo
`estado`	na pesquisa	uma de: «Aberto», «AcordoAlcancado», «GanhoPelaEmpresa», «PerdidoPelaEmpresa», «null»
`risco`	na pesquisa	uma de: «Remoto», «Possivel», «Provavel», «null»
`funcionarioId`	na pesquisa	identificador (UUID)

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/contencioso' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/contencioso/resumo#

O resumo dos litígios laborais e das provisões.

Permissão RH.ContenciosoLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/contencioso/resumo' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/contencioso/{id}#

Um litígio laboral, com os eventos e as provisões.

Permissão RH.ContenciosoLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/contencioso/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/contencioso#

Abre um litígio laboral.

Permissão RH.ContenciosoEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id.

Corpo do pedido (JSON · AbrirLitigioCommand)

Campo	Tipo	Obrigatório	Significado
`funcionarioId`	identificador (UUID)	sim
`processoDisciplinarId`	identificador (UUID) ou nulo
`foro`	uma de: «MediacaoIgt», «TribunalDoTrabalho», «Arbitragem»	sim
`numeroProcesso`	texto ou nulo
`dataInicio`	data (AAAA-MM-DD)	sim
`descricao`	texto	sim	A descrição.
`valorReclamado`	número	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/contencioso' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "funcionarioId": "00000000-0000-0000-0000-000000000000",
  "foro": "MediacaoIgt",
  "dataInicio": "2026-10-12",
  "descricao": "texto",
  "valorReclamado": 0
}'

POST/api/rh/contencioso/{id}/eventos#

Regista um evento num litígio laboral.

Permissão RH.ContenciosoEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · EventoLitigioRequest)

Campo	Tipo	Obrigatório	Significado
`tipo`	uma de: «Sessao», «MudancaDeForo», «Documento», «Acordo», «Decisao», «Outro»	sim
`data`	data (AAAA-MM-DD)	sim	A data e hora (UTC).
`descricao`	texto	sim	A descrição.
`valor`	número ou nulo		O valor.
`novoForo`	uma de: «MediacaoIgt», «TribunalDoTrabalho», «Arbitragem» ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/contencioso/<id>/eventos' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "tipo": "Sessao",
  "data": "2026-10-12",
  "descricao": "texto"
}'

POST/api/rh/contencioso/{id}/risco#

Classifica o risco de um litígio laboral.

Permissão RH.ContenciosoEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · RiscoLitigioRequest)

Campo	Tipo	Obrigatório
`nivel`	uma de: «Remoto», «Possivel», «Provavel», «null»	sim
`justificacao`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/contencioso/<id>/risco' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "nivel": "Remoto",
  "justificacao": "texto"
}'

PUT/api/rh/contencioso/{id}/numero-processo#

Define o número do processo judicial de um litígio.

Permissão RH.ContenciosoEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · NumeroProcessoRequest)

Campo	Tipo	Obrigatório
`numeroProcesso`	texto ou nulo

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/contencioso/<id>/numero-processo' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST/api/rh/contencioso/{id}/encerrar#

Encerra um litígio laboral.

Permissão RH.ContenciosoEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · EncerrarLitigioRequest)

Campo	Tipo	Obrigatório	Significado
`resultado`	uma de: «Aberto», «AcordoAlcancado», «GanhoPelaEmpresa», «PerdidoPelaEmpresa», «null»	sim
`data`	data (AAAA-MM-DD)	sim	A data e hora (UTC).
`valorFinal`	número	sim
`descricao`	texto	sim	A descrição.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/contencioso/<id>/encerrar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "resultado": "Aberto",
  "data": "2026-10-12",
  "valorFinal": 0,
  "descricao": "texto"
}'

POST/api/rh/contencioso/{id}/conta#

Regista uma conta (um custo ou um recebimento) num litígio laboral.

Permissão RH.ContenciosoProvisoes
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · AprovarFolhaRequest)

Campo	Tipo	Obrigatório	Significado
`lojaId`	identificador (UUID) ou nulo		O estabelecimento.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/contencioso/<id>/conta' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST/api/rh/contencioso/{id}/provisoes#

Propõe uma provisão para um litígio laboral.

Permissão RH.ContenciosoProvisoes
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · ProvisaoRequest)

Campo	Tipo	Obrigatório	Significado
`valor`	número	sim	O valor.
`justificacao`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/contencioso/<id>/provisoes' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "valor": 0,
  "justificacao": "texto"
}'

POST/api/rh/contencioso/provisoes/{provisaoId}/confirmar#

Confirma uma provisão proposta.

Permissão RH.ContenciosoProvisoes

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`provisaoId`	no caminho	identificador (UUID)	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/contencioso/provisoes/<provisaoId>/confirmar' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/contencioso/provisoes/{provisaoId}/rejeitar#

Rejeita uma provisão proposta.

Permissão RH.ContenciosoProvisoes
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`provisaoId`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/contencioso/provisoes/<provisaoId>/rejeitar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET/api/rh/hst/trabalhadores#

Os trabalhadores para escolher nos ecrãs de higiene, segurança e saúde.

Permissão RH.HstEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/hst/trabalhadores' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/hst/alertas#

Os alertas de higiene, segurança e saúde (por exemplo, exames por renovar).

Permissão RH.HstLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`dias`	na pesquisa	número inteiro
`referencia`	na pesquisa	data (AAAA-MM-DD)

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/hst/alertas' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/hst/exames#

Lista os exames médicos dos trabalhadores.

Permissão RH.HstLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

São dados de saúde.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`funcionarioId`	na pesquisa	identificador (UUID)
`incluirAnulados`	na pesquisa	verdadeiro/falso

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/hst/exames' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/hst/exames#

Regista um exame médico.

Permissão RH.HstEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

São dados de saúde. Devolve o id.

Corpo do pedido (JSON · RegistarExameMedicoCommand)

Campo	Tipo	Obrigatório	Significado
`funcionarioId`	identificador (UUID)	sim
`tipo`	uma de: «Admissao», «Periodico», «Demissao», «RegressoAoTrabalho»	sim
`data`	data (AAAA-MM-DD)	sim	A data e hora (UTC).
`proximoExame`	data (AAAA-MM-DD) ou nulo
`resultado`	uma de: «Apto», «AptoComRestricoes», «Inapto»	sim
`medico`	texto ou nulo
`restricoes`	texto ou nulo
`observacoes`	texto ou nulo
`referenciaCertificado`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/hst/exames' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "funcionarioId": "00000000-0000-0000-0000-000000000000",
  "tipo": "Admissao",
  "data": "2026-10-12",
  "resultado": "Apto"
}'

POST/api/rh/hst/exames/{id}/anular#

Anula um exame médico registado.

Permissão RH.HstEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/hst/exames/<id>/anular' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET/api/rh/hst/acidentes#

Lista os acidentes de trabalho.

Permissão RH.HstLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

São dados de saúde.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`funcionarioId`	na pesquisa	identificador (UUID)
`semComunicacao`	na pesquisa	verdadeiro/falso

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/hst/acidentes' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/hst/acidentes/{id}#

Um acidente de trabalho, com as actualizações.

Permissão RH.HstLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

São dados de saúde.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/hst/acidentes/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/hst/acidentes#

Regista um acidente de trabalho.

Permissão RH.HstEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

São dados de saúde. Devolve o id.

Corpo do pedido (JSON · RegistarAcidenteTrabalhoCommand)

Campo	Tipo	Obrigatório	Significado
`funcionarioId`	identificador (UUID)	sim
`dataHora`	data e hora (ISO 8601)	sim
`local`	texto	sim
`gravidade`	uma de: «Ligeiro», «Grave», «Mortal»	sim
`diasAusencia`	número inteiro	sim
`descricao`	texto	sim	A descrição.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/hst/acidentes' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "funcionarioId": "00000000-0000-0000-0000-000000000000",
  "dataHora": "2026-10-12T09:00:00Z",
  "local": "texto",
  "gravidade": "Ligeiro",
  "diasAusencia": 1,
  "descricao": "texto"
}'

POST/api/rh/hst/acidentes/{id}/actualizacoes#

Regista uma actualização num acidente de trabalho.

Permissão RH.HstEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · ActualizacaoAcidenteRequest)

Campo	Tipo	Obrigatório	Significado
`tipo`	uma de: «ComunicacaoIgt», «ComunicacaoInss», «DiasDeAusencia», «Nota»	sim
`data`	data (AAAA-MM-DD)	sim	A data e hora (UTC).
`descricao`	texto ou nulo		A descrição.
`dias`	número inteiro ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/hst/acidentes/<id>/actualizacoes' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "tipo": "ComunicacaoIgt",
  "data": "2026-10-12"
}'

GET/api/rh/activos/trabalhadores#

Os trabalhadores para escolher nos ecrãs de activos.

Permissão RH.ActivosEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/activos/trabalhadores' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/activos/alertas#

Os alertas dos activos entregues (por exemplo, devoluções em atraso).

Permissão RH.ActivosLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`dias`	na pesquisa	número inteiro
`referencia`	na pesquisa	data (AAAA-MM-DD)

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/activos/alertas' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/activos#

Lista os activos entregues aos trabalhadores (EPI, equipamentos).

Permissão RH.ActivosLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo
`funcionarioId`	na pesquisa	identificador (UUID)
`estado`	na pesquisa	uma de: «Entregue», «Devolvido», «Anulado», «null»
`categoria`	na pesquisa	uma de: «Epi», «Informatico», «Viatura», «Telecomunicacoes», «Ferramenta», «Outro», «null»

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/activos' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/activos#

Regista a entrega de um activo a um trabalhador.

Permissão RH.ActivosEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id.

Corpo do pedido (JSON · EntregarActivoCommand)

Campo	Tipo	Obrigatório	Significado
`funcionarioId`	identificador (UUID)	sim
`categoria`	uma de: «Epi», «Informatico», «Viatura», «Telecomunicacoes», «Ferramenta», «Outro», «null»	sim
`descricao`	texto	sim	A descrição.
`numeroSerie`	texto ou nulo
`dataEntrega`	data (AAAA-MM-DD)	sim
`validade`	data (AAAA-MM-DD) ou nulo		A data de validade do lote.
`condicaoNaEntrega`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/activos' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "funcionarioId": "00000000-0000-0000-0000-000000000000",
  "categoria": "Epi",
  "descricao": "texto",
  "dataEntrega": "2026-10-12"
}'

POST/api/rh/activos/{id}/devolver#

Regista a devolução de um activo.

Permissão RH.ActivosEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · DevolucaoActivoRequest)

Campo	Tipo	Obrigatório	Significado
`data`	data (AAAA-MM-DD)	sim	A data e hora (UTC).
`condicao`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/activos/<id>/devolver' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "data": "2026-10-12"
}'

POST/api/rh/activos/{id}/anular#

Anula o registo de um activo entregue.

Permissão RH.ActivosEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/activos/<id>/anular' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET/api/rh/avaliacoes/trabalhadores#

Os trabalhadores para escolher nos ecrãs de avaliações.

Permissão RH.AvaliacoesEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/avaliacoes/trabalhadores' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/avaliacoes/resumo#

O resumo das avaliações de desempenho.

Permissão RH.AvaliacoesLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`ano`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/avaliacoes/resumo' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/avaliacoes/pendentes#

Os trabalhadores com avaliação de desempenho pendente.

Permissão RH.AvaliacoesLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`ano`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/avaliacoes/pendentes' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/avaliacoes#

Lista as avaliações de desempenho.

Permissão RH.AvaliacoesLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo
`ano`	na pesquisa	número inteiro
`funcionarioId`	na pesquisa	identificador (UUID)
`estado`	na pesquisa	uma de: «Rascunho», «Concluida», «Anulada», «null»
`incluirAnuladas`	na pesquisa	verdadeiro/falso

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/avaliacoes' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/avaliacoes/{id}#

Uma avaliação de desempenho.

Permissão RH.AvaliacoesLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/avaliacoes/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/avaliacoes#

Abre uma avaliação de desempenho.

Permissão RH.AvaliacoesEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id.

Corpo do pedido (JSON · CriarAvaliacaoCommand)

Campo	Tipo	Obrigatório
`funcionarioId`	identificador (UUID)	sim
`avaliadorId`	identificador (UUID)	sim
`ano`	número inteiro	sim
`escalaMaxima`	número

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/avaliacoes' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "funcionarioId": "00000000-0000-0000-0000-000000000000",
  "avaliadorId": "00000000-0000-0000-0000-000000000000",
  "ano": 1
}'

PUT/api/rh/avaliacoes/{id}#

Actualiza uma avaliação de desempenho em curso.

Permissão RH.AvaliacoesEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · ActualizarAvaliacaoRequest)

Campo	Tipo	Obrigatório
`avaliadorId`	identificador (UUID)	sim
`pontuacao`	número ou nulo
`resumo`	texto ou nulo
`metasCumpridas`	verdadeiro/falso ou nulo

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/avaliacoes/<id>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "avaliadorId": "00000000-0000-0000-0000-000000000000"
}'

POST/api/rh/avaliacoes/{id}/concluir#

Conclui uma avaliação de desempenho.

Permissão RH.AvaliacoesEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/avaliacoes/<id>/concluir' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/avaliacoes/{id}/anular#

Anula uma avaliação de desempenho.

Permissão RH.AvaliacoesEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/avaliacoes/<id>/anular' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET/api/rh/acordos/trabalhadores#

Os trabalhadores para escolher nos ecrãs de acordos colectivos.

Permissão RH.AcordosEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/acordos/trabalhadores' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/acordos#

Lista os acordos colectivos de trabalho.

Permissão RH.AcordosLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`referencia`	na pesquisa	data (AAAA-MM-DD)

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/acordos' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/acordos/{id}#

Um acordo colectivo, com os parâmetros, as categorias e as adesões.

Permissão RH.AcordosLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim
`referencia`	na pesquisa	data (AAAA-MM-DD)

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/acordos/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/acordos#

Regista um acordo colectivo de trabalho.

Permissão RH.AcordosEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Devolve o id.

Corpo do pedido (JSON · CriarAcordoCommand)

Campo	Tipo	Obrigatório	Significado
`nome`	texto	sim	O nome.
`ambito`	texto ou nulo
`fonte`	texto	sim
`vigenteDesde`	data (AAAA-MM-DD)	sim
`vigenteAte`	data (AAAA-MM-DD) ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/acordos' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "nome": "texto",
  "fonte": "texto",
  "vigenteDesde": "2026-10-12"
}'

PUT/api/rh/acordos/{id}#

Actualiza um acordo colectivo.

Permissão RH.AcordosEditar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · ActualizarAcordoRequest)

Campo	Tipo	Obrigatório	Significado
`nome`	texto	sim	O nome.
`ambito`	texto ou nulo
`fonte`	texto	sim
`vigenteAte`	data (AAAA-MM-DD) ou nulo

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/rh/acordos/<id>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "nome": "texto",
  "fonte": "texto"
}'

POST/api/rh/acordos/{id}/terminar#

Termina um acordo colectivo.

Permissão RH.AcordosEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · TerminarAcordoRequest)

Campo	Tipo	Obrigatório	Significado
`data`	data (AAAA-MM-DD)	sim	A data e hora (UTC).
`motivo`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/acordos/<id>/terminar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "data": "2026-10-12",
  "motivo": "texto"
}'

POST/api/rh/acordos/{id}/parametros#

Acrescenta um parâmetro a um acordo colectivo.

Permissão RH.AcordosEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · ParametroAcordoRequest)

Campo	Tipo	Obrigatório	Significado
`codigo`	uma de: «TaxaInssTrabalhador», «TaxaInssEntidadeEmpregadora», «LimiteIsencaoSubsidioAlimentacao», «LimiteIsencaoSubsidioTransporte», «SalarioMinimo», «HorasSemanaisNormais», «AcrescimoTrabalhoSuplementar», «LimiteHorasFaixaTrabalhoSuplementar», «AcrescimoTrabalhoNocturno», «LimiteTrabalhoSuplementarDiario», «LimiteTrabalhoSuplementarAnual», «DiasFeriasAnuais», «PercentagemSubsidioFerias», «PercentagemSubsidioNatal», «DivisorDescontoFalta», «TectoPenhoraSalario», «IndemnizacaoPorAno», «PrazoCaducidadeDisciplinar», «PrazoRespostaNotaDeCulpa», «DiaLimiteEntregaInss», «DiaLimiteEntregaIrt»	sim	O código curto.
`dimensao`	texto ou nulo
`valor`	número	sim	O valor.
`vigenteDesde`	data (AAAA-MM-DD)	sim
`clausula`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/acordos/<id>/parametros' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "codigo": "TaxaInssTrabalhador",
  "valor": 0,
  "vigenteDesde": "2026-10-12",
  "clausula": "texto"
}'

POST/api/rh/acordos/{id}/parametros/{parametroId}/anular#

Anula um parâmetro de um acordo colectivo.

Permissão RH.AcordosEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim
`parametroId`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/acordos/<id>/parametros/<parametroId>/anular' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST/api/rh/acordos/{id}/parametros/{parametroId}/confirmar#

Confirma um parâmetro de um acordo colectivo.

Permissão RH.AcordosConfirmar

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim
`parametroId`	no caminho	identificador (UUID)	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/acordos/<id>/parametros/<parametroId>/confirmar' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/acordos/{id}/categorias#

Acrescenta uma categoria profissional a um acordo colectivo.

Permissão RH.AcordosEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · CategoriaAcordoRequest)

Campo	Tipo	Obrigatório
`categoria`	texto	sim
`salarioMinimo`	número	sim
`vigenteDesde`	data (AAAA-MM-DD)	sim
`clausula`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/acordos/<id>/categorias' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "categoria": "texto",
  "salarioMinimo": 0,
  "vigenteDesde": "2026-10-12",
  "clausula": "texto"
}'

POST/api/rh/acordos/{id}/categorias/{categoriaId}/anular#

Anula uma categoria de um acordo colectivo.

Permissão RH.AcordosEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim
`categoriaId`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · MotivoRequest)

Campo	Tipo	Obrigatório
`motivo`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/acordos/<id>/categorias/<categoriaId>/anular' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST/api/rh/acordos/{id}/adesoes#

Regista a adesão de um trabalhador a um acordo colectivo.

Permissão RH.AcordosEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · AdesaoAcordoRequest)

Campo	Tipo	Obrigatório
`funcionarioId`	identificador (UUID)	sim
`categoria`	texto ou nulo
`desde`	data (AAAA-MM-DD)	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/acordos/<id>/adesoes' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "funcionarioId": "00000000-0000-0000-0000-000000000000",
  "desde": "2026-10-12"
}'

POST/api/rh/acordos/adesoes/{adesaoId}/encerrar#

Encerra a adesão de um trabalhador a um acordo colectivo.

Permissão RH.AcordosEditar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`adesaoId`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · EncerrarAdesaoRequest)

Campo	Tipo	Obrigatório
`ate`	data (AAAA-MM-DD)	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/acordos/adesoes/<adesaoId>/encerrar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "ate": "2026-10-12"
}'

GET/api/rh/auditoria/acessos#

A auditoria de acessos a dados sensíveis de recursos humanos feitos dentro do Mucanda: quem consultou o quê e quando.

Permissão RH.AuditoriaLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

É a auditoria do módulo (por pessoas e por chaves). O registo dos pedidos de cada chave está em Definições › Chaves de API › Acessos.

Parâmetros

Nome	Onde	Tipo
`categoria`	na pesquisa	uma de: «Salarios», «Saude», «Disciplinar», «Contencioso», «Avaliacoes», «Denuncias», «null»
`utilizadorId`	na pesquisa	identificador (UUID)
`desde`	na pesquisa	data (AAAA-MM-DD)
`ate`	na pesquisa	data (AAAA-MM-DD)
`tamanho`	na pesquisa	número inteiro
`chaveApiId`	na pesquisa	identificador (UUID)

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/auditoria/acessos' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/denuncias/resumo#

O resumo das denúncias recebidas no canal de denúncias.

Permissão RH.DenunciasLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/denuncias/resumo' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/denuncias#

Lista as denúncias recebidas no canal de denúncias.

Permissão RH.DenunciasLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo
`estado`	na pesquisa	uma de: «Recebida», «EmAnalise», «Concluida», «Arquivada», «null»
`categoria`	na pesquisa	uma de: «AssedioMoral», «AssedioSexual», «Discriminacao», «FraudeOuCorrupcao», «SegurancaESaude», «Outra», «null»
`incluirTerminadas`	na pesquisa	verdadeiro/falso

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/denuncias' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/rh/denuncias/{id}#

Uma denúncia, com as respostas e as notas de tratamento.

Permissão RH.DenunciasLer

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Nunca traz a identidade de quem denunciou: essa só se vê no ecrã, por uma pessoa com a permissão própria, e fica registada.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/rh/denuncias/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/rh/denuncias/{id}/responder#

Responde ao autor de uma denúncia, pelo canal.

Permissão RH.DenunciasTratar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · TextoRequest)

Campo	Tipo	Obrigatório
`texto`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/denuncias/<id>/responder' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "texto": "texto"
}'

POST/api/rh/denuncias/{id}/notas#

Regista uma nota interna no tratamento de uma denúncia.

Permissão RH.DenunciasTratar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · TextoRequest)

Campo	Tipo	Obrigatório
`texto`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/denuncias/<id>/notas' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "texto": "texto"
}'

POST/api/rh/denuncias/{id}/concluir#

Conclui o tratamento de uma denúncia.

Permissão RH.DenunciasTratar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · ConcluirDenunciaRequest)

Campo	Tipo	Obrigatório
`resultado`	uma de: «Procedente», «ParcialmenteProcedente», «Improcedente», «SemElementosSuficientes»	sim
`fundamentacao`	texto	sim
`comunicacaoAoDenunciante`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/denuncias/<id>/concluir' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "resultado": "Procedente",
  "fundamentacao": "texto"
}'

POST/api/rh/denuncias/{id}/arquivar#

Arquiva uma denúncia.

Permissão RH.DenunciasTratar
Idempotência aceita Idempotency-Key

Dados sensíveis: só com uma chave de acesso reforçado (403 DADOS_SENSIVEIS_NAO_AUTORIZADOS sem ela). Ver Dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · ArquivarDenunciaRequest)

Campo	Tipo	Obrigatório
`motivo`	texto	sim
`comunicacaoAoDenunciante`	texto ou nulo

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/rh/denuncias/<id>/arquivar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "motivo": "texto"
}'