Histórico da Página

CONTEÚDO

Versões
Visão Geral
Solução

Exemplo de utilização

Tela

Integração

API Swile

Principais Campos e Parâmetros

Tela De/Para Benefícios Terceiro
1. Principais Campos e Parâmetros
Tela Integração Benefícios com Swile
1. Principais Campos e Parâmetros
1. de Funcionários
2. Integração de Pedidos
3. Integração de Funcionários e Pedidos
Demais informaçõesTabelas utilizadas

01. VERSÕES

Informações

icon	false

A partir do Releasedas versões:

12.1.2302e Superiores.253
12.1.2306.206
12.1.2310.139

02. VISÃO GERAL

Foi criada a Integração Swile que permite aos usuários do Novo processo que permitirá com que as empresas que utilizam o processo de Controle de Benefícios do módulo TOTVS Gestão de Pessoas (Linha RM) , utilizar sua solução integrada com os benefícios fornecidos pela Swile. Esta integração vai desde a carga de dados dos funcionários, coligadas, filias até o gerenciamento da carteira de benefícios que será ofertada aos funcionários.

Através da solução, será possível enviar funcionários e pedidos para a base de dados da swile, informando o tipo de benefício vinculado ao funcionário, valores a serem creditados, nova carteira de benefícios para um grupo de funcionários e atualizar os dados dos funcionários e seu grupo de benefícios.

...

enviem os valores dos benefícios calculados para uma carteira de benefícios da Swile, para serem utilizados pelos seus colaboradores através de um cartão de credito de benefícios disponibilizado pela Swile, com a possibilidade de utilização do saldo de forma flexível, dentro das opções contratadas pela Empresa x Swile

03. SOLUÇÃO

Foi criada a configuração para ativar a integração com a Swile e informar os dados: Id Work Group, Usuário, Senha e URL Base

Criada uma tabela auxiliar para vincular os códigos de Benefícios do RM com os códigos de Benefícios da Swile

Criado um processo para enviar os dados necessários através da API interna do sistema:

Os dados dos funcionários (nome, CPF, telefone, e-mail, sexo, data de nascimento, situação

...

).
Os

...

dados do pedido informados na Tela de Pedidos de Benefícios (CPF do funcionário, CNPJ da coligada, Código do benefício

...

Swile associado e valor do benefício).

Para que seja utilizada a integração, haverá a necessidade de configurar os benefícios no módulo de Benefícios (TOTVS Gestão de Pessoas) e vinculá-los aos benefícios da Swile na tela do De/Para Benefício Terceiro.

Após realizada a configuração dos benefícos Após realizada a ativação da integração e a configuração dos Benéficos RM x Swile, o usuário deverá utilizar o módulo processo de Integração Benefício com Swile para enviar os dados Dados do funcionário e os dados de o Pedidos de Benefícios.

Antes de iniciar os envios de funcionários e pedidos será necessário criar no Portal Swile as parametrizações para que seja feita a integração.

Deverão ser criados os Grupos de Benefícios, Empresas e filiais. Esses dados serão utilizados para gerenciamento dos dados para emissão de nota fiscal de pedidos e também para vincular o grupo de benefícios que os funcionários receberão no cartão multi-uso da Swile.

A empresa que adquirir os serviços da Swile deverá verificar e configurar as informações de acordo com o contrato firmado antes de iniciar a integração, pois a Swile disponibiliza uma série de produtos (benefícios) customizados para cada tipo de empresa e funcionários.

03. EXEMPLO DE UTILIZAÇÃO

Vamos supor que a empresa X contratou o pacote de benefícios da Swile e está fazendo a configuração para enviar os funcionários para cadastro no Portal Swile e os pedidos de benefícios para os funcionários. Os dados (Id Work Group, Usuário, Senha e URL Base) repassados para integração da Swile com a empresa X foram:

Image Removed

04. EXEMPLO DE UTILIZAÇÃO

Para fazer o envio de dados de funcionários e pedidos para a Swile é necessário marcar o parâmetro 'Ativar Integração com Swile', em Em Totvs Gestão de Pessoas | Configurações | Parâmetros | Configurações | Integração com Terceiros e APIs | APIs | Integração API Swile, marcar o parâmetro 'Ativar Integração com Swile'. Após marcar o parâmetro, serão habilitados os campos para preenchimento, conforme a seguiro exemplo abaixo:

Esta mesma empresa X contratou a carteira de benefícios que contém os benefícios PAT e PAT_FLEXIBLE da Swile. Na Swile os Benefícios PAT e PAT_FLEXIBLE tem no pacote de benefícios os códigos v5 e v7, respectivamente.

Em Considerando em Totvs Gestão de Pessoas | Valorização | Controle de Benefícios | Benefícios e Remuneração Variável, criar os benefícios abaixo que serão fornecidos para os funcionários:

Em Totvs Gestão de Pessoas | Valorização | Controle de Benefícios | Tabelas Auxiliares | De/Para Benefícios Terceiro, vincular os o Benefício RM x ao Benefício Swile:.

Image Added

Image Removed

Em Para executar o processo de envio de funcionários e benefícios para a Swile, deverá ir em Totvs Gestão de Pessoas | Valorização | Controle de Benefícios | Processos | Integração Benefício com Swile, clique clicar em Avançar e será apresentada a tela abaixo:

Image AddedImage Removed
card-documentos

Aviso

...

Informacao	Antes de enviar os funcionários será necessário ajustar os campos do cadastro de funcionários de acordo com a especificação da Swile.
Titulo	IMPORTANTE!

Segue abaixo um quadro com informações que poderão ser úteis no processo de preparação da base de dados para a integração dos funcionários com o Portal Swile:

...

Código do banco da conta bancária do colaborador informada na pasta Conta Bancária Principal (Cadastro de Funcionários).

...

Numeração da agência da conta bancária do colaborador informada na pasta Conta Bancária Principal (Cadastro de Funcionários).

...

title	Detalhes Importantes

Para avançar no processo, é necessário que seja selecionado ao menos 1 das duas opções ou Envio de Funcionários ou Envio dos Pedidos de Beneficios. Caso não selecione uma das duas opções, será exibida a seguinte mensagem de alerta:

Image Added

Com a flag ativa para Enviar Pedidos de Benefícios, é necessário atentar-se às seguintes regras:

1. A Data de Crédito deve ser no mínimo posterior a dois dias da Data de Hoje.Isso serve para termos uma maior flexibilidade no pagamento do boleto e não atrase a data de crédito, tendo em vista que geralmente os bancos tendem a compensar o pagamento em até 1 dia.Caso selecione uma data menor ou igual a dois dias da data de Hoje e tente avançar, será exibida a seguinte mensagem:

Image Added

2. A Data de Pagamento do Boleto deve anteceder no minimo dois dias da Data de Crédito, pensando também nos prazos de pagamento e compensação do mesmo. Caso cadastremos uma data diferente desta regra, será exibida a mensagem de alerta, não permitindo o avanço no processo.

Image Added

a. INTEGRAÇÃO DE FUNCINÁRIOS

Para executar o processo de envio de funcionários para a Swile, deverá ir em Totvs Gestão de Pessoas | Valorização | Controle de Benefícios | Processos | Integração Benefício com Swile, clique em Avançar e na tela apresentada marcar a opção Enviar Funcionários:

Image RemovedImage Added

Após marcada a opção 'Enviar Funcionários', informar os parâmetros 'Quebra de Seção', 'Seleção de Funcionários', 'o 'Tipo de Atualização Funcionário (Ignorar/Substituir)', 'Enviar Email de Boas Vindas' e 'Data do Email de Boas Vindas'., conforme desejado

Após executar o processo será apresentado o log com o retorno da integração realizada

Image Added

Abaixo iremos exemplifica possíveis retornos Preparamos para vocês usuários, um quadro com alguns possíveis erros que serão apresentados no Logs de Execução ( Aviso, Debug e Execução) ao realizar a integração de funcionários:.

00001Aviso

Validação	Coligada	Chapa	Tipo do Log	Descrição do erro ou aviso	Coligada 1
Telefone menor que 10 dígitos	Coligada: X Chapa: xxxxx	Aviso	O campo Telefone é de preenchimento Obrigatório. Funcionário não será integrado.	Coligada 1	00002	Aviso	O Campo de Telefone 3815566 3326565 sem caracteres de formatação 3815566 3326565 deve ter de 11 ou 10 digitos dígitos numérico.	Coligada 1	00003
Telefone não informado	O campo Telefone é de preenchimento Obrigatório. Funcionário não será integrado.
E-mail não informado	O campo EMail Email é de preenchimento Obrigatório. Funcionário não será integrado.
Coligada 1	00004	Debug	Dados Invalidos. Não será Integrado
Coligada 1	Todos	Execução	Coligada: 1 - ---------------------------------------------------------- Total de Funcionário a Integrar : 13 Total de Erros: 0 Total de Avisos: 14 Início do Processo: 10/04/2023 06:25:46.723 Final do Processo: 10/04/2023 06:25:49.163 Tempo Decorrido do Processo: 00:00:02.440
Coligada 1	Todos	Execução	Parâmetros do processo ====================== Quebra de Seção: ?? Enviar Funcionários: Sim Tipo de Atualização Funcionário Ignorar atualização Enviar Email de Boas Vindas: Não Enviar Pedidos de Benefícios: Não
E-mail inválido	Integração de Funcionário não realizada devido a Erro no envio dos Dados para Requisição. 3 - Dados inválidos: Nome do Colaborador (CPF Colaborador) com e-mail inválido (e-mail enviado).
E-mail já cadastrado para outro colaborador	Integração de Funcionário não realizada devido a Erro no envio dos Dados para Requisição. 2 - Colaborador: Nome do Colaborador (CPF Colaborador) com e-mail já cadastrado (e-mail já existente).
CPF já cadastrado	Integração de Funcionário não realizada devido a Erro no envio dos Dados para Requisição. 2 - Colaborador: Nome do Colaborador (CPF Colaborador) com CPF já cadastrado.

Observações

Quando existe mais de um funcionário vinculado a mesma pessoa, a integração verifica o vínculo de contrato mais recente para enviar. Isto se deve ao fato da Swile validar a pessoa (dados pessoais) e não contrato de trabalho. Caso integrasse os dois vínculos, retornaria erro de duplicidade de Colaborador. Com isto não é necessário enviar novamente a pessoa através do processo de integração em caso de cadastro de novo vínculo.
Quando um vínculo é demitido, é possível enviar a atualização do cadastro do funcionário para Swile através da integração marcando a opção 'substituir'. O Colaborador é inativado na Swile, porém a Swile não valida se o colaborador está ativo ou não para receber o pedido de benefício do Colaborador. Neste caso, é importante se atentar quando for enviar os pedidos se está com o filtro dos funcionários desejados.
Uma vez que o Colaborador está inativo no portal da Swile, não é possível ativar novamente a mesma pessoa através da integração, pois a Swile não trata essa ativação através da API. Quando enviado o cadastro de um colaborador inativo na Swile, o parceiro tenta cadastrar novamente o Colaborador. Neste caso, é retornado erro de colaborador já existente. Para ativar o colaborador no portal da Swile o mesmo deve ser feito através o portal do parceiro.
O envio de e-mail de boas-vindas é opcional.
Não é feita a integração do cadastro do dependente para a Swile, somente do colaborador. Caso exista benefícios lançados para o dependente o mesmo será enviado como pedido, vinculando ao colaborador.

b. INTEGRAÇÃO DE PEDIDOS

Para o envio de Pedidos de Benefícios para a Swile, Após enviar os funcionários, deverá ser realizado o envio de Pedidos de Benefícios da Swile. Para isso deverá marcar a opção 'Enviar Pedidos de Benefícios', e informar os parâmetros 'Quebra de Seção', 'Seleção de Funcionários', 'Definir benefícios específico', 'Cód. Benef.', 'Data do Crédito' e 'Data Limite'.

Image RemovedImage Added

Após o envio do Pedido de Benefício Swile, serão apresentados os Logs de Execução (Aviso, Debug e Execução), com as informações do envio do pedido, conforme abaixo:

1) Exemplo de Log (Debug):

Image Removed

. Neste exemplo, temos o resumo do pedido com os dados de cabeçalho (Titulo Pedido de Benefício - Coligada x, o Total do Pedido, Total de Colaboradores, Total de Itens e Data do Crédito) e logo depois o corpo do Log trará os dados do dos Benefícios por colaborador CPF, Código do Benefício RM, Código do Benefício Swile, Valor e Total do Colaborador.

2) Exemplo de Log (Execução):

Image Removed

No log de Execução, será apresentado o cabeçalho contendo (Coligada x, Total de Erros, Total de Avisos, Início do Processo, Final do Processo, Tempo decorrido do Processo) e os Parâmetros do processo (Quebra de Seção, Enviar Funcionários, Enviar Pedidos de Benefícios, Definir benefício específico, Data de Crédito e Data Limite).

04. TELA Integração API Swile

Image Removed

Principais Campos e Parâmetros

...

05. TELA De/Para Benefícios Terceiro

Image Removed

Principais Campos e Parâmetros

...

Card documentos

Informacao	Antes de iniciar a configuração dos benefícios deverá verificar a carteira de benefícios contratada com a Swile e criar os benefícios no TOTVS Gestão de Pessoas, em concordância com o código informado pela Swile.
Titulo	IMPORTANTE!

06. TELA Processo - Integração Benefícios com Swile

Image Removed

Principais Campos e Parâmetros

...

Image Added

Abaixo iremos exemplificar possíveis retornos da Swile que serão apresentados no Logs de Aviso, Debug e Execução.

Validação

Descrição do erro ou aviso

Código de Benefício Swile inválido

Integração de Pedido não realizada devido a Erro no envio dos Dados para Requisição.

3 - Dados inválidos: Processado com erros, favor visualizar os logs de processamento.

Data de Credito menor que o dia da geração

Integração de Pedido não realizada devido a Erro no envio dos Dados para Requisição.

3 - Dados inválidos: Data de crédito dd/mm/yyyy 00:00 inválida, data de liberação de carga deve ser pelo menos 0 dias úteis a frente para que haja tempo suficiente para compensação bancária do seu pagamento.

Colaborador não cadastrado no portal da Swile

Integração de Pedido não realizada devido a Erro no envio dos Dados para Requisição.

3 - Dados inválidos: Processado com erros, favor visualizar os logs de processamento.

Observações

É necessário ter o funcionário cadastrado na Swile para poder realizar um pedido. Caso não exista, será necessário cadastrá-lo pelo Portal da Swile ou utilizando a integração de funcionários.
A Swile valida a data de credito do pedido, devendo ser maior que o dia da geração do pedido.
Quando vinculado mais de um benefício RM a um mesmo benefício da Swile, os valores lançados para o funcionário e/ou dependentes são acumulados no mesmo código de benefício da Swile e enviados via API.
O processo de integração verifica data limite informado na tela do processo se está dentro da vigência benefícios lançados para o funcionário conforme ocorre no Lançamento de Benefícios de Funcionários para Folha de Pagamento.

Exemplo:

Competência: 01/2024

Data limite informada no processo: 31/01/2024

Benefício RM	Data Início	Data Término	Comportamento na Integração
00001	01/01/2024	30/01/2024	Será integrado, pois está dentro da vigência
00002	01/01/2024	-	Será Integrado, pois a data início é anterior ao dia 31/01 e não tem data fim. Neste caso, esse benefício sempre entrará na integração se for lançado
00003	01/02/2024	28/02/2024	Não será integrado pois inicia após o dia 31/01
00004	01/12/2023	31/12/2023	Não será integrado pois a data término é menor que a competência da base.

É possível fazer pedidos de benefícios específicos, informando o código de benefício RM no processo de integração.
Não é feito a verificação de pedidos de benefícios duplicados, pois a Swile não faz esta verificação, podendo o usuário enviar quantos benefícios desejar. Neste caso deve ficar atento para não enviar o mesmo benefício de forma duplicada.
Não é feito o cancelamento de pedido de benefício via API, mesmo se o pedido constar como pendente no portal da Swile. Esse controle é todo gerenciado através do portal pelo Usuário

c. INTEGRAÇÃO DE FUNCIONÁRIOS E PEDIDOS

Para o envio de funcionários e Pedidos de Benefícios para a Swile, deverão ser marcadas as opções 'Enviar Funcionários' e'Enviar Pedidos de Benefícios', informar os parâmetros ''Tipo de Atualização Funcionário (Ignorar/Substituir)', 'Enviar Email de Boas Vindas', 'Data do Email de Boas Vindas', ''Data do Crédito' e 'Data Limite'.