Cada vez mais o mercado exige que as operações complexas e manipulação de dados sejam ainda mais ágeis e com custos reduzidos. Com o RH não é diferente, os processos cada vez mais complexos e com muitas inovações e prestadores de serviços no ramo de benefícios para administrar dentro do RH, empresas e softwares especialistas na administração de benefícios estão cada vez mais presentes no mercado e foi neste contexto que surgiu a necessidade da criação de uma interface que torne possível automatizar o envio dos dados que hoje são realizados manualmente do ERP para o softwares especialista, seja feito através de uma interface de integração.
O objetivo desta integração é permitir que a área do RH ou área responsável pelos cadastros, enviem seus dados para o sistema da DIVICOM e assim reduzir o trabalho de inclusão manual de todas as informações dentro do sistema.
Por intermédio desta integração estará disponível a seguinte funcionalidade:
Para habilitar a integração, você deverá proceder da seguinte forma:
Fora do escopo
Por padrão esta integração estará em repositório, porém demanda realizar a devida configuração conforme abaixo:
Exige que os seguintes pontos sejam revisados:
O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release;
Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.
O suporte aos recursos da Integração será de responsabilidade da linha Datasul, onde será analisada pela equipe de suporte da TOTVS.
Esta integração traz a funcionalidade exclusivamente de cadastro de Beneficiários de Plano de Saúde e Plano Odontológico.
Esta integração contempla apenas a consulta e envio dos dados de cadastro de Beneficiários de Plano de Saúde e Plano Odontológico.
A DIVICOM realizará o consumo da API com dados básicos que serão utilizados como parâmetros para consultar a base de beneficiários e retornar um conjunto de informações pertinentes ao Cadastro de Dependentes (FP1760) e Cadastro de Benefícios (BS0080) e retornar os dados para o requisitante.
Para que a Divicom possa ter acesso a dados referentes a Folha de Pagamento, Coparticipação, Funcionários e Beneficiários, você deverá considerar os pré-requisitos descritos abaixo:
Funcionários
É necessário que todos os funcionários estejam devidamente cadastrados no FP1500.
Folha de Pagamento
É necessário que o FP3020 esteja calculado.
Coparticipação
É necessária a utilização do programa BS0470 para que através de um arquivo, realize a importação das informações necessárias.
Beneficiários
É necessária a utilização dos seguintes programas:
BS0460 – Relacionar os benefícios com o contrato do prestador de serviço;
BS0520 - Manutenção Benefícios do Funcionário.
Para realizar a integração com o parceiro TOTVS é necessário as informações básicas de consulta para retorno dos beneficiários desejados;
As Entradas e Saídas de dados tipo data (Date) acompanham o formato padrão YYYY-MM-DDThh:mm.
Parâmetros de Entrada:
Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Parâmetro | Valor Default | Descrição |
page | 1 | Sim | Integer | query | 1 | Página que está sendo requisitada para o retorno. |
pageSize | 1 | Não | Integer | query | 20 | Quantidade de Beneficiários que será retornado por página. |
product | DIVICOM | Sim | String | query | Parâmetro de entrada para processamento das informações (Fixo DIVICOM). | |
datemodified | 2019-01-01T00:00:00 | Não | String | query | Data que será utilizada como filtro para trazer Beneficiários com data de alteração maior ou igual ao informado. | |
branchId | 180 | Sim | String | query | Estabelecimento que será utilizada no filtro da consulta de Beneficiários. | |
companyId | 10 | Sim | String | query | Empresa que será utilizada no filtro da consulta de Beneficiários. |
A autenticação será do tipo Basic Authorization e será obrigatório a utilização de um usuário e senha válido no TOTVS Datasul.
Parâmetros e Chamada do Método:
Para a realização de testes, foi utilizado a ferramenta POSTMAN e após a configuração do server TOTVS Datasul e da API Rest, a requisição deverá ser semelhante a imagem abaixo:
Estrutura: {protocolo}://{host:porta}/{rest}/api/rh/v1/BeneficiariesDataContent/
Retorno da API:
{ "data": { "total": 1, "items": [ { "MedicalAssistanceCard": "", "MaritalState": "C", "IdentityNumberEmitterAgency": "SSP", "DentalAssistanceCardCode": "", "BenefitsVendorCode": "11", "beneficiaryWeight": "84", "identityNumber": "253428221", "code": "6503", "MotherName": "TERESA ROSELI BELARMINO MARIANNO", "beginDate": "2013-10-01T00:00:00", "ContractNumberCode": "C-UNI-123456", "EmployeeCode": "6503", "BenefitCPF": "15538279880", "id": "10|180|6503", "DegreeOfRelatedness": "T", "Name": "NERO PINHEIRO", "Birth": "1975-04-03T00:00:00.000", "SUSCardCode": "898000496776012", "RegistryType": "0", "companyKey": "10", "Gender": "M", "BornAlive": "1", "branch": "180", "FinalDate": "9999-12-01T00:00:00", "BenefitVendorSegmentCode": "1", "beneficiaryTall": "1,78", "BenefitCode": "300" } ], "hasNext": true }, "length": null, "messages": [] } |
Dados utilizados da API
Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM e/ou Protheus) e não existe no Datasul, desta forma cada produto utilizará os campos pertinentes aos seus ambientes.
CAMPOS DATASUL | PROPRIEDADES API REST | DESCRIÇÃO |
---|---|---|
copart_func.cdn_empresa | CompanyKey | Informação referente a Empresa do lançamento do Beneficiário |
prestdor_contrat_benefic.cdn_estab | Branch | Informação referente ao Estabelecimento do funcionário/beneficiário no Produto TOTVS Datasul |
prestdor_contrat_benefic.cdn_funcionario | Code | Informação referente a Matrícula do Funcionário no Produto TOTVS Datasul |
Chave única do Beneficiário, concatenação dos campos de chave única existente na tabela "Beneficiário" (prestdor_contrat_benefic.cdn_empresa | prestdor_contrat_benefic.cdn_estab | prestdor_contrat_benefic.cdn_funcionario) | Id | Concatenação entre o Código da Empresa + Código do Estabelecimento + Código do Funcionário, separando as informações por | (pipe) |
prestdor_contrat_benefic.cdn_prestdor_serv | BenefitsVendorCode | Informação referente ao Código do Prestador de Serviço do benefício do Funcionário no Produto TOTVS Datasul |
Vazio | BenefitVendorInternalId | Identificador Interno do Fornecedor de Benefícios |
prestdor_contrat_benefic.idi_contrat_prestdor | BenefitVendorSegmentCode | Código do tipo de segmento do fornecedor do Benefício: 1 - Assistência Médica | 2 - Assistência Odontológica |
prestdor_contrat_benefic.cdn_beneficio | BenefitCode | Código do Benefício informado no TOTVS Datasul |
Vazio | BenefitInternalId | Identificador Interno do Benefício |
prestdor_contrat_benefic.num_ano_mes_inic_valid | BeginDate | Data de início do benefício ao Funcionário, no formato DataTime |
prestdor_contrat_benefic.num_ano_mes_term_valid | FinalDate | Data de fim do benefício ao Funcionário, no formato DataTime |
prestdor_contrat_benefic.cod_contrat_prestdor | ContractNumberCode | Código do Contrato referente ao benefício relacionado ao Funcionário |
Vazio | ContractNumberInternalId | Identificador interno do Contrato |
prestdor_contrat_benefic.cdn_funcionario | EmployeeCode | Código do Funcionário relacionado ao benefício |
Vazio | EmployeeInternalId | Identificador interno do Funcionário |
prestdor_contrat_benefic.cdn_depend_func | RegistryType | Código do Dependente dentro do Datasul HCM. Quando for o títular (funcionário), o código será 0 (zero) |
depend_func.idi_grau_depen_func | DegreeOfRelatedness | Grau de parentesco do dependente com o Titular: 1 - Filho | 2 - Conjugue | 3 - Pais | 4 - Companheiro | 5 - Dependente Econômico | 6 - Consignado | 7 - Outros |
depend_func.nom_depend_func ou rh_pessoa_fisic.nom_pessoa_fisic | Name | Nome do Dependente do Funcionário no FP1760. Se for o títular (funcionário) será buscado o nome da Pessoa Física no FP1440 |
SUBSTRING(depend_func.cod_livre_1,01,20) ou rh_pessoa_fisic.cod_id_feder | BenefitCPF | CPF do Dependente no FP1760. Se for o títular (funcionário) será buscado o CPF da Pessoa Física no FP1440 |
SUBSTRING(depend_func.cod_livre_2,01,100) ou rh_pessoa_fisic.nom_mae_pessoa_fisic | MotherName | Nome da mãe do Dependente no FP1760. Se for o títular (funcionário) será buscado o Nome da Mãe da Pessoa Física no FP1440 |
depend_func.idi_sexo ou rh_pessoa_fisic.idi_sexo | Gender | Gênero (sexo) do Dependente no FP1760. Se for o títular (funcionário) será buscado o Sexo da Pessoa Física no FP1440 |
depend_func.num_livre_2 ou rh_pessoa_fisic.idi_estado_civil | MaritalState | Estado Civil do Dependente no FP1760. Se for o títular (funcionário) será buscado o Estado Civil da Pessoa Física no FP1440. As opções são: 1 - Solteiro | 2 - Casado | 3 - Divorciado | 4 - Viúvo |
depend_func.dat_nascimento ou rh_pessoa_fisic.dat_nascimento | Birth | Data de Nascimento do Dependente do Funcionário no FP1760. Se for o títular (funcionário) será buscado o Data de Nascimento da Pessoa Física no FP1440 |
rh_pessoa_fisic.cod_id_estad_fisic | IdentityNumber | Carteira de Identidade no FP1440, quando títular (funcionário) |
rh_pessoa_fisic.cod_orgao_emis_id_estad | IdentityNumberEmitterAgency | Orgão Emissor no FP1440, quando títular (funcionário) |
benefic_func.cod_cart_plano_saude | MedicalAssistanceCard | Número da Carteira de Saúde do Dependente no FP0520 |
benefic_func.cod_cart_plano_odonto | DentalAssistanceCardCode | Número do Cartão de Assistência Odontológica no FP0520 |
Vazio | FoodCardsCode | Número do Cartão para Alimentação |
Vazio | MealCardsCode | Número do Cartão para Refeição |
compl_pessoa_fisic.cod_cartao_nac_saude | SUSCardCode | Número do Cartão SUS do títular (funcionário) |
Valor Default "1" | BornAlive | Para o Datasul será um valor fixo (1), pois não se cadastra um dependente quando ele não Nasce Vivo |
rh_pessoa_fisic.vli_peso_pessoa / 100 | BeneficiaryWeight | Peso no FP1440 |
rh_pessoa_fisic.val_estatur_pessoa | BeneficiaryTall | Estatura no FP1440 |
O envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros listados abaixo, cada um com sua respectiva mensagem e solução.
Tratamento de erros de integração Datasul:
Mensagens de Pré-Validação
Erro | Mensagem | Solução | API RESPONSE |
17006 | Parâmetro 'product' incorreto. | Informar DIVICOM de forma fixa no parâmetro 'product'. | |
17006 | O parâmetro 'companyId' incorreto. | Preencher o parâmetro 'companyId'. | |
17006 | O parâmetro 'branchId' incorreto. | Preencher o parâmetro 'branchId'. | |
17006 | Empresa/Estabelecimento inválidos! | Informar valores válidos no TOTVS Datasul para os parâmetros companyId e branchID |
Mensagens de Pós-Validação
Erro | Mensagem | Solução | API RESPONSE |
17006 | Nenhum registro localizado. | Favor informar corretamente os parâmetros para que os dados do TOTVS Datasul sejam corretamente retornados. |
Importante
O campo de Estado Civil é inicializado com a opção "Não informado" por padrão no FP1760. Para garantir que as informações do dependente estejam corretas, é importante que o campo seja ajustado antes de realizar a integração.
Itens a serem verificados durante o atendimento: