Exibir origem

CONTEÚDO

Visão Geral
Menu
Integração
Atualização/Dicionário
Informações Técnicas APIs
Documentos Relacionados
Vídeos

Informações Técnicas das APIs do Crédito do Trabalhador

Este detalhamento tem como objetivo registrar os endpoints da interface da integração da tela desenvolvida utilizando PO-UI.

credito-trabalhador

Tipo de requisição: POST

Endpoint: /api/rh/v1/credito-trabalhador

Objetivo: Efetua a gravação os empréstimos nas tabelas do ERP e retorna o resultado.

POST:

Estrutura do body:

Campo	Campo pai	Tipo	Descrição
atualiza	-	boolean	Indica se deseja atualizar os empréstimos importados anteriormente.
branches	-	array	Indica as filiais que serão atualizadas no ERP. Se vazio atualiza todas.
items	-	array	Lista dos empréstimos que devem ser gravados.
ifConcessora	items	object	Instituição financeira.
codigo	ifConcessora	number	Código da Instituição financeira.
descricao	ifConcessora	string	Descrição da Instituição financeira.
contrato	items	string	Número do contrato
cpf	items	string	Número do CPF do trabalhador.
matricula	items	string	Matrícula do trabalhador no eSocial.
inscricaoEmpregador	items	object	Objeto da Inscrição do empregador
codigo	inscricaoEmpregador	number	Código correspondente ao tipo de inscrição do empregador. 1 algarismo conforme eSocial.
numeroInscricaoEmpregador	items	string	Número da inscrição do empregador.
nomeTrabalhador	items	string	Nome completo do trabalhador.
dataInicioContrato	items	string	Data de início do contrato.
dataFimContrato	items	string	Data de término do contrato.
competenciaInicioDesconto	items	string	Competência inicial do desconto (mês/ano).
competenciaFimDesconto	items	string	Competência final do desconto (mês/ano).
totalParcelas	items	number	Total de parcelas do empréstimo.
valorParcela	items	number	Valor de cada parcela.
valorEmprestimo	items	number	Valor total do empréstimo.
valorLiberado	items	number	Valor que foi liberado.
qtdPagamentos	items	number	Quantidade de pagamentos realizados.
qtdEscrituracoes	items	number	Quantidade de escriturações.
categoriaTrabalhador	items	object	Objeto com informações da categoria do trabalhador.
codigo	categoriaTrabalhador	number	Código da categoria do trabalhador.
competencia	items	string	Competência (mês/ano).
inscricaoEstabelecimento	items	object	Objeto com informações da inscrição do estabelecimento.
codigo	inscricaoEstabelecimento	number	Código correspondente ao tipo de inscrição do estabelecimento. 1 algarismo conforme eSocial.
numeroInscricaoEstabelecimento	items	string	Número da inscrição do estabelecimento.
dataAdmissao	items	string	Data de admissão do trabalhador.
_index	items	number	Índice do item na lista. (gerado no momento da importação)

{
"atualiza": true,
"branches": [
"estabelecimento 01",
"estabelecimento 02"
],
"items": [
{
"ifConcessora": {
"codigo": 0,
"descricao": "string"
},
"contrato": "string",
"cpf": "string",
"matricula": "string",
"inscricaoEmpregador": {
"codigo": 1
},
"numeroInscricaoEmpregador": "string",
"nomeTrabalhador": "string",
"dataInicioContrato": "01/05/2025",
"dataFimContrato": "string",
"competenciaInicioDesconto": "05/2025",
"competenciaFimDesconto": "08/2025",
"totalParcelas": 1,
"valorParcela": 100.99,
"valorEmprestimo": 400.99,
"valorLiberado": 300.99,
"qtdPagamentos": 0,
"qtdEscrituracoes": 0,
"categoriaTrabalhador": {
"codigo": 101
},
"competencia": "05/2025",
"inscricaoEstabelecimento": {
"codigo": 1
},
"numeroInscricaoEstabelecimento": "string",
"dataAdmissao": "28/02/2020",
"_index": 0
}
]
}

Estrutura do Retorno:

Campo	Campo pai	Tipo	Exemplo
items	-	array	Lista com o retorno do processamento de cada emprestimo
_index	items	number	Índice do item na lista. (deve retornar o índice recebido no body)
_emp	items	string	Empresa do trabalhador.
_fil	items	string	Filial/Estabelecimento onde o trabalhador foi encontrado.
_fun	items	string	Código do Trabalhador no ERP.
_status	items	string	Status do processamento, onde: 0=Não Processado; 1=Sucesso; 2=Alerta informativo e 3=Rejeitado
_obs	items	String	Mensagem detalhada em caso de empréstimo Rejeitado ou Alerta informativo.

{
"items": [
{
"_index": 0,
"_emp": "",
"_fil": "",
"_fun": "",
"_status": "1",
"_obs": "string"
}
]
}

Para o retorno de erro, seguir a estrutura abaixo.

Campo	Tipo
code	number
message	string
detailedMessage	string
type	string (“error”, “warning”, “success”)

{
"code": 500,
"detailedMessage": "",
"message": "Internal Server Error",
"type": "error"
}