Cada vez mais o mercado exige que as operações complexas e manipulação de dados ainda mais ágeis e com custos reduzidos. Com o RH não é diferente, por isso os pagamentos pertinentes aos autônomos que foram cadastrados no EMS, precisam ser enviados para o eSocial de forma transparente para o usuário.
Frente a esta necessidade, foi criada uma interface que possibilite automatizar o envio do arquivo S-1200/S-1210 para o eSocial, através de uma interface de integração.
HCM (módulo Folha de Pagamento): O módulo Folha de Pagamento visa efetuar os cálculos da folha de pagamento para os funcionários, mantendo o controle sobre os valores referentes aos eventos relativos a estes funcionários.
O objetivo desta integração é permitir que a área do RH, recebam os arquivos S-1200/S-1210 de outros sistemas especializados na área, reduzindo assim o trabalho de inclusão manual de todas as informações dentro do sistema;
Por intermédio desta integração será disponibilizada a seguinte funcionalidade:
Abaixo demonstramos um desenho como esta integração se dará:
Fora do escopo
Processos
O Sistema requisitante enviará as informações via Json para a interface de integração, desta forma será validado as informações contidas no Json, e caso necessário, irá cadastrar o autônomo no HCM. Caso tenha êxito na geração do registro, será retornado a mesma estrutura de Json confirmando sua gravação, caso contrário enviará as informações de inconsistências citadas nos próximos tópicos.
Para realizar a integração, é necessário as informações básicas para cadastramento do processo.
Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Valor Default | Descrição |
authorization | usuario:senha | Sim | header | autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic. | |
content | request da api | sim | body | Estrutura json com informações de cadastro do processo: Propriedades Obrigatórias: Dados do Processo:
Dados da Suspensão:
|
Parâmetros e Chamada do Método:
Autenticação do tipo básica.
Método POST.
{protocolo}://{host}/api/rh/v1/paymentEsocials
Request da API: Exemplo:
Dados utilizados da API
Propriedade API REST | CAMPO HCM | DESCRIÇÃO | Formato / Exemplo |
---|---|---|---|
company | cdn_empresa | Empresa que a suspensão se aplica. | 123 |
tpProc | idi_tip_proces_justic | Tipo de processo conforme leiaute do eSocial. | 1 |
nrProc | cod_proces_justic | Número do processo. | 12345678901234567890 |
iniValid | dat_inic_valid | Início da validade do processo. | "2019-02" |
fimValid | dat_term_valid | Fim da validade do processo. | "9999-12" |
indAutoria | idi_tip_autoria | Autoria da ação judicial. | 2 |
indMatProc | idi_mater_proces | Indicativo da matéria do processo ou alvará judicial. | 5 |
observacao | des_obs_sped | Observações relacionadas ao processo. | Lorem ipsum dapibus molestie semper malesuada aliquam purus suspendisse tristique, etiam per urna arcu ante curabitur quam quis metus tempus, egestas a massa euismod sem fermentum maecenas sodales. vulputate molestie faucibus ac accumsan. |
ufVara | cod_uf_vara | UF da Vara. | SC |
codMunic | cdn_munpio_sped | Código do município, conforme tabela do IBGE. | 1234567 |
idVara | cod_vara | Código de Identificação da Vara. | 1234 |
infoSusp | Pode ter nenhuma ou várias suspensões conforme o processo. | ||
codSusp | num_seq_utiliz | Código indicativa da suspensão. | 1 |
indSusp | idi_tip_decis_proces_justic | Indicativo de suspensão da exigibilidade. | "04" |
dtDecisao | dat_decis | Data da decisão, sentença ou despacho. | "2019-07-21" |
indDeposito | log_depos_montante | Indicativo de depósito do montante integral. | "S" para sim "N" para não. |
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 HCM:
Mensagens de Pré-Validação
Erro | Mensagem | Solução | API RESPONSE | |
265 | Processo (nrProc) deve ser informado(a). | Verificar se a propriedade json nrProc está preenchida no pacote enviado . |
| |
158 | Informe um(a) Tipo Processo (tpProc) válido(a). Valores Válidos: 1 ou 2 ou 3 | Verificar se a propriedade json tpProc existe e está com valor válido conforme leiaute do eSocial. |
| |
56650 | Processo cadastrado(a) no HCM deve ser mantido neste produto. Verifique o FP0030. | Se o processo já foi cadastrado pelo HCM (FP0030), a manutenção do mesmo deve ocorrer no HCM e não via integração. |
| |
7137 | Empresa não relacionada com Nenhum Empregador. | Empresa informada na integração (company) deve ser um empregador ou estar relacionado a algum empregador. Verifique complemento do eSocial no FP0500 Manutenção Parâmetros Empresa RH. |
| |
53817 | Dado Registro infoSusp (codSusp: 1) incorreto - indSusp (50). | Este campo (indSusp) deve ter valor conforme leiaute do eSocial. |
|
OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma ou não estejam de acordo com o leiaute do eSocial. Vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada.
Itens a serem verificados durante o atendimento: