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 para que possibilite 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.
Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na integração).
O objetivo desta integração é permitir que a área do RH ou área responsável pelos benefícios, envie os dados de funcionários para o sistema da DIVICOM e assim redução no trabalho de inclusão manual de todas as informações dentro do sistema.
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 TOTVS Datasul onde será analisada pela equipe de suporte da TOTVS.
Esta integração traz a funcionalidade exclusivamente para Calculo de Plano de Saúde e Histórico de Calculo de Saúde
Esta integração contempla apenas a consulta e envio dos dados de Calculo de Plano de Saúde e Histórico de Calculo de Saúde.
A DIVICOM realizará o consumo da API com dados básicos que serão utilizados como parâmetros para consultar a base e retornar um conjunto de informações pertinentes ao Calculo de Plano de Saúde e Histórico de Calculo de Saúde para o requisitante.
Para realizar a integração com o parceiro TOTVS é necessário as informações básicas de consulta para retorno dos funcioná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 | Página que está sendo requisitada. | |
pageSize | 1 | Não | Integer | query | 100 | Quantidade de funcionários por página. |
product | DIVICOM | Sim | String | query | Valor FIXO | |
datemodified | 2001-01-01T18:25:43 | Não | String | query | Data que será utilizada como filtro para trazer funcionários com data de alteração(RA_USERLGA) | |
branchId | 180 | Sim | String | query | Estabelecimento que será utilizada no filtro da consulta de Folha. | |
companyId | 10 | Sim | String | query | Empresa que será utilizada no filtro da consulta de Folha. | |
providerType | A | Sim | String | query | Tipo de Contrato que será utilizado no filtro da consulta - 1 (Assistência Médica), 2 (Assistência Odontológica) ou A (Ambos) |
Parâmetros e Chamada do Método:
Para a realização de testes foi utilizado a ferramenta SOAP UI e após a configuração do server TOTVS Datasul a API Rest, a requisição deverá ser semelhante a imagem abaixo:
{protocolo}://{host}/{api}//rh/v1/payrollcontrol/
Response da API:
{ "data": { "total": 1, "items": [ { "Branch": "180", "CompanyKey": "10", "ProductCode": "300", "MovimentDate": "2019-06-09T15:40:00.000", "InternalIdCode": "", "PaymentDate": "31/12/14", "Code": "6503", "ContractCode": "C-UNI-123456", "ProviderCode": "11", "PaymentAmount": " 5.00", "Id": "", "ProviderType": "1-Assistência Médica", "OriginalRecord": "", "PayrollIdentifier": "10|180|6503|2014|12|1|9|0", "PaymentPeriod": "201710" } ], "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 TOTVS Datasul, desta forma cada produto utilizará os campos pertinentes aos seus ambientes.
CAMPOS DATASUL | PROPRIEDADES API REST | DESCRIÇÃO |
---|---|---|
prestdor_contrat_benefic.cdn_estab | Branch | No Datasul HCM esta informação é o código do Estabelecimento da tabela Funcionário (FP1500) |
prestdor_contrat_benefic.cdn_empresa | CompanyKey | Informação referente ao código da Empresa |
Vazio | Id | Não utilizado para a linha Datasul |
prestdor_contrat_benefic.cdn_funcionario | code | Código do Funcionário cadastrado no programa FP1500 |
Vazio | internalIdCode | Não utilizado para a linha Datasul |
prestdor_contrat_benefic.dat_ult_atualiz | movimentDate | Data referente a data da última alteração do benefício no funcionário |
Vazio | originalRecord | Não utilizado para a linha Datasul |
prestdor_contrat_benefic.cdn_prestdor_serv | providerCode | Código do Prestador de Serviço do evento da Folha de Pagamento do Funcionário |
prestdor_contrat_benefic.idi_contrat_prestdor - Descrição do idi_contrat_prestdor | providerType | Junção do código + descrição do Tipo de Contrato |
prestdor_contrat_benefic.cod_contrat_prestdor | contractCode | Código do Contrato referente ao Prestador do Benefício |
predtdor_contrat_benefic.cod_beneficio | productCode | Código do Benefício relacionado ao Funcionário |
movto_calcul_func.cdn_empresa | movto_calcul_func.cdn_estab | movto_calcul_func.cdn_funcionario | movto_calcul_func.num_ano_refer_fp | movto_calcul_func.num_mes_refer_fp | movto_calcul_func.idi_tip_fp | movto_calcul_func.qti_parc_habilit_calc_fp | movto_calcul_func.num_seq_movto_calcul_fp | payrollIdentifier | Chave única que identifica o Movimento da Folha calculada para o Funcionário |
movto_calcul_func.val_calcul_efp | paymentAmount | Valor pago pelo Funcionário |
movto_calcul_func.dat_pagto_salario | paymentDate | Data do pagamento que o Funcionário realizou |
movto_calcul_func.num_ano_refer_fp + movto_calcul_func.num_mes_refer_fp | paymentPeriod | Período referente ao movimento de pagamento do funcionário |
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 TOTVS Datasul:
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 | |
17006 | O parâmetro 'providerType' incorreto. | Informar o Tipo de Contrato com um valor correto, conforme abaixo: 1 (Assistência Médica), 2 (Assistência Odontológica) ou A (Ambos) |
Itens a serem verificados durante o atendimento: