Conceitos da API - Integrador SST

Informações que serão integradas

Sua API será responsável por integrar as informações de colaboradores e dos eventos de SST do eSocial. Listamos a seguir os detalhes do que deverá ser integrado:

Informações dos colaboradores

As pendências de integração serão criadas somente quando alguma informação relevante do colaborador for alterada no sistema da Senior.

Toda informação publicada pela Senior possui um Motivo da integração. Os possíveis motivos de integração são:

Os respectivos históricos do colaborador no sistema do prestador SST devem ser atualizados conforme o motivo da integração.

Desta forma, é papel do desenvolvedor do sistema do prestador SST desenvolver na sua API  as rotinas necessárias para realizar as seguintes ações:

Identificação do colaborador na integração

Integrador SST oferece mais de uma maneira de identificar o colaborador na integração com o sistema da Senior.

Para encontrar o colaborador, o sistema do prestador deve usar uma dessas formas de identificação, seguindo a ordem de prioridade a seguir:

Transferência entre empresas e filiais

Quando um colaborador é transferido entre empresas e filiais, o sistema da Senior apresenta os seguintes possíveis cenários:

Cenários Exemplos dos cenários
Movimentação de empresa sem troca de cadastro Colaborador transferido da empresa 1/filial 1 para a empresa 2/filial 1, mantendo o mesmo código de cadastro (número da matrícula, por exemplo: 100).
Movimentação de empresa com troca de cadastro Colaborador transferido da empresa 1/filial 1 para a empresa 2/filial 1, trocando o código de cadastro (número da matrícula, por exemplo: troca de 100 para 200).
Movimentação de filial sem troca de cadastro Colaborador transferido da empresa 1/filial 1 para a empresa 1/filial 2, mantendo o mesmo código de cadastro (número da matrícula, por exemplo: 100).
Movimentação de filial com troca de cadastro Colaborador transferido da empresa 1/filial 1 para a empresa 1/filial 2, trocando o código de cadastro (número da matrícula, por exemplo: troca de 100 para 200).
Movimentação de empresa ou filial de colaboradores que têm mais de um contrato ativo no sistema da Senior Colaborador tem dois contratos ativos (por exemplo: matrículas 100 e 200) na empresa/filial de origem, porém apenas o contrato de matrícula 100 é transferido pra uma outra empresa/filial de destino.

Sempre que um destes cenários ocorre, o Integrador SST cria uma única pendência de integração referente à transferência.

Quando um colaborador é movimentado entre empresas ou filiais, não é enviada nenhuma pendência de integração para demitir, inativar ou excluir o colaborador da empresa/filial de origem. O sistema do prestador, ao receber uma pendência desse tipo de movimentação, deve tomar as providências necessárias para movimentar o colaborador de empresa/filial no seu sistema, de acordo com suas próprias especificações.

Não é possível transferir colaboradores de empresa ou filial entre sistemas de prestadores diferentes. Por exemplo: não é possível movimentar o colaborador que está numa empresa do sistema de prestador "A" para uma empresa do sistema de prestador "B".

Informações contidas em pendências de integração de movimentação de empresa/filial

Pendências de integração referentes a movimentação de empresa ou filial são identificadas pelo parâmetro integrationType, podendo ter um dos seguintes valores:

Entre outros dados nestas pendências, estão os parâmetros descritos na tabela abaixo. Estes parâmetros são dedicados às informações sobre a movimentação:

Parâmetro Descrição
providerCompanyIdentification Código da empresa de destino no sistema do prestador SST
company Entidade com informações da empresa de destino do colaborador
companyBranch Entidade com informações da filial de destino do colaborador
employeeType Tipo do colaborador na empresa/filial de destino
code Código do colaborador na empresa/filial de destino
providerPreviousCompanyIdentification Código da empresa de origem no sistema do prestador SST
previousCompany Entidade com informações da empresa de origem do colaborador
previousCompanyBranch Entidade com informações da filial de origem do colaborador
previousEmployeeType Tipo do colaborador na empresa/filial de origem
previousCode Código do colaborador na empresa/filial de origem

Eventos de SST do eSocial

Os eventos do eSocial (XML) gerados pelo prestador SST devem ser enviados à XPlatform através do da API desenvolvida.

Atualmente, os seguintes eventos do eSocial são reconhecidos para envio pelo módulo Integrador SST:

Os arquivos XML devem ser enviados individualmente (um a um). Cada XML enviado é validado, conforme estrutura e atributos do seu leiaute, antes de ser enviado ao Governo. Caso o XML esteja inválido, ele não será considerado para envio ao Governo.

O retorno dos eventos do eSocial (XML) enviados à XPlatform e que foram encaminhados ao Governo, são devolvidos ao sistema do prestador SST por meio da API.

Na sua API, você deve desenvolver as seguintes ações:

Integração de pendências de exclusão

Integrador SST gerencia as pendências de exclusão de:

Essas pendências são geradas com tipo de operação igual a exclusão, mas elas não excluem o registro diretamente do sistema do prestador. As pendências de exclusão apenas informam que um registro foi excluído do HCM XT, e então cada sistema de prestador decide a ação a ser tomada. Ao receber a pendência, o prestador pode optar entre inativar ou excluir o colaborador do seu sistema.

Este comportamento dá um controle maior ao sistema do prestador sobre o que ocorre com os históricos pelo sistema de folha. O prestador ganha mais autonomia e flexibilidade para criar suas regras para registros excluídos, pois recebe o sinal da exclusão e toma suas providências em cima disso, conforme suas próprias necessidades de negócio.

Confira a seguir como funciona cada tipo de pendência de exclusão:

Nota

Para consultar as pendências que foram canceladas ou com tipo de operação exclusão, você pode emitir um relatório com as pendências em que isso aconteceu. Isso é feito por meio de filtros na visão dinâmica Integrações dos dados do colaborador (v_integration_v3).

Integração de colaboradores desligados (demissão/rescisão)

Quando uma rescisão é feita no sistema de folha, o Integrador SST inativa o colaborador que foi desligado, mas não o remove do sistema. O Integrador SST envia uma pendência de integração dessa rescisão para o sistema do prestador, com tipo de operação igual a alteração. Então, cabe ao sistema do prestador definir como irá abordar os registros de colaboradores inativos.

Se a rescisão for cancelada no sistema de folha depois que o desligamento foi integrado para o sistema do prestador, é preciso fazer o seguinte procedimento:

  1. reativar manualmente, no sistema do prestador, o registro do colaborador que foi inativado pelo desligamento
  2. acessar a tela de pendências de integração no Integrador SST e cancelar manualmente a pendência referente à rescisão

Com este procedimento, as próximas alterações que ocorrerem com o colaborador serão integradas normalmente com o sistema do prestador.

A reativação automática de colaboradores não está disponível na integração com os sistemas dos prestadores SST.

Veja também:

Este artigo ajudou você?