Exibir origem

Disponibilizado endpoint para integração do cadastro de Funcionários com os métodos GET, POST, PUT, PATCH e DELETE.

Estrutura:

Atributos	Descrição	Tamanho	Tipo	Chave Primária	Requerido	Valor Default	Valores Válidos	Observação
id	Id único para rastreamento do registro de ponta a ponta	12	NUMBER	S	N	-	-	Gerado automaticamente quando o registro é inserido na tabela.
codigoEmpresa	Código da empresa	2	NUMBER	N	N	-	Empresa cadastrada	Caso não informada será atribuído o código da empresa padrão configurado em default-company-ind.
codigoEmpresaERP	Código da empresa no ERP	5	STRING	N	N	-	-	-
codigoProntuarioSocial	Código do prontuário social	10	STRING	N	S	-	-	-
codigoCracha	Código do crachá	12	STRING	N	N	-	-	-
nome	Nome do funcionário	40	STRING	N	S	-	-	-
apelido	Apelido do funcionário	10	STRING	N	N	-	-	-
dataAdmissao	Data de admissão	10	DATE	N	S	-	-	-
dataDemissao	Data de demissão	10	DATE	N	N	-	-	-
tipoMaoObra	Tipo de mão de obra	1	STRING	N	N	"I"	I = Interna E = Externa	-
quantidadePessoas	Quantidade de pessoas	4	NUMBER	N	N	"1"	-	Acatado somente quando tipoMaoObra = "E"
atividadePrincipal	Atividade principal	1	STRING	N	N	"M"	M = Manutenção O = Operação	-
idQualificacao	Id da qualificação do funcionário	10	NUMBER	N	N	-	Qualificação cadastrada	-
controlaMaoObraPeloSistema	Controla mão de obra pelo sistema	1	STRING	N	N	"1"	1 = Sim 0 = Não	-
numeroCelular	Número do celular	15	STRING	N	N	-	-	-
email	E-mail	50	STRING	N	N	-	-	-
idSubCentroCusto	Id do sub-centro de custo	12	NUMBER	N	N	-	Sub-Centro de Custo cadastrado para a empresa informada	-
codigoChipCartao	Código do chip de cartão de ponto	20	STRING	N	N	-	-	-
senhaAcesso	Senha de acesso	60	STRING	N	N	-	-	-

GET (Consulta Funcionário)

http:127.0.0.1:8080/api/entity/v1/funcionariosInd

{
    "hasNext": false,
    "items": [
        {
            "codigoEmpresa": 1,
            "id": 13745,
            "codigoProntuarioSocial": "91000",
            "codigoCracha": "91000",
            "nome": "FUNCIONÁRIO 91000",
            "apelido": "NOME 91000",
            "dataAdmissao": "2025-08-01T00:00:00",
            "dataDemissao": null,
            "tipoMaoObra": "I",
            "quantidadePessoas": 1,
            "atividadePrincipal": "M",
            "idQualificacao": null,
            "controlaMaoObraPeloSistema": "1",
            "numeroCelular": null,
            "email": null,
            "idSubCentroCusto": null,
            "codigoChipCartao": "CHIP123456",
            "senhaAcesso": null
        }
    ]
}

Parâmetros

page: Número da página.
pagesize: Quantidade máxima de registros por página.

Observações

Todos os atributos podem ser usados como parâmetro para a busca.

PUT/PATCH (Modifica Funcionário)

http:127.0.0.1:8080/api/entity/v1/funcionariosInd

Estrutura de dados para envio (exemplo):

{
    "codigoProntuarioSocial": "91000",
    "email": "[email protected]"
}

Estrutura de dados retorno:

{
    "codigoProntuarioSocial": "91000",
    "email": "[email protected]",
    "id": "13745"
}

Observações

Quando PATCH poderão ser informados apenas os atributos que necessitam de atualização.
No caso de PUT deverão ser informados os atributos necessários bem como os obrigatórios.
Deverá ser informado ao menos um dos atributos para localização do Funcionário (id ou codigoProntuarioSocial).
Caso os dois atributos id e codigoProntuarioSocial forem informados, será considerado apenas o atributo id para localização do funcionário. Será realizada uma busca por outros funcionários com IDs diferentes que utilizem o codigoProntuarioSocial informado e caso nenhum funcionário seja encontrado o valor informado será alterado, e caso seja encontrado um ou mais funcionários com IDs diferentes já utilizando este codigoProntuarioSocial uma mensagem será exibida e a alteração não será realizada.
Caso o atributo codigoEmpresa seja informado, o codigoEmpresaERP será sempre desconsiderado.
Caso o atributo codigoEmpresaERP seja informado, ele será utilizado para localizar e atribuir o código da empresa no atributo codigoEmpresa.
Caso o atributo codigoCracha seja informado, será realizada uma busca por outros funcionários que utilizem esse código e caso nenhum funcionário for encontrado a alteração será realizada, e caso seja encontrado um ou mais funcionários utilizando esse codigoCracha uma mensagem será exibida e a alteração não será realizada.
Caso o atributo codigoChipCartao seja informado, será realizada uma busca por outros funcionários que utilizem esse código e caso nenhum funcionário for encontrado a alteração será realizada, e caso seja encontrado um ou mais funcionários utilizando esse codigoChipCartao uma mensagem será exibida e a alteração não será realizada.
Caso o atributo dataDemissao seja informado ele não poderá ser menor que o atributo dataAdmissao.
Caso o atributo tipoMaoObra seja informado com valor "E" (mão de obra externa), o atributo quantidadePessoas não poderá ser menor ou igual a zero.

POST (Insere Funcionário)

http:127.0.0.1:8080/api/entity/v1/funcionariosInd

Estrutura de dados para envio:

{
    "codigoEmpresa": null,
    "codigoEmpresaERP": 1,
    "codigoProntuarioSocial": "91000",
    "codigoCracha": "91000",
    "nome": "Funcionário 91000",
    "apelido": "NOME 91000",
    "dataAdmissao": "2025-08-01T00:00:00",
    "dataDemissao": null,
    "tipoMaoObra": null,
    "quantidadePessoas": null,
    "atividadePrincipal": null,
    "idQualificacao": null,
    "controlaMaoObraPeloSistema": null,
    "idSubCentroCusto": null,
    "codigoChipCartao": "CHIP123456"
}

Estrutura de dados retorno:

{     
    "codigoEmpresa": "1",
    "codigoProntuarioSocial": "91000",
    "codigoCracha": "91000",
    "nome": "FUNCIONÁRIO 91000",
    "apelido": "NOME 91000",
    "dataAdmissao": "2025-08-01T00:00:00",
    "dataDemissao": null,
    "tipoMaoObra": "I",
    "quantidadePessoas": 1,
    "atividadePrincipal": "M",
    "idQualificacao": null,
    "controlaMaoObraPeloSistema": "1",
    "idSubCentroCusto": null,
    "codigoChipCartao": "CHIP123456",
    "id": "13741" }

Observações

Caso os atributos codigoEmpresa e codigoEmpresaERP não forem informados, será utilizado como default o valor definido no parâmetro default-company-ind.
Caso o atributo codigoEmpresa seja informado, o codigoEmpresaERP será sempre desconsiderado.
Caso o atributo codigoEmpresaERP seja informado, ele será utilizado para localizar e atribuir o código da empresa no atributo codigoEmpresa.
O atributo id será gerado automaticamente e atribuído ao novo funcionário, e caso seja informado será desconsiderado.
O atributo codigoProntuarioSocial deverá ser informado. Será realizada uma busca por outros funcionários que utilizem esse código e caso nenhum funcionário for encontrado a inclusão será realizada, e caso seja encontrado um ou mais funcionários utilizando esse codigoProntuarioSocial uma mensagem será exibida e a inclusão não será realizada.
Caso o atributo codigoCracha seja informado, será realizada uma busca por outros funcionários que utilizem esse código e caso nenhum funcionário for encontrado a inclusão será realizada, e caso seja encontrado um ou mais funcionários utilizando esse codigoCracha uma mensagem será exibida e a inclusão não será realizada.
Caso o atributo codigoChipCartao seja informado, será realizada uma busca por outros funcionários que utilizem esse código e caso nenhum funcionário for encontrado a inclusão será realizada, e caso seja encontrado um ou mais funcionários utilizando esse codigoChipCartao uma mensagem será exibida e a inclusão não será realizada.
Caso o atributo dataDemissao seja informado ele não poderá ser menor que o atributo dataAdmissao.
Caso o atributo tipoMaoObra seja informado com valor "E" (mão de obra externa), o atributo quantidadePessoas não poderá ser menor ou igual a zero.

DELETE (Exclui Funcionário)

Disponibilizado endpoint para excluir o Funcionário.

Método DELETE:

http:127.0.0.1:8080/api/entity/v1/funcionariosInd

Parâmetros

Deverá ser informado ao menos um dos atributos para localização do Funcionário (id ou codigoProntuarioSocial).
Caso os dois atributos id e codigoProntuarioSocial forem informados, será considerado apenas o atributo id para localização e exclusão do funcionário e o codigoProntuarioSocial será desconsiderado.
Caso o registro do funcionário esteja sendo utilizado por registros de outras tabelas relacionadas a exclusão não será realizada e uma mensagem será exibida.