Histórico da Página

Quer saber mais e contratar o TOTVS Consignado? Acesse o nosso site  https://www.totvs.com/techfin/consignado, clique em "Ligamos para você" para prosseguir com a contratação do TOTVS Consignado! Ou ainda, contate o Executivo de Serviços e Negócios da sua conta para mais esclarecimentos.

Para que seja possível utilizar a integração do ERP com o Totvs App  é importante ter atenção para a carga dos Conceitos que serão responsáveis pelo envio de dados para Carol e TotvsApps . Esses "Conceitos" serão processados via Jobserver conforme configurado em sua estrutura de criação e serão consumidos seguindo o processo de ativação da integração:

Ativação por RACID 

Parâmetros necessários : clientid e clientsecret

Após a leitura das credenciais do RAC será acionado processo de baixar os arquivos atualizados com a versão disponibilizada na nuvem ( "totvsAppConfig","Conceitos"), inserindo a configuração de execução na tabela GTOTVSAPP e na tabela GTOTVSAPPCONCEITO os Conceitos responsáveis pela subida de dados para a Carol, podendo este processamento ser acompanhado através do recurso para Gerenciamento de Job (GTOTVSAPPCONCEITOHST) .

Para maiores informações clique aqui!

No RM Labore (Administração de Pessoal > Eventos > Eventos), deverá ser cadastrados os eventos com os seguintes código de cálculo 438, 439, 442, 443 e 444 ( mais informações no item 11. LINKS ÚTEIS ).

Para para cada instituição de crédito existente, ou seja, cada parceiro habilitado como conveniado no erp, deverá existir um agrupamento de eventos a serem cadastrados com numeração do código desejada e diferenciada.

• Os eventos cadastrados com os devidos códigos de cálculo do TOTVS Consignado para serem vinculados aos parceiros de crédito nos parâmetros de integração,  conforme detalhamento dos campos a seguir:

  • Evento de desconto de Crédito Consignado:  evento do tipo "Desconto / Valor" tendo obrigatoriamente o código de cálculo 438 informado. Esse evento pode ser calculado por fórmula conforme entendimento de desconto do usuário, tirando como base o evento com código de cálculo 439 que é enviado o valor base da parcela a ser informado pela instituição de crédito.

  • Evento de base de cálculo do valor a ser descontado:  evento do tipo "Base de cálculo / Valor" tendo obrigatoriamente o código de cálculo 439 informado e vinculado a uma Chave desativada. Esse evento terá o valor original do empréstimo consignado a ser lançado na folha de pagamento informado pela instituição de crédito parceira. 

Figura 6 - Exemplo de cadastro de evento com código de cálculo 438.

Atenção sobre as Fórmulas:

• Fórmula Valor - Cálculo do Evento Margem Consignável (c.c: 444)

Para que seja possível uma análise mais consistente pela instituição de crédito no que tange delimitar o score de seus clientes, o TOTVS Consignado permite que a empresa detentora do erp,  defina o valor de margem consignável a ser considerado para o funcionário. Desta forma, conforme os critérios da empresa aplicados é possível dar clareza do valor de análise da instituição de crédito, podendo a regra da fórmula delimitar a 30% do líquido para contratação de empréstimo como demonstramos no exemplo abaixo.

Após cadastrar a Fórmula de Cálculo com a regra desejada, informe a mesma no evento com o código de cálculo 444 que deverá ser do tipo Base de Cálculo , Valor e que vinculado a uma Chave desativada, conforme parâmetros. Obrigatório informar este evento na pasta de "Eventos do grupo" no processo de lançamento de Grupos de evento para os movimentos de Folha de Pagamento mensal para que o mesmo seja enviado para a ficha financeira e consequentemente para a Carol.

Figura 7 - Exemplo de cadastro de Eventos do Grupo

Abaixo segue três exemplos como sugestão de cadastro da fórmula:

1. Exemplo de fórmula:  30% da folha do funcionário no movimento financeiro do mês anterior. 
   

   /*Variável PERIODO deve receber o número do período de Fopagto Mensal*/  

   SE MES=1
     E LIQUIDOFF(ANO-1,12,PERIODO) > 0
   ENTAO LIQUIDOFF(ANO-1,12,PERIODO) * 0.3
   SENAO
   SE MES<>1
     E LIQUIDOFF(ANO,MES-1,PERIODO) > 0
   ENTAO LIQUIDOFF(ANO,MES-1,PERIODO) * 0.3
   SENAO RC * 0.3
   FIMSE
        FIMSE
             FIMSE;

2. Exemplo de fórmula:  30% da folha do funcionário no movimento financeiro atual. 
   

   L * 0.3
   
   

3. Exemplo de fórmula:  30% do salário nominal. 
   

   RC * 0.3

• Fórmula Valor - Cálculo do Evento Desconto (c.c: 438)

Para que seja garantida a legalidade do débito limitado a 30% do líquido para desconto do empréstimo,  deverá ser criada uma Fórmula de Cálculo para receber a regra de cálculo desejada para apuração do desconto. Abaixo segue um exemplo como sugestão de uso. Lembre-se o evento carregará integralmente o valor da parcela imputada para desconto pelo parceiro de crédito no TOTVS Consignado e este valor conforme contrato poderá ter um numerário acima da Margem Consignável aceita para desconto em folha de pagamento laboral.

Exemplo de fórmula:  30% da folha do funcionário no movimento atual. 

/* Onde 'XXXX' deve ser o código do evento de base de cálculo com código de cálculo 439 - BASE DE CÁLCULO EMPRÉSTIMO CONSIGNADO  PLATAF.TOTVS  */

Se C('XXXX') > 0
  entao
Se C('XXXX')>= (L*0.3)
  entao L*0.3
Senao C('XXXX')
FimSe;

Figura 8 - Exemplo de cadastro de evento com código de cálculo 439.

Atenção:

Para os eventos com código de cálculo 442 - DESCONTO DE EMPRÉSTIMO CONSIGNADO RESCISÃO, o cálculo também poderá ser customizável por fórmula conforme o entendimento do usuário. 

No parametrizador do TOTVS RM - Folha de Pagamento (Configurações > Parametrizador > , deverá ser informado os dados necessários para a configuração inicial para realização do processo de integração do ERP com o TOTVS Consignado, conforme detalhamento dos campos a seguir:

Figura 9 - Acesso ao Parametrizador.

Figura 10 - Etapas de Configuração da Conexão e definição dos Eventos pertinentes a integração.

• TOTVS Consignado 1/2
  • Configurações de Conexão:  Dados de acesso ao RAC. Todos os dados são autoexplicativos e devem ser inseridos pela equipe técnica responsável pela manutenção de acessos na base do ERP.
  • Utiliza rateio da Margem Consignável:  Esse parâmetro poderá ser utilizado se existir contrato de parceria de Empréstimo Consignado com mais de uma instituição de crédito, e o usuário desejar ratear a margem consignável entre as instituições de crédito. Ao marcar este campo será habilitado o campo "Fator de Rateio" que  nesse caso terá seu preenchimento obrigatório. 
    • Fator de rateio:  deverá informar nesse campo o fator de divisão entre as instituições de crédito.

    • Exemplo: A empresa possui parceria entre a instituição de crédito A e B. O funcionário possui margem consignável de R$1.000,00. Marcando o parâmetro e informando o fator de rateio igual a 2, será enviado para cada instituição de crédito a margem consignável de R$500,00.

Figura 11 - Exemplo da tela de configuração da conexão - Versões inferiores a 33. (Obrigatório todos os campos de Conexão)

Figura 11.1 - Exemplo da tela de configuração da conexão - Versões igual ou superiores a 33. (Obrigatório o campo de Conexão)

• TOTVS Consignado 2/2
  • Evento de margem consignável: Informe aqui através da digitação do código ou da pesquisa de eventos pelo botão de pesquisa  o evento cadastrado do tipo Valor, Base de Cálculo com o código de cálculo 444 que deverá ter uma fórmula definida para apuração do Valor da Margem Consignável a ser enviada ao TOTVS Consignado.
    "Os eventos de desconto e base de cálculo do Empréstimo Consignado deverão ser definidos por instituição de crédito na Etapa 3 desse processo ( TOTVS Consignado - Eventos Integração)"

Figura 12 - Exemplo da tela de configuração do evento de Margem Consignável.

Atenção: Abaixo segue três exemplos como sugestão de cadastro da fórmula:

1. Exemplo de fórmula:  30% da folha do funcionário no movimento financeiro do mês anterior. 
   

   /*Variável PERIODO deve receber o número do período de Fopagto Mensal*/  

   SE MES=1
     E LIQUIDOFF(ANO-1,12,PERIODO) > 0
   ENTAO LIQUIDOFF(ANO-1,12,PERIODO) * 0.3
   SENAO
   SE MES<>1
     E LIQUIDOFF(ANO,MES-1,PERIODO) > 0
   ENTAO LIQUIDOFF(ANO,MES-1,PERIODO) * 0.3
   SENAO RC * 0.3
   FIMSE
        FIMSE
             FIMSE;

2. Exemplo de fórmula:  30% da folha do funcionário no movimento financeiro atual. 
   

   L * 0.3
   
   

3. Exemplo de fórmula:  30% do salário nominal. 
   

   RC * 0.3

•  TOTVS Consignado - Eventos Integração
  Deverão ser informados os eventos cadastrados com os devidos códigos de cálculo do consignado para serem vinculados aos parceiros de crédito,  conforme detalhamento dos campos a seguir:
  • Evento de desconto de Crédito Consignado:  evento do tipo "Desconto / Valor" tendo obrigatoriamente o código de cálculo 438 informado. Esse evento pode ser calculado por fórmula conforme entendimento do usuário, tirando como base o evento com código de cálculo 439.
  • Evento de base de cálculo do valor a ser descontado:  evento do tipo "Base de cálculo / Valor" tendo obrigatoriamente o código de cálculo 439 informado. Esse evento terá o valor original do empréstimo consignado a ser lançado na folha de pagamento. 
  • Evento de desconto de Crédito Consignado - Rescisão:  evento do tipo "Desconto / Valor" tendo obrigatoriamente o código de cálculo 442 informado. Esse evento pode ser calculado por fórmula conforme entendimento do usuário, tirando como base o evento com código de cálculo 443.
  • Evento de base de cálculo do valor a ser descontado - Rescisão:  evento do tipo "Base de cálculo / Valor" tendo obrigatoriamente o código de cálculo 443 informado. Esse evento terá o valor original a ser lançado na rescisão do funcionário.

Figura 13 – Parametrização da integração com o TOTVS Consignado.

IMPORTANTE:  Para cada instituição de crédito, informe os eventos de desconto e base de cálculo que devem ser específicos para cada parceiro, ou seja, não poderá ser utilizado o mesmo evento em instituições de crédito diferentes. Cada uma deverá ter o seu evento distinto respeitando as regras citadas acima de cadastro. Exemplo:

Figura 14 – Configuração dos Eventos Desconto e Base por Instituição de Crédito

• Etapa 54 - Eventos de Integração
  • Deverá ser marcado a flag referente ao TOTVS Consignado para que seja possível a integração dos descontos em folha de pagamento via Grupo de Eventos, conforme imagem abaixo:

Figura 15 - Etapa do Parametrizador pertinente

• Caso seja definido a utilização de Rateio de Margem consignável entre os parceiros de crédito, faz-se necessário a distribuição do percentual referente a margem através do cadastro do funcionário configurado de forma individual. Para isso acesse o cadastro de funcionários(Administração de Pessoal > Funcionários) através da opção Anexos > Folha de Pagamento > Distribuição da margem consignável ,  conforme detalhamento dos passos a seguir:

Figura 16 – Parametrização da Distribuição do rateio da margem consignável.

IMPORTANTE: Para acessar a Distribuição da margem consignável , é necessário fornecer permissão para o perfil do usuário. No RM, acesse a opção Serviços Globais > Segurança > Perfis > Sistema > RH : Folha de Pagamento.

Figura 17 – Liberação de Acesso no Perfil de Usuários.

• Ao incluir um novo registro, será apresentada a tela de edição para informar o percentual de rateio das margens. Selecione a instituição de crédito pelo botão [...]  através das opções disponibilizadas. 
• No campo Percentual informe o valor a ser estabelecido para apuração daquela instituição de crédito. A soma de todos os rateios distribuídos deverá alcançar o total de 100%.
  • Exemplo 1: Funcionário não deseja ratear sua margem consignável e deseja que seja considerado o total em 100% para determinada instituição de crédito.

 Figura 18 – Cadastro do rateio de distribuição da margem consignável.

• Exemplo 2: Líquido do Funcionário X no mês MM/AAAA    -     Liquido R$1.000,00           Margem consignável calculada: 300,00             

  Fator de Rateio: 2, só que o funcionário deseja dividir sua margem em:

                            Instituição de crédito 1 = 50%         Instituição de crédito 2 = 25%       Instituição de crédito 3 = 25%

Nesse exemplo os valores de margem consignável para cada instituição financeira será:

     Instituição de crédito 1 = R$150,00         Instituição de crédito 2 = R$75,00       Instituição de crédito 3 = R$75,00

Figura 19 – Visão da Distribuição do rateio da margem consignável para funcionário selecionado. 

IMPORTANTE:  Todo rateio deve respeitar a distribuição de 100% de seu percentual, desta forma, na tela de edição irá apresentar uma informação orientativa em destaque, até que toda distribuição seja realizada.

 Figura 20 – Cadastro do rateio de distribuição da margem consignável. Tela de alerta

No RM Labore (Administração de Pessoal > Eventos > Eventos), deverá ser cadastrados os eventos com os seguintes código de cálculo 453, 454, 455, 456 ( mais informações no item11. LINKS ÚTEIS ).

Toda regra de cálculo é realizada pelo módulo de Folha de Pagamento e para saber mais clique aqui! 

• Os eventos cadastrados com os devidos códigos de cálculo do TOTVS Consignado para serem vinculados serão utilizados no processo de cálculo do recibo e lançamento das férias,  conforme detalhamento dos campos a seguir:

  • PROVISÃO EMPRÉSTIMO CONSIGNADO FÉRIAS 1o. MÊS:  evento do tipo "Desconto / Valor" tendo obrigatoriamente o código de cálculo 453 informado. Esse evento buscará o valor do desconto do empréstimo consignado do mês anterior (evento na ficha financeira com código de cálculo 438) e provisionará o próximo desconto referente a competência vigente no recibo de férias, conforme dias dentro do mês

  • PROVISÃO EMPRÉSTIMO CONSIGNADO FÉRIAS 2o. MÊS:  evento do tipo "Desconto / Valor" tendo obrigatoriamente o código de cálculo 454 informado. Esse evento buscará o valor do desconto do empréstimo consignado do mês anterior (evento na ficha financeira com código de cálculo 438) e provisionará o próximo desconto referente a competência vigente no recibo de férias, conforme dias dentro do próximo mês
  • PROVISÃO EMPRÉSTIMO CONSIG.FÉRIAS 1o. MÊS ENVELOPE :  evento do tipo "Provento / Valor" tendo obrigatoriamente o código de cálculo 455 informado. Esse evento buscará o valor do desconto do empréstimo consignado provisionado no recibo de férias (evento com código de cálculo 453) e espelhará o mesmo no envelope de pagamento para ajuste de movimento do adiantamento conforme recibo , referente a competência dos dias de férias no mês vigente (dias dentro do mês) após processo de lançamento das férias
  • PROVISÃO EMPRÉSTIMO CONSIG.FÉRIAS 2o. MÊS ENVELOPE :  evento do tipo "Provento / Valor" tendo obrigatoriamente o código de cálculo 456 informado. Esse evento buscará o valor do desconto do empréstimo consignado provisionado no recibo de férias (evento com código de cálculo 454) e espelhará o mesmo no envelope de pagamento para ajuste de movimento do adiantamento conforme recibo , referente a competência dos dias de férias no próximo mês (dias dentro do próximo mês) após processo de lançamento das férias

No RM Labore (Administração de Pessoal > Eventos > Eventos), deverá ser cadastrados os eventos com os seguintes código de cálculo 442 e 443,  ( mais informações no item 11. LINKS ÚTEIS ).

  Para saber sobre a integração do saldo devedor para quitação do empréstimo  clique aqui! 

                  •  Evento de desconto de Crédito Consignado - Rescisão:  evento do tipo "Desconto / Valor" tendo obrigatoriamente o código de cálculo 442 informado. Esse evento pode ser calculado por fórmula conforme entendimento do usuário, tirando como base o evento com código de cálculo 443.

                  •  Evento de base de cálculo do valor a ser descontado - Rescisão:  evento do tipo "Base de cálculo / Valor" tendo obrigatoriamente o código de cálculo 443 informado e vinculado a uma Chave desativada. Esse evento terá o valor original a ser lançado na rescisão do funcionário.

• Fórmula Valor - Cálculo do Evento Desconto (c.c: 442)

Para que seja garantida a legalidade do débito limitado a 30% do líquido para desconto do  saldo devedor para quitação do empréstimo,  deverá ser criada uma Fórmula de Cálculo para receber a regra de cálculo desejada para apuração do desconto. Abaixo segue um exemplo como sugestão de uso. Lembre-se o evento carregará integralmente o valor do saldo devedor para desconto pelo parceiro de crédito no TOTVS Consignado.

Exemplo de fórmula:  30% da folha do funcionário no movimento atual. 

/* Onde 'XXXX' deve ser o código do evento de base de cálculo com código de cálculo 443 - DESCONTO EMPRÉSTIMO CONSIGNADO RESCISAO  */

Se C('XXXX') > 0
  entao
Se C('XXXX')>= (L*0.3)
  entao L*0.3
Senao C('XXXX')
FimSe;

O processo de integração dos dados do TOTVS Consignado com o ERP é simples e não precisa de interação do usuário além das configurações realizadas nas etapas anteriores citadas neste documento. Apenas é solicitado a confirmação de realização do processo por tabelas internas serão preenchidas neste momento, considerando os dados apurados no TOTVS Consignado para a competência em questão.

Figura 22 - Tela de confirmação do processo de integração.

Figura 23 - Tela de acompanhamento do Progresso de execução do processo.

Figura 24 - Tela esperada após conclusão do processo de integração.

IMPORTANTE: Caso não for concluído com sucesso a validação da integração, verifique a exceção apresentada conforme Log de Exceções apresentados neste documento.

Após a finalização do processo de integração, você poderá acompanhar os movimentos que formam importados para a base do ERP (tabela PFMOVTEMP) , bem como possíveis causas de insucesso na conclusão do processo, conforme detalhamento a seguir:

• Exceções consideradas e tratadas com as seguintes mensagens:

              - Na obtenção dos dados plataforma Consignado:

                            - Algum dos dados da integração com o TOTVS Consignado não está preenchido.

              - Na obtenção de seções centralizadoras:

                            - Nenhuma seção centralizadora encontrada.

              - Na obtenção do token do rac:

                            - O token de acesso não pode ser obtido.

                                           - Código 404 (not found) na obtenção do token de acesso, possivelmente existe uma parametrização errada na sua URL da plataforma do RAC.

                                           - Código 400 (bad request) na obtenção do token de acesso, possivelmente existe uma parametrização errada nos dados de cliend_id e client_secret.

                                           - Código 500 (internal server error) ocorreu um erro inesperado do lado do servidor do RAC.

              - Na obtenção das parcelas do consignado:

                            - Nenhum evento de folha cadastrado.

                            - Nenhuma parcela a ser consumida do TOTVS Consignado na competência {0}/{1}.      

• Eventos descritos no Log resultante do processo de integração:

              - Integração TOTVS Consignado

                            - Foram encontradas {0} parcelas para serem importadas na competência {1}/{2}.

                            - Uma parcela de valor {0} na competência {1}/{2}, para a matrícula de funcionário {3}, não foi inserida.

Figura 25 - Exemplo da Tela de Logs

Para acompanhar os movimentos integrados pela plataforma TOTVS Consignado (tabela PFMOVTEMP) , utilize a ferramenta abaixo que permitirá um acompanhamento do que irá ser gravado na tabela financeira dos funcionários para a competência em questão.

    Figura 26 - Tela de acesso a consulta

• Para facilitar a busca, você poderá criar um filtro aplicando apenas a regra da Origem do Evento = TOTVS Consignado ou Tipo Lançamento = Parcela do empréstimo consignado conforme abaixo :

 Figura 27 - Exemplo da Consulta de Movimento Integração (tabela PFMOVTEMP), carregada pela integração a ser consumida no Grupo de Eventos

No Totvs RM Folha de Pagamento, acesse o menu Rescisão, chamando o ícone "Importar Parcelas Saldo Devedor Totvs Consignado", conforme imagem abaixo.

Figura 27 - Tela de acesso a consulta do saldo devedor 

Acessando o menu deverá preencher na tela importar o saldo devedor Totvs Consignado, o Mês e Ano da competência do lote a ser importado e após selecione o botão Buscar. Assim será listado todos os lotes da competência que foi selecionada, após escolher o lote a ser importado selecione o botão executar. 

Figura 28 - Tela de importar saldo devedor Totvs Consignado.

Figura 29 - Tela de confirmação da importação do Saldo devedor.

Figura 30 - Tela esperada após conclusão do processo de integração.

• • Após a finalização do processo de integração, você poderá acompanhar os movimentos que foram importados para a base do ERP (tabela PFMOVTEMP), acessando a tela Consulta movimento integração .

IMPORTANTE: Caso não for concluído com sucesso a validação da integração, verifique a exceção apresentada conforme Log de Exceções apresentados neste documento.

Para acessar o menu importação saldo devedor Totvs Consignado, é necessário fornecer permissão para o perfil do usuário. No RM, acesse a opção Serviços Globais > Segurança > Perfis > Sistema: Folha de pagamento.

Figura 31 - Tela de permissão para acesso a integração do saldo devedor.

Para a importação para a folha de pagamento, o grupo de eventos de lançamento de movimento deve ser marcado os campos em destaque abaixo para que a integração TOTVS Consignado (arquivo PFMOVTEMP) sejam carregados no movimento do Funcionário para a competência em questão.

Figura 32 – Tela de Grupo de Eventos - Lançar eventos de integração com outros aplicativos.

Figura 33– Tela de Grupo de Eventos - TOTVS Consignado

Figura 34- Exemplo de cadastro de Eventos do Grupo

Para verificar o lançamento da verba de empréstimo na folha do funcionário, basta acessar o Envelope de Pagamento: Anexos > Movimento > Envelope de Pagamento.

Figura 35– Verba de Empréstimo importada pela integração para a folha do funcionário.

Para a importação na rescisão deverá ser marcado o campo em destaque abaixo para que a integração TOTVS Consignado (arquivo PFMOVTEMP) sejam carregados no movimento  de rescisão do Funcionário para a competência em questão.

Figura 36 – Parâmetros da Rescisão

Para verificar o lançamento da verba sado devedor na folha do funcionário, basta acessar o Envelope de Pagamento: Anexos > Movimento > Envelope de Pagamento.

Figura 37– Verba de Saldo devedor importada pela integração para a folha do funcionário.

Realizado através do cadastro de rescisão individual do funcionário. Após realizar o preenchimento dos dados referente ao aviso, na aba Rescisão será apresentado o campo: "Enviar dados para o TOTVS Consignado". 

Figura 38 – Menu de cadastro de rescisão.

Como padrão, o campo já vem preenchido como Não (enum=1) identificando que a instituição somente será avisada da rescisão ao liberar a competência e caso o RH desejar que a rescisão em questão seja informada antecipadamente, deverá alterar o campo para Sim (enum=2).

ATENÇÃO: Para rescisões do tipo 5 e 6, o campo não será exibido.

Figura 39– Campo para envio dos dados dentro do cadastro de rescisão.

IMPORTANTE: As rescisões que não forem enviadas antecipadamente, serão enviadas como confirmadas (enum=4) quando for realizada a liberação de competência.

Para facilitar o envio de informações para a instituição de crédito de forma global, permitindo assim que o RH da empresa por contrato possa se organizar no envio destes dados e realizá-lo em grupo de dados, será possível a utilização do processo de "Autorização envio de dados da rescisão para o TOTVS Consignado". Neste caso, poderá aplicar filtros, definindo assim o grupo de pessoas que se deseja enviar de forma antecipada para a credora. 

Os campos de data vão contemplar as rescisões que estão cadastradas dentro do período informado. A data deve estar dentro do intervalo do primeiro dia da competência atual até o último dia da próxima competência.

Ao confirmar o processo de autorização será enviado de forma antecipada os dados para a instituição de crédito como previsibilidade (poderá ser reversível pela revogação antes da virada de competência). O processo de revogação cancelará esse envio antecipado, contudo, os dados serão enviados como confirmados após a liberação de competência.

Figura 40– Processo de autorização e revogação de envio de dados da rescisão.

Figura 41– Tela do processo de autorização e revogação de envio de dados da rescisão.