Gestão de Pessoas - senior X - Manual do Usuário > Integrador SST > Desenvolvedor - API do Integrador SST > Conceitos da API

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.

Relação de informações dos colaboradores publicadas pelo sistema da Senior

Nas tabelas abaixo constam as informações dos colaboradores que são publicadas pelo sistema da Senior. Estas são as informações que irão gerar pendências de integração.

Informações da pendência

Informação integrada	Exemplos de valores	Origem da informação no módulo Administração de Pessoal (on-premise)
Data e hora da criação da pendência	-	Informações gerenciadas pelo sistema ao criar as pendências de integração.
Situação	-
Motivo da pendência de integração	Admissão do colaborador Alteração do colaborador Demissão do colaborador Histórico de centro de custo Histórico de departamento Histórico de categoria eSocial Histórico de cargo Histórico de posto de trabalho Histórico de filial Histórico de escala Histórico de afastamento Histórico de ambiente de trabalho Alteração da matrícula eSocial Carga inicial
Operação	Inserção Alteração Exclusão
Data e hora agendada para o envio	-
Data e hora do envio	-
Motivo do cancelamento	-

Dados do colaborador

Informação integrada	Exemplos de valores	Origem da informação no módulo Administração de Pessoal (HCM XT)
Informação integrada	Exemplos de valores	Campo do sistema	Menu
Nome	-	A integração considera o campo Nome completo no cadastro de Pessoas. (O campo Nome completo é opcional no HCM XT. Se essa informação estiver ausente, a integração considera o nome preenchido no campo ao lado do código de matrícula da Ficha Básica.)	Pessoas > Cadastro de Pessoas
CPF	999.999.999-99	CPF
Número de Identificação Social (NIS)	99999999999	PIS
Data de nascimento	01/01/1990	Data Nascimento
Sexo	Masculino, Feminino	Sexo
Estado civil	Solteiro, Casado, Divorciado, Viúvo, Concubinato, Separado, União estável, Outros	Estado Civil
Deficiente	Sim, Não	Deficiente
Número do RG	99.999.999-9	Carteira Identidade
Estado do RG	AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO
Data de emissão do RG	01/01/2020
Órgão Emissor do RG	SSP
Número da carteira de trabalho	999999999	Carteira Trabalho
Série da carteira de trabalho	99
Dígito da carteira de trabalho	9
Data de emissão da carteira de trabalho	01/01/2020
Estado da carteira de trabalho	AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO
Código de cadastro	99999	Colaborador	Colaboradores > Ficha Cadastral > Empregados
Matrícula eSocial	SEAAAA999999999999999999999999	Informação gerenciada pelo sistema, é exibida acima da foto do colaborador
Tipo de contratação	Empregado, Diretor, Trabalhador rural, Trabalhador doméstico, Aposentado, Estagiário, Aprendiz, Agente público, Professor, Cooperado	Tipo Contrato
Data de admissão	01/01/2020	Data Admissão
Situação	Pré-admissãoAbrange colaboradores que têm data de admissão futura. Quando chega a data da admissão, a situação é alterada automaticamente de Pré-admissão para Trabalhando., TrabalhandoAbrange colaboradores que se encontram nas situações: Trabalhando, Licença sem remuneração, Licença paga pela empresa, Licença paga pelo empregado, Licença paternidade, Aviso prévio trabalhando, Faltas, Horas extras, Situação apuração do ponto, Sobreaviso/Prontidão, Mandato sindical, Outros., FériasAbrange colaboradores que se encontram nas situações: Férias, Férias coletivas, Férias gozadas já adiantadas., DemitidoAbrange colaboradores que se encontram nas situações: Demissão, Aposentadoria., AfastadoAbrange apenas colaboradores que se encontram nas situações de afastamento que exigem a realização de algum tipo de exame: Auxílio doença, Acidente de trabalho, Demitido, Licença médica (pagto empresa), Licença acidente de trabalho (pagto empresa), Licença maternidade INSS, Licença maternidade, Maternidade empresa cidadã, Serviço militar.,	Situação
Tipo de colaborador	Colaborador, Terceiro	O Integrador SST integra somente os dados de trabalhadores dos tipos Colaborador e Terceiro, que são originados pelos seguintes locais do Administração de Pessoal: Colaborador: Colaboradores > Ficha Cadastral > Empregados Terceiro: Colaboradores > Ficha Cadastral > Terceiros Empregados do tipo Parceiros são desconsiderados.
Data de demissão	01/01/2020	Data do histórico de afastamento gerado pela situação de demissão	Colaboradores > Históricos > Afastamentos
Data de referência das informações	01/01/2020	Data de criação da pendência de integração (informação gerenciada pelo sistema ao criar as pendências)

Notas

Ao registrar a admissão de um colaborador estrangeiro no Integrador SST, será preciso um CPF para admiti-lo numa empresa.
Ao cadastrar um colaborador com data de admissão futura, o Integrador SST cria duas pendências de integração:
- uma pendência na data do cadastro, com a situação Pré-admissão
- uma pendência futura (data da admissão) com a situação Trabalhando

Informações adicionais

Informação integrada	Exemplos de valores	Origem da informação no módulo Administração de Pessoal (on-premise)
Informação integrada	Exemplos de valores	Campo do sistema	Menu
Código da aposentadoria especial do colaborador	-	Aposentadoria Especial	Colaboradores > Históricos > Adicionais > Colaborador

Nota

O código da aposentadoria especial corresponde ao histórico de adicional por colaborador. Esta é a informação do único histórico na versão senior X.

Categoria do colaborador no eSocial

Informação integrada	Exemplos de valores	Origem da informação no módulo Administração de Pessoal (on-premise)
Informação integrada	Exemplos de valores	Campo do sistema	Menu
Categoria	Itens de acordo com a Tabela 01 do eSocial (Categorias de Trabalhadores)	Categoria Trabalhador	Colaboradores > Históricos > Categoria eSocial
A partir de (data de início do histórico da categoria)	-	Data de início do histórico de uma nova categoria eSocial	Colaboradores > Históricos > Categoria eSocial

Nota

Você pode escolher quais categorias do eSocial serão consideradas no processo de integração. Essa definição é feita na tela de configurações da integração com o prestador.

Deficiências

Informação integrada	Exemplos de valores	Origem da informação no módulo Administração de Pessoal (on-premise)
Informação integrada	Exemplos de valores	Campo do sistema	Menu
Código da deficiência	Um colaborador pode ter mais de uma deficiência	Deficiência	Colaboradores > Ficha Cadastral > Empregados, guia Deficiências
A partir de (data de início do histórico da deficiência)	-	Data
Nome da deficiência	-	Descrição (Deficiência)
Deficiência principal do colaborador	Sim, Não	Deficiência que possuir a caixa de seleção Princ. Defic. marcada.
Reabilitado	Sim, Não	Reabilitado	Colaboradores > Ficha Cadastral > Empregados, guia Básica
Tipo da deficiência no eSocial	Física, Auditiva, Visual, Mental, Intelectual, Outra	Determinado pelo campo Tipo Deficiência eSocial (Tabelas > Gerais > Tipos Deficiências) que estiver associado à deficiência do colaborador.	Colaboradores > Ficha Cadastral > Empregados, guia Deficiências

Nota

A integração das informações de deficiências é opcional e pode ser alterada nas configurações da integração.

Empresa

Empresa atual do colaborador:

Informação integrada	Origem da informação no módulo Administração de Pessoal (on-premise)
Informação integrada	Campo do sistema	Menu
Código da empresa	Código da empresa onde o colaborador está alocado	Colaboradores > Históricos > Filial
Razão social da empresa	Razão social da empresa onde o colaborador está alocado	Colaboradores > Históricos > Filial
Código de identificação da empresa no prestador SST	Este é o código de identificação da empresa no sistema do prestador SST. Não é gerado pelo Administração de Pessoal da Senior.

Empresa anterior do colaborador:

Informação integrada	Origem da informação no módulo Administração de Pessoal (on-premise)
Informação integrada	Campo do sistema	Menu
Código da empresa anterior	Código da empresa onde o colaborador estava alocado antes da transferência	Colaboradores > Históricos > Filial
Razão social da empresa anterior	Razão social da empresa onde o colaborador estava alocado antes da transferência	Colaboradores > Históricos > Filial
Código de identificação no prestador SST (empresa anterior)	Este é o código de identificação da empresa anterior no sistema do prestador SST. Não é gerado pelo Administração de Pessoal da Senior.

Observação

As informações da empresa anterior do colaborador serão enviadas sempre que ele possuir alguma movimentação entre empresas no seu histórico, independentemente de o motivo da integração ser uma transferência ou não.

Se o colaborador não possuir históricos de transferências, serão enviadas somente as informações da empresa atual.

Filial

Filial atual do colaborador:

Informação integrada	Exemplos de valores	Origem da informação no módulo Administração de Pessoal (on-premise)
Informação integrada	Exemplos de valores	Campo do sistema	Menu
Código da filial	-	Código da filial onde o colaborador está alocado	Colaboradores > Históricos > Filial
Nome da filial	-	Nome da filial onde o colaborador está alocado
Razão social da filial	-	Razão social da filial onde o colaborador está alocado
Tipo de inscrição	CNPJ, CPF, CAEPF, CNO, CEI	Tipo de inscrição da filial onde o colaborador está alocado
Número de inscrição	-	Número da inscrição da filial onde o colaborador está alocado
A partir de (data de início do histórico)	-	Data em que o colaborador foi admitido ou transferido para a filial, com base no histórico

Filial anterior do colaborador:

Informação integrada	Exemplos de valores	Origem da informação no módulo Administração de Pessoal (on-premise)
Informação integrada	Exemplos de valores	Campo do sistema	Menu
Código da filial anterior	-	Código da filial onde o colaborador estava alocado antes da transferência	Colaboradores > Históricos > Filial
Nome da filial anterior	-	Nome da filial onde o colaborador estava alocado antes da transferência
Razão social da filial anterior	-	Razão social da filial onde o colaborador estava alocado antes da transferência
Tipo de inscrição da filial anterior	CNPJ, CPF, CAEPF, CNO, CEI	Tipo de inscrição da filial onde o colaborador estava alocado antes da transferência
Número de inscrição da filial anterior	-	Número da inscrição da filial onde o colaborador estava alocado antes da transferência
A partir de (data de início do histórico)	-	Data em que o colaborador foi admitido ou transferido para a filial anterior, com base no histórico

Observação

As informações da filial anterior do colaborador serão enviadas sempre que ele possuir alguma movimentação entre filiais no seu histórico, independentemente de o motivo da integração ser uma transferência ou não.

Se o colaborador não possuir históricos de transferências, serão enviadas somente as informações da filial atual.

Ambiente de trabalho

Informação integrada	Origem da informação no módulo Administração de Pessoal (on-premise)
Informação integrada	Campo do sistema	Menu
Código	Código do ambiente de trabalho onde o colaborador atua	Colaboradores > Históricos > Ambiente de Trabalho
Nome	Nome do ambiente de trabalho onde o colaborador atua
Tipo de inscrição	Tipo de inscrição (CNPJ, CPF, CAEPF, CNO, CEI) do ambiente de trabalho onde o colaborador atua
Número de inscrição	Número de inscrição do ambiente de trabalho onde o colaborador atua
A partir de (data de início do histórico)	Data em que o colaborador passou a atuar no ambiente de trabalho, com base no histórico

Notas

A integração das informações de ambiente de trabalho é opcional e pode ser alterada nas configurações da integração.
Se o colaborador não tiver um histórico de ambiente de trabalho no sistema de folha, o Integrador SST assume que o colaborador trabalha no ambiente do empregador. Ou seja, o Integrador SST usará informações de empresa atual do colaborador.

Centro de custo

Informação integrada	Origem da informação no módulo Administração de Pessoal (on-premise)
Informação integrada	Campo do sistema	Menu
Código	Código do centro de custo onde o colaborador está alocado	Colaboradores > Históricos > C.Custo
Nome	Nome do centro de custo onde o colaborador está alocado
A partir de (data de início do centro de custo)	Data em que o colaborador foi alocado no centro de custo, com base no histórico

Nota

A integração das informações de centro de custo é opcional e pode ser alterada nas configurações da integração.

Posto de trabalho

Informação integrada	Origem da informação no módulo Administração de Pessoal (on-premise)
Informação integrada	Campo do sistema	Menu
Código do posto de trabalho	Código do posto onde o colaborador está alocado	Colaboradores > Históricos > Manutenção de Históricos
Código da estrutura de postos	Estrutura da qual o posto faz parte
Nome	Nome do posto onde o colaborador está alocado
A partir de (data de início do posto de trabalho)	Data em que o colaborador foi alocado no posto de trabalho, com base no histórico

Notas

A integração das informações de posto de trabalho é opcional e pode ser alterada nas configurações da integração.
Ao alterar o posto de trabalho de um colaborador, ocasionando a mudança dos históricos vinculados a ele, será gerada uma pendência para cada um dos históricos alterados, considerando também a opção de envio dessas informações.
Exemplo:
Ao alterar um posto de trabalho, onde houve mudança também do local e cargo, o sistema vai gerar três pendências: posto, local e cargo.
Para gerar somente as pendências do posto, seria necessário desabilitar o envio de local e de cargo nas configurações da integração.

Setor (Local)

Informação integrada	Origem da informação no módulo Administração de Pessoal (on-premise)
Informação integrada	Campo do sistema	Menu
Código do setor/local	Código do local onde o colaborador está alocado	Colaboradores > Históricos > Local
Código da tabela de organograma do setor/local	Organograma do qual o local faz parte
Nome do setor/local	Descrição do local onde o colaborador está alocado
A partir de (data de início do histórico do setor/local)	Data em que o colaborador foi alocado no local, com base no histórico

Nota

A integração das informações de setor é opcional e pode ser alterada nas configurações da integração.

Cargo

Informação integrada	Origem da informação no módulo Administração de Pessoal (on-premise)
Informação integrada	Campo do sistema	Menu
Código do cargo	Código do cargo exercido pelo colaborador	Colaboradores > Históricos > Cargo
Nome do cargo	Nome do cargo exercido pelo colaborador
Código da estrutura de cargos	Estrutura da qual o cargo exercido faz parte
A partir de (data de início do histórico do cargo)	Data em que o colaborador passou a exercer o cargo, com base no histórico

Nota

A integração das informações de cargo é opcional e pode ser alterada nas configurações da integração.

Turno

Informação integrada	Origem da informação no módulo Administração de Pessoal (on-premise)
Informação integrada	Campo do sistema	Menu
Código	Código da escala de atuação do colaborador	Colaboradores > Históricos > Escala
Nome	Descrição da escala de atuação do colaborador
A partir de (data de início do histórico do turno)	Data em que o colaborador passou a atuar com a escala
Turno da escala (1° turno, 2° turno, 3° turno, 4° turno, Misto, Geral)	Turno da Escala	Tabelas > Horários > Escalas

Nota

A integração das informações de turno é opcional.

Afastamento

Informação integrada	Origem da informação no módulo Administração de Pessoal (on-premise)
Informação integrada	Campo do sistema	Menu
Código	Código da situação de afastamento	Colaboradores > Históricos > Afastamentos
Descrição	Descrição da situação de afastamento
Início	Data Afastamento
Término previsto	Previsão Término
Término	Data Término

Notas

A integração das informações de afastamento é opcional e pode ser alterada nas configurações da integração.
São consideradas apenas as situações de afastamentos por férias ou que exigem a realização de algum tipo de exame, tais como: Auxílio doença, Acidente de trabalho, Demitido, Licença médica (pagto empresa), Licença acidente de trabalho (pagto empresa), Licença maternidade INSS, Licença maternidade, Maternidade empresa cidadã, Serviço militar.

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

Admissão
Alteração das informações adicionais (dados de aposentadoria especial)
Alteração de dados do colaborador
Demissão
Movimentação de centro de custo
Movimentação de setor
Movimentação de categoria do eSocial
Movimentação de cargo
Movimentação de posto de trabalho
Movimentação de filial
Movimentação de empresa
Movimentação de turno
Movimentação de afastamento
Movimentação de ambiente de trabalho

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:

Receber a pendência de integração com as informações do colaborador e verificar, através do CPF, se o colaborador já existe no prestador SST.
Se o colaborador não existe no prestador SST, desenvolver rotina que insere o colaborador no sistema do prestador.
Se o colaborador já existe no prestador SST, desenvolver rotina que atualiza as informações do colaborador, conforme o motivo da pendência de integração.

Identificação do colaborador na integração

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:

1º) Pelo identificador único — se na pendência de integração constar o identificador único do colaborador (campo providerEmployeeIdentification), essa é a informação que deve ser usada.
2º) Pelo padrão de saneamento da base — se na pendência não constar o identificador único, deve-se usar o padrão definido pelo saneamento (tipo de colaborador e o número da matrícula, por exemplo: 1/570).
3º) Pelo número de contratos que o colaborador tem:
- Se o colaborador tem somente um contrato (numberContractSameHireDate = 1), a identificação do colaborador é feita pelo CPF.
- Se o colaborador tem mais de um contrato (numberContractSameHireDate > 1), a identificação do colaborador é, obrigatoriamente, feita pelo identificador único (providerEmployeeIdentification) ou pelo padrão definido pelo saneamento.

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.

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:

HISTORICAL_COMPANY (Empresa)
HISTORICAL_COMPANY_BRANCH (Filial)

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 à senior X Platform através do da API desenvolvida.

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

S-2210 - Comunicação de Acidente de Trabalho
S-2220 - Monitoramento da Saúde do Trabalhador
S-2240 - Condições Ambientais do Trabalho - Fatores de Risco
S-3000 - Exclusão de Eventos

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 à senior X Platform 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:

Enviar os eventos do eSocial (XML) para o Integrador SST da Senior.
Receber o resultado da validação dos eventos do eSocial (XML) que foram enviados ao Integrador SST da Senior.
Receber o número do recibo e críticas/erros dos eventos do eSocial retornados pelo governo, e gravar essa informação no sistema do prestador SST.

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

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

Admissão (disponível para todos os sistemas de prestadores homologados)
Históricos (movimentações) (disponível somente para prestadores que usam o sistema RS Data)
Demissão (reintegração) (disponível somente para prestadores que usam o sistema RS Data)

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:

reativar manualmente, no sistema do prestador, o registro do colaborador que foi inativado pelo desligamento
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:

Desenvolvendo a API - documentação de referência