eConsignado no Protheus: pré-requisitos para integração via API Dataprev
21/08/26, 14:00
A integração do eConsignado, também conhecido como Crédito do Trabalhador, permite que o Protheus consulte e importe, por meio de API, os dados de empréstimos consignados disponibilizados pela Dataprev.
Configuração do Protheus e do TSS para integração dos dados do Crédito do Trabalhador
A integração do eConsignado, também conhecido como Crédito do Trabalhador, permite que o Protheus consulte e importe, por meio de API, os dados de empréstimos consignados disponibilizados pela Dataprev.
Essa integração pode ser utilizada nos processos:
Mensais;
Rescisórios;
Consulta de contratos ativos;
Consulta de dados de consignações;
Consulta do extrato do trabalhador.
Para que a comunicação entre o Protheus, o TSS e a API da Dataprev funcionem corretamente, é necessário atender a alguns pré-requisitos técnicos e manter todos os ambientes devidamente atualizados.
As orientações apresentadas neste artigo são aplicáveis ao TOTVS RH — Linha Protheus — Gestão de Pessoal, a partir da versão 12.1.2510.
Pré-requisitos no Protheus
Atualização dos RPOs do Protheus
Todos os RPOs do Protheus devem ser atualizados com os respectivos pacotes de expedição contínua.
Confira as datas mínimas exigidas para os fontes:
RH Acumulado: o fonte GPEM815.APP deve possuir data igual ou posterior a 17/07/2026;
TAF Acumulado: o fonte WSTAFCONSIGNADO.PRW deve possuir data igual ou posterior a 23/06/2026.
A atualização deve ser conferida em todos os RPOs utilizados pelo Protheus, incluindo:
RPO de produção;
RPO do REST;
Broker;
Grid;
Outros serviços apartados.
A atualização apenas do RPO principal não é suficiente quando existem outros serviços executando o Protheus com RPOs independentes.
Configuração do Web Service REST
Também é necessário configurar o Web Service REST responsável pela Consulta do Crédito do Trabalhador.
Esse serviço permite a comunicação entre o Protheus, o TSS e os endpoints da API da Dataprev.
A configuração deve ser validada antes da utilização da rotina de importação ou consulta dos empréstimos eConsignados.
Parâmetros do Protheus
Os seguintes parâmetros devem ser conferidos:
MV_TAFSURL
O parâmetro MV_TAFSURL deve conter a URL do TSS utilizado pelo ambiente.
É importante confirmar se o endereço está correto e se o Protheus consegue estabelecer comunicação com o TSS configurado.
MV_TAFAMBE
O parâmetro MV_TAFAMBE deve estar configurado com o valor: 1.
Esse valor indica que o ambiente está configurado como produção do eSocial.
Ambientes que utilizam Middleware
Para clientes que utilizam Middleware, com o parâmetro:
MV_RHTAF = .F.
Também deve ser configurado o serviço TAF_CFGJOB, conforme a documentação específica da TOTVS.
Pré-requisitos no TSS
Atualização dos RPOs do TSS
Todos os RPOs do TSS também devem ser atualizados com o pacote de expedição contínua correspondente.
O fonte deve atender à seguinte data mínima:
TSS Acumulado: o fonte TSSWSCONSIGNADO.PRW deve possuir data igual ou posterior a 26/06/2026.
A conferência deve considerar:
RPO de produção;
RPOs apartados;
Outros serviços do TSS que estejam em execução no ambiente.
Atualização das URLs na tabela SPED158
Além da atualização dos fontes, é necessário verificar se a tabela SPED158 contém os serviços e endpoints necessários para a integração com a API da Dataprev.
Para realizar a conferência, execute a consulta:
SELECT * FROM SPED158 WHERE MODELO = 'ECONSIG'
O resultado deve apresentar os registros relacionados ao modelo ECONSIG, incluindo os serviços:
DADOSCONSIGEXTR;
DADOSCONSIGNADO.
Esses registros devem conter os endereços utilizados para consulta do extrato do trabalhador e dos dados de consignações do empregador.
A imagem abaixo apresenta um exemplo da consulta realizada na tabela SPED158 e dos endpoints configurados para o modelo ECONSIG.
Na imagem, é possível identificar os endpoints relacionados aos ambientes da Dataprev, incluindo:
Consulta do extrato do trabalhador;
Consulta dos dados de consignações do empregador;
Ambiente de produção;
Ambiente de homologação.
É importante confirmar se:
O modelo informado é ECONSIG;
Os serviços DADOSCONSIGEXTR e DADOSCONSIGNADO estão cadastrados;
As URLs estão completas;
Os endereços correspondem ao ambiente correto;
Os endpoints estão atualizados;
Não existem registros duplicados ou inconsistentes.
Caso os registros não estejam disponíveis ou contenham URLs incorretas, a integração via API poderá apresentar falhas durante a consulta ou importação dos dados.
Atenção à aplicação dos pacotes
Os RPOs do Protheus e do TSS possuem finalidades diferentes. Por isso, os pacotes devem ser aplicados somente nos ambientes correspondentes.
As atualizações devem seguir esta regra:
Pacotes do RH e do TAF devem ser aplicados somente nos RPOs do Protheus;
Pacotes do TSS devem ser aplicados somente nos RPOs do TSS.
Não se deve aplicar uma atualização do TSS em um RPO do Protheus, nem uma atualização do Protheus em um RPO do TSS.
A aplicação de pacotes no RPO incorreto pode provocar inconsistências, indisponibilidade de serviços ou falhas na integração.
Como conferir as datas dos fontes?
Para conferir corretamente as datas dos fontes do Protheus e do TSS, recomenda-se utilizar o Visual Studio Code.
A conferência deve abranger todos os RPOs envolvidos na operação.
Caso a verificação não seja realizada pelo Visual Studio Code, será necessário extrair o Inspetor de Objetos de todos os RPOs, incluindo:
Produção;
REST;
Broker;
Grid;
TSS;
Outros serviços apartados.
Essa etapa é importante porque diferentes serviços podem estar executando versões distintas dos fontes.
Checklist de validação
Antes de utilizar a integração do eConsignado via API Dataprev, confirme se os seguintes itens foram atendidos:
Protheus
O ambiente está na versão 12.1.2510 ou superior;
O fonte GPEM815.APP está com data igual ou posterior a 17/07/2026;
O fonte WSTAFCONSIGNADO.PRW está com data igual ou posterior a 23/06/2026;
Todos os RPOs do Protheus foram atualizados;
O Web Service REST de Consulta do Crédito do Trabalhador está configurado;
O parâmetro MV_TAFSURL contém a URL correta do TSS;
O parâmetro MV_TAFAMBE está configurado com o valor 1;
O serviço TAF_CFGJOB foi configurado, quando aplicável.
TSS
O fonte TSSWSCONSIGNADO.PRW está com data igual ou posterior a 26/06/2026;
Todos os RPOs do TSS foram atualizados;
As URLs do TSS foram atualizadas;
A tabela SPED158 contém registros para o modelo ECONSIG;
Os serviços DADOSCONSIGEXTR e DADOSCONSIGNADO estão cadastrados;
Os endpoints da Dataprev estão completos e atualizados;
As URLs correspondem ao ambiente correto;
Os pacotes foram aplicados nos RPOs correspondentes a cada produto.
Recomendações antes da entrada em produção
Antes de iniciar a utilização da integração, recomendamos:
Conferir as datas dos fontes em todos os RPOs;
Validar a comunicação entre Protheus e TSS;
Conferir os parâmetros do Protheus;
Validar os serviços REST;
Executar a consulta da tabela SPED158;
Confirmar os endpoints do modelo ECONSIG;
Realizar testes de consulta e importação;
Validar o retorno da API da Dataprev;
Conferir os dados importados no Protheus;
Registrar as evidências da validação realizada.
Sempre que possível, os testes devem ser realizados inicialmente em ambiente de homologação antes da aplicação em produção.
Conclusão
A integração do eConsignado via API Dataprev depende da atualização e da configuração correta dos ambientes Protheus e TSS.
Além da versão mínima do sistema, é necessário conferir:
As datas dos fontes;
Todos os RPOs envolvidos;
O Web Service REST;
Os parâmetros do Protheus;
O serviço TAF_CFGJOB, quando aplicável;
As URLs do TSS;
Os registros da tabela SPED158;
Os endpoints relacionados ao modelo ECONSIG.
A validação completa desses itens reduz o risco de falhas na consulta e na importação dos dados do Crédito do Trabalhador, tanto nos processos mensais quanto nos rescisórios.
A aplicação das atualizações deve ser realizada com atenção, respeitando a finalidade de cada RPO e as características específicas do ambiente de cada empresa.