01. DADOS GERAIS
Linha de Produto: | Microsiga Protheus |
---|---|
Segmento: | Recursos Humanos |
Módulo: | SIGAGPE |
Função: | WSMIDREL |
Story: | DRHESOCP-16781 |
02. SITUAÇÃO/REQUISITO
Criar um serviço (API REST) que será consumido pelo FrontEnd do Monitor THF/Portinari, para efetuar o processamento do relatório dos valores de FGTS do eSocial, de acordo com a empresa logada.
A API poderá receber os parâmetro abaixo:
PROPRIEDADE | DESCRIÇÃO | Obrigatório? |
---|---|---|
companyId | Identificador da empresa | Sim |
registrationNumber | Inscrição Estabelecimento | Não |
lotationCode | Código Lotação | Não |
eSocialCategory | Categoria eSocial | Não |
cpfNumber | CPF | Não |
eSocialRegistration | Matrícula eSocial | Não |
paymentPeriod | Período Folha | Sim |
tribute | Tributo | Sim |
As propriedades abaixo serão retornadas:
PROPRIEDADE | DESCRIÇÃO |
---|---|
requestId | Id. da requisição |
Criar um serviço (API REST) que será consumido pelo FrontEnd do Monitor THF/Portinari, para retornar os valores de FGTS do eSocial, de acordo com a empresa logada.
A API poderá receber os parâmetro abaixo:
PROPRIEDADE | DESCRIÇÃO | Obrigatório? |
---|---|---|
companyId | Identificador da empresa | Sim |
requestId | Id. da requisição | Sim |
synthetic | Analítico (False ou Sintético (True) | Não |
differencesOnly | Somente divergências | Não |
page | Número da Página | Não |
pageSize | Qtde. de registros por página | Não |
As propriedades abaixo serão retornadas:
PROPRIEDADE | DESCRIÇÃO | OBSERVAÇÃO |
---|---|---|
cpfNumber | CPF do Trabalhador | |
name | Nome do Trabalhador | |
esocialRegistration | Matrícula do Trabalhador | |
esocialCategory | Categoria do Trabalhador | |
lotationCode | Lotação do Trabalhador | |
branchId | Estabelecimento do Trabalhador | |
numberEmployees | Número total de funcionários | Apenas no relatório sintético |
fgtsBasis | Base FGTS Folha do Trabalhador | |
fgtsValue | Valor FGTS Folha do Trabalhador | |
fgts13Basis | Base FGTS 13o Folha do Trabalhador | |
fgts13Value | Valor FGTS 13o Folha do Trabalhador | |
fgtsRescissionBasis | Base FGTS Rescisório do Trabalhador | |
fgtsRescissionValue | Valor FGTS Rescisório do Trabalhador | |
fgtsRetBasis | Base FGTS Governo do Trabalhador | |
fgtsRetValue | Valor FGTS Governo do Trabalhador | |
fgts13RetBasis | Base FGTS 13o Governo do Trabalhador | |
fgts13RetValue | Valor FGTS 13o Governo do Trabalhador | |
fgtsRescissionRetBasis | Valor FGTS Rescisório Governo do Trabalhador | |
fgtsRescissionRetValue | Valor FGTS Rescisório Governo do Trabalhador |
03. SOLUÇÃO
Desenvolvimento de uma API REST (WSMIDREL) que efetua o processamento do relatório dos valores de FGTS do eSocial de acordo com os requisitos citados acima e também que retorna os valores de FGTS.
A consulta é realizada na tabela de verbas (RJO), com os filtros informados pelo Front-End, e assim as propriedades são retornadas no formato de String JSON.