Você está na página 1de 80

Sistema eSocial

Manual de Orientao do Desenvolvedor

Verso 1.4
Agosto de 2017
Histrico de verses
Data Verso Descrio
19/12/2014 1.0 Verso inicial
- Alterao do protocolo de segurana da camada de transporte de
SSL para TLS.
- Alterao da verso do SOAP de 1.2 para 1.1.
- Excluso da tag hash dos retornos dos WebServices.
- Alterao do nome das tags "tpInscricao" e "nrInscricao" para
"tpInsc" e "nrInsc" para compatibilizar com o nome utilizado nos
Schemas dos eventos.
26/06/2015 1.1 - Alterao do nome do atributo "id" para "Id" para compatibilizar
com o nome utilizado nos Schemas dos eventos.
- Alterao dos namespaces dos Schemas dos XMLs de
comunicao.
- Melhoria da descrio da seo 4.1. Padro de Documento XML.
(Esclarecer o cenrio de uso dos caracteres de escape).
- Melhoria da descrio da seo 6.5. Estrutura do retorno de
processamento do evento. (Incluso da referncia ao arquivo
RetornoEvento-vx_x_x.xsd.)

- Alterao do padro de assinatura de Sha1 para Sha256.


- Correo da Uri do algoritmo de assinatura RSA-Sha256.
- Alterao da formao do nmero de protocolo, que passa a
conter as informaes de ANO e MS da recepo.
- Atualizao do leiaute da mensagem de retorno do processamento
do lote para contemplar os eventos S-5xxx na seo 5.5.4. Leiaute
Mensagem de Retorno do Processamento do Lote. Esta mudana
14/02/2017 1.2 implica no versionamento do schema
RetornoProcessamentoLote.xsd para a verso 1.2.0.
- Excluso do prefixo "MS" nas mensagens das sees 5.3.
Validao do Certificado Digital, 5.4.5. Validaes aplicadas e
5.5.6. Validaes aplicadas.
- Incluso de recomendao na seo 5.6.2. Evitar o envio de
eventos durante o processamento do fechamento da folha.
- Incluso da seo 5.5.5. Retorno dos eventos totalizadores.

2
- Incluso da seo 5.6.1. Respeitar a ordem de precedncia no
envio dos eventos em lotes.
- Incluso da seo 7. Orientaes para utilizao do ambiente de
21/06/2017 1.3 Produo Restrita.
- Excluso da seo Ambientes de Recepo.
- Atualizao da seo 3.4.1. Indisponibilidade dos servidores

Atualizao da seo 3.3.Etapas do processo ideal.


Atualizao do texto da seo 5.6.1. Respeitar a ordem de
precedncia no envio dos eventos em lotes.
Atualizao da imagem que ilustra a estrutura bsica do evento na
31/07/2017 1.4 seo 6.1.Estrutura do evento.
Incluso da seo 7.11.Remover empregador da base de dados.

3
ndice
1. INTRODUO ......................................................................................................... 6
2. CONSIDERAES INICIAIS .............................................................................. 6
2.1.OBJETIVOS DO PROJETO ........................................................................................... 6
2.2.CONCEITO DE EVENTO ............................................................................................. 7
3. ARQUITETURA DE COMUNICAO ........................................................... 8
3.1. MODELO OPERACIONAL ........................................................................................... 8
3.2. NVEIS DE VALIDAO ............................................................................................ 9
3.3. ETAPAS DO PROCESSO IDEAL ................................................................................. 10
3.4. PROCEDIMENTOS DE CONTINGNCIA ..................................................................... 11
3.4.1. Indisponibilidade dos servidores ............................................................ 11
4. PADRES TCNICOS ......................................................................................... 13
4.1.PADRO DE DOCUMENTO XML ............................................................................. 13
4.2.SCHEMA XML....................................................................................................... 14
4.3.PADRO DE COMUNICAO .................................................................................. 15
4.4.PADRO DE CERTIFICADO DIGITAL ........................................................................ 16
4.5.PADRO DE ASSINATURA DIGITAL ......................................................................... 17
4.6.PROCESSO DE VALIDAO DE ASSINATURA DIGITAL.............................................. 19
4.7.RESUMO DOS PADRES TCNICOS .......................................................................... 20
5. WEBSERVICES ...................................................................................................... 22
5.1. PADRO DE MENSAGENS DOS WEBSERVICES ........................................................ 22
5.2. VALIDAO DA ESTRUTURA DA MENSAGEM NO WEBSERVICE ............................. 23
5.3. VALIDAO DO CERTIFICADO DIGITAL ................................................................. 24
5.4. WEBSERVICE DE ENVIO DE LOTE DE EVENTOS ...................................................... 25
5.4.1. Dados para a chamada ao Webservice ................................................. 25
5.4.2. Fluxo de Envio de Lote de Eventos ...................................................... 27
5.4.3. Leiaute Mensagem de Entrada ................................................................ 28
5.4.4. Leiaute Mensagem de Retorno do Envio do Lote ............................ 32
5.4.5. Validaes aplicadas .................................................................................. 39
5.5. WEBSERVICE DE CONSULTA AO RESULTADO DO PROCESSAMENTO DE UM LOTE DE
EVENTOS ........................................................................................................................... 40
5.5.1. Dados para a chamada ao Webservice ................................................. 40
5.5.2. Fluxo de consulta ao resultado do processamento do lote de
eventos 41
5.5.3. Leiaute da Mensagem de Entrada .......................................................... 42
5.5.4. Leiaute Mensagem de Retorno do Processamento do Lote........... 44
5.5.5. Retorno dos eventos totalizadores ......................................................... 53
5.5.6. Validaes aplicadas .................................................................................. 54
5.6. RECOMENDAES E BOAS PRTICAS ..................................................................... 54
5.6.1. Respeitar a ordem de precedncia no envio dos eventos em lotes
54

4
5.6.2. Evitar o envio de eventos de outros grupos durante o envio dos
eventos peridicos ....................................................................................................... 56
5.6.3. Evitar o envio de eventos durante o processamento do
fechamento da folha .................................................................................................... 56
5.6.4. Tempo de espera para busca do resultado do processamento....... 57
5.6.5. Otimizao na montagem do arquivo ................................................... 57
5.6.6. Validao de Schema ................................................................................. 58
6. EVENTOS ................................................................................................................. 59
6.1. ESTRUTURA DO EVENTO ........................................................................................ 59
6.2. IDENTIFICAO DO EVENTO................................................................................... 63
6.3. ASSINATURA DO EVENTO ....................................................................................... 64
6.4. VERSIONAMENTO DOS LEIAUTES DOS EVENTOS ..................................................... 64
6.5. ESTRUTURA DO RETORNO DE PROCESSAMENTO DO EVENTO .................................. 66
6.6. CDIGOS DE REPOSTA DE PROCESSAMENTO DO EVENTO ........................................ 72
7. ORIENTAES PARA UTILIZAO DO AMBIENTE DE
PRODUO RESTRITA ............................................................................................. 73
7.1. SOBRE A PRODUO RESTRITA ............................................................................. 73
7.2. ESTRATGIA DE DISPONIBILIZAO ....................................................................... 74
7.3. EVENTOS ............................................................................................................... 74
7.4. RESTRIES........................................................................................................... 75
7.5. TEMPO DE GUARDA DOS DADOS ............................................................................. 76
7.6. VALIDAES ......................................................................................................... 76
7.7. REGRA PARA IDENTIFICAO DO AMBIENTE .......................................................... 78
7.8. URL DOS WEB SERVICES ...................................................................................... 79
7.9. ATENDIMENTO....................................................................................................... 79
7.10. CERTIFICAO DIGITAL ..................................................................................... 79
7.11. REMOVER EMPREGADOR DA BASE DE DADOS..................................................... 80

5
1. Introduo

Este documento tem por objetivo definir os critrios e especificaes tcnicas


necessrios para a integrao entre o Sistema dos empregadores, pessoas fsicas e/ou
jurdicas e o Sistema eSocial.

2. Consideraes iniciais

O projeto eSocial uma ao conjunta entre rgos e entidades do governo federal,


conforme definido no decreto n 8.373, de 11 de dezembro de 2014.

2.1. Objetivos do projeto

Este projeto visa a disponibilizao de servios que possibilitem a recepo,


armazenamento e distribuio aos entes participantes do eSocial das informaes
trabalhistas e previdencirias prestadas pelos empregadores ou pelos representantes legais
destes.

O eSocial traz diversas vantagens em relao sistemtica atual, tais como:

atendimento a diversos rgos do governo com uma nica fonte de


informaes, para o cumprimento das diversas obrigaes trabalhistas,
previdencirias e tributrias atualmente existentes;

integrao dos sistemas informatizados das empresas com o Ambiente


Nacional do eSocial, possibilitando a automao na transmisso das
informaes dos empregadores;

6
2.2. Conceito de evento

O Sistema eSocial disponibilizar servios que recebero eventos que acarretaro na


manuteno do cadastro do empregador, na manuteno dos dados trabalhistas e de folha
de pagamento de um empregado e na manuteno das informaes tabeladas que servem de
referncia para os eventos. Tambm sero disponibilizados servios de consulta para os
dados mantidos pelo sistema. Os eventos foram organizados em grupos pela periodicidade,
reuso, volatilidade e tipo. Conforme descrito no "Manual de Orientao do eSocial", foram
definidos os seguintes grupos: Eventos de tabelas, Eventos No peridicos e Eventos
peridicos.

7
3. Arquitetura de comunicao

3.1. Modelo operacional

Para enviar informaes trabalhistas e previdencirias ao eSocial o empregador


dever gerar eventos em arquivos eletrnicos, contendo as informaes referentes ao
cadastro inicial, tabelas, eventos no peridicos e eventos peridicos. Os arquivos gerados
devero ser assinados digitalmente, transformando este arquivo em um documento
eletrnico nos termos da legislao brasileira, de maneira a garantir a integridade dos dados
e a autoria do emissor.

Este arquivo eletrnico dever ser transmitido pela Internet para o Ambiente
Nacional em agrupamentos denominados lote de eventos, que so arquivos eletrnicos que
encapsulam um conjunto de eventos. No Ambiente Nacional, os eventos sero extrados
dos lotes, e submetidos a validaes quanto ao contedo e quanto aos outros eventos
recebidos anteriormente, garantindo a qualidade da informao.

O processo de solicitao de processamento de eventos ser executado de forma


assncrona atravs de dois Webservices, sendo um para o envio de lotes de eventos (item
5.4. Webservice de Envio de Lote de Eventos) e outro para consultar o resultado do
processamento de um lote (item 5.5. Webservice de Consulta ao Resultado do
Processamento de um Lote de Eventos). Com isto o processamento dos eventos no
acontecer na mesma conexo, tornando necessria a realizao de uma nova conexo para
a obteno do resultado do processamento.

O primeiro Webservice, cujo propsito enfileirar os lotes de eventos recebidos


para posteriormente serem processados, ter um Protocolo de Envio, que representa a
confirmao de recepo do lote. A partir do Protocolo de Envio, os andamentos/resultados
dos processamentos podero ser recuperados.

8
O segundo Webservice, cujo propsito a consulta ao resultado do processamento
de um lote de eventos, ter como retorno o andamento/resultado do processamento, assim
como os erros gerados, caso estes existam, e o recibo de entrega de cada um dos eventos
pertencentes ao lote.

3.2. Nveis de Validao

Os arquivos enviados para o eSocial sero validados em duas etapas, ou em dois


nveis:

Validao Nvel 1: ser executada no momento da recepo do lote de eventos.


Neste momento sero verificados apenas o certificado da conexo e a estrutura
do lote, as validaes dos eventos ocorrero apenas na validao de nvel 2.
Caso seja detectada alguma inconsistncia o lote no ser recebido.

Validao Nvel 2: ser executada em um segundo momento, em que os


eventos sero extrados do lote e sero validados individualmente. Os eventos
pertencentes a um determinado lote, com erro de estrutura, sero rejeitados pelo
sistema eSocial, mas os outros eventos deste mesmo lote podero ser
processados normalmente, desde que estes no contenham erros em suas
estruturas.

Para implementar o modelo assncrono, na validao de nvel 2, o sistema eSocial


far a insero dos lotes de eventos em filas de processamento, que sero processados
posteriormente de forma distribuda.

IMPORTANTE: Como o processamento dos lotes ser realizado de forma


distribuda, caso haja necessidade de garantia de precedncia entre eventos, esta
dever ser feita pelo empregador por meio da ordem dos eventos dentro de um mesmo
lote ou atravs do controle da montagem de lotes feita aps o recebimento do recibo
de entrega do processamento de um determinado evento.

9
O andamento/resultado do processamento dos eventos, bem como os erros gerados
pela m formao destes ou pelo processamento dos mesmos, somente podero ser
recuperados pelo responsvel pela solicitao de processamento, ou seja, aquele que enviou
a solicitao de processamento do lote. A recuperao destes dados deve ocorrer atravs de
uma solicitao de consulta ao resultado do processamento de um lote.

3.3. Etapas do processo ideal

A seguir so exibidas e descritas as etapas do processo ideal:

1) O aplicativo do empregador inicia a conexo enviando uma mensagem de


solicitao de processamento de lote de eventos para o 5.4 - Webservice de Envio
de Lote de Eventos;

10
2) O Webservice recebe a mensagem de solicitao de processamento, valida e insere a
solicitao no repositrio de lotes;

3) O Webservice retorna para o aplicativo do empregador o Protocolo de Envio;

4) Os lotes so inseridos na fila de solicitaes de processamento;

5) O sistema eSocial retira e processa a solicitao de processamento da fila de


solicitaes;

6) O sistema eSocial valida cada um dos eventos contidos no lote. Os eventos que so
considerados vlidos pelo eSocial so armazenados e um recibo emitido;

7) Uma vez concluda a validao de todos os eventos de um lote um retorno do


processamento do lote gerado e armazenado no eSocial. Este retorno contm o
resultado do processamento de cada evento contido no lote;

8) O aplicativo do empregador faz uma solicitao de consulta, ao 5.5 Webservice de


Consulta ao Resultado do Processamento de um Lote de Eventos, passando o
Protocolo de Envio retornado no passo 4;

9) O Webservice retorna o resultado da consulta contendo a situao do


processamento do lote de eventos. Caso o lote j esteja processado, o retorno
conter: os Recibos de Entrega dos eventos vlidos e/ou os Erros dos eventos
invlidos.

3.4. Procedimentos de contingncia

3.4.1. Indisponibilidade dos servidores

O procedimento de contingncia para a indisponibilidade do ambiente da empresa


o Portal Web do eSocial.

11
necessrio observar que, devido ao processo manual de entrada de dados no Portal
Web do sistema eSocial, o procedimento de contingncia tratado neste item se mostrar
oneroso para o registro de grandes volumes de dados no sistema e por isso deve ser evitado
e somente utilizado quando, de fato, for necessrio.

12
4. Padres Tcnicos

4.1. Padro de documento XML

A especificao do documento XML adotada a recomendao W3C para XML


1.0, disponvel em http://www.w3.org/TR/REC-xml.

A codificao dos caracteres ser em UTF-8, assim todos os documentos XML


sero iniciados com a seguinte declarao:

<?xml version="1.0" encoding="UTF-8"?>

Cada arquivo XML somente poder ter uma nica declarao <?xml version="1.0"
encoding="UTF-8"?>. Nas situaes em que um documento XML pode conter outros
documentos XML, como ocorre com o documento XML de servios que recebem lote de
eventos, deve-se tomar cuidado para que exista uma nica declarao no incio do
documento.

Alguns caracteres especiais/reservados pela sintaxe XML quando forem inseridos


como dado de contedo devero ser substitudos pelos seus respectivos caracteres de escape
conforme a tabela abaixo:

Caractere Escape

> (sinal de maior) &gt;

< (sinal de menor) &lt;

& (e comercial) &amp;

13
(aspas duplas) &quot;

(sinal de apstrofe ou aspas simples) &apos;

4.1.1 Declarao namespace

Cada evento XML dever ter uma nica declarao de namespace no elemento raiz
do documento com o seguinte padro:

<eSocial xmlns="http://www.esocial.gov.br/schema/lote/eventos/envio/vx_x_x" >

O uso de declarao namespace diferente do padro estabelecido vetado.

A declarao do namespace da assinatura digital dever ser realizada na prpria tag


<Signature>, conforme exemplo abaixo:

<eSocial xmlns="http://www.esocial.gov.br/schema/evt">

<!-- Xml do Evento -->

<Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
<.../>
</Signature>
</eSocial>

4.2. Schema XML

A estrutura dos XML recebidos pelo eSocial so especificadas e checadas por um


Schema, que uma linguagem que define a estrutura do documento XML, descrevendo os
seus elementos e a sua organizao, alm de estabelecer regras de preenchimento de

14
contedo e de obrigatoriedade de cada elemento ou grupo de informao. Este Schema
XML representado, fisicamente, por um arquivo de extenso XSD.

A validao da estrutura XML da mensagem realizada por um analisador sinttico


(parser) que verifica se a mensagem atende as definies e regras de seu Schema XML.
Qualquer divergncia da estrutura XML da mensagem em relao ao seu Schema XML
provoca um erro de validao.

4.3. Padro de Comunicao

A comunicao ser baseada em Webservices, disponibilizados pelo sistema


eSocial.

O meio fsico de comunicao utilizado ser a Internet, com o uso do protocolo


HTTPS (TLS), com autenticao mtua, que alm de garantir um duto de comunicao
seguro na Internet, permite a identificao do servidor e do cliente atravs de certificados
digitais.

O modelo de comunicao segue o padro de Webservices definido pelo WS-I Basic


Profile.

A troca de mensagens entre os Webservices do ambiente do sistema eSocial e os


aplicativos dos contribuintes ser realizada no padro SOAP verso 1.1, com troca de
mensagens XML no padro Style/Enconding: Document/Literal.

Exemplo de uma mensagem SOAP:

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://www.w3.org/2003/05/soap-envelope">

15
<soap:Header></soap:Header>

<soap:Body>CORPO DA MENSAGEM SOAP</soap:Body>

</soap:Envelope>

4.4. Padro de certificado digital

O certificado digital utilizado no sistema eSocial dever ser emitido por Autoridade
Certificadora credenciada pela Infraestrutura de Chaves Pblicas Brasileira ICP-Brasil.

Este dever pertencer srie A. Existem duas sries as quais os certificados podem
pertencer, a srie A e a S. A srie A rene os certificados de assinatura digital utilizados na
confirmao de identidade na Web, em e-mails, em redes privadas virtuais (VPN) e em
documentos eletrnicos com verificao da integridade de suas informaes. A srie S
rene os certificados de sigilo que so utilizados na codificao de documentos, de bases de
dados, de mensagens e de outras informaes eletrnicas sigilosas.

O certificado digital dever ser do tipo A1 ou A3. Certificados digitais de tipo A1


ficam armazenados no prprio computador a partir do qual ele ser utilizado. Certificados
digitais do tipo A3 so armazenados em dispositivo porttil inviolvel do tipo smart card
ou token, que possuem um chip com capacidade de realizar a assinatura digital. Este tipo de
dispositivo bastante seguro, pois toda operao realizada pelo chip existente no
dispositivo, sem qualquer acesso externo chave privada do certificado digital.

Para que um certificado seja aceito na funo de transmissor de solicitaes este


dever ser do tipo e-CPF (e-PF) ou e-CNPJ (e-PJ).

Os certificados digitais sero exigidos em dois momentos distintos:

1. Transmisso: antes de ser iniciada a transmisso de solicitaes ao sistema eSocial,


o certificado digital do solicitante utilizado para reconhecer o transmissor e
garantir a segurana do trfego das informaes na INTERNET.

16
2. Assinatura de documentos: para garantir o no repdio e a integridade das
informaes os documentos eletrnicos enviados para o eSocial so assinados
digitalmente seguindo a especificao descrita em 4.5 - Padro de assinatura digital
e as orientaes estabelecidas no "Manual de Orientao do eSocial".

4.5. Padro de assinatura digital

O sistema eSocial utiliza um subconjunto do padro de assinatura XML definido


pelo http://www.w3.org/TR/xmldsig-core/.

1. Padro de assinatura: XML Digital Signature, utilizando o formato Enveloped


(http://www.w3.org/TR/xmldsig-core/)

2. Certificado digital: emitido por AC credenciada no ICP-Brasil


(http://www.w3.org/2000/09/xmldsig#X509Data)

3. Cadeia de certificao: EndCertOnly (Incluir na assinatura apenas o certificado do


usurio final)

3.1. Tipo do certificado: A1 ou A3

4. Tamanho da chave criptogrfica: compatvel com os certificados A1 e A3 (2048


bits)

5. Funo criptogrfica assimtrica: RSA (http://www.w3.org/2001/04/xmldsig-


more#rsa-sha256)

6. Funo de message digest: SHA-256.


(http://www.w3.org/2001/04/xmlenc#sha256)

7. Codificao: Base64 (http://www.w3.org/2000/09/xmldsig#base64)

17
8. Transformaes exigidas: til para realizar a canonicalizao do XML enviado
para realizar a validao correta da assinatura digital. So elas:

8.1. Enveloped (http://www.w3.org/2000/09/xmldsig#enveloped-signature)

8.2. C14N (http://www.w3.org/TR/2001/REC-xml-c14n-20010315)

As informaes necessrias identificao do assinante esto presentes dentro do


certificado digital, tornando desnecessria a sua representao individualizada no arquivo
XML. Portanto, o arquivo XML assinado deve conter apenas a tag X509Certificate nas
informaes que dizem respeito ao certificado.

Abaixo temos um exemplo de um evento assinado digitalmente:

<?xml version="1.0" encoding="utf-8"?>


<eSocial xmlns="http://www.esocial.gov.br/schema/evt/">
<!-- Xml do Evento -->
<Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
<SignedInfo>
<CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-
20010315" />
<SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-
sha256" />
<Reference URI="">
<Transforms>
<Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-
signature" />
<Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-
20010315" />
</Transforms>
<DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256" />
<DigestValue>CFJEIy1dUko99nNUW/ICvG9ZNoij0o9IOhdP6Nt1j1k=</DigestValue>
</Reference>
</SignedInfo>
<SignatureValue>...</SignatureValue>
<KeyInfo>
<X509Data>
<X509Certificate>...</X509Certificate>
</X509Data>
</KeyInfo>
</Signature>
</eSocial>

18
4.6. Processo de validao de assinatura digital

O Procedimento de validao da assinatura digital adotado pelo sistema eSocial :

1) extrair a chave pblica do certificado;

2) verificar o prazo de validade do certificado utilizado;

3) montar e validar a cadeia de confiana dos certificados validando tambm a LCR


(Lista de Certificados Revogados) de cada certificado da cadeia;

4) validar o uso da chave utilizada (assinatura digital) de forma a aceitar certificados


somente do tipo A (no sero aceitos certificados do tipo S);

5) garantir que o certificado utilizado de um usurio final e no de uma autoridade


certificadora;

6) adotar as regras definidas pelo RFC 3280 para as LCR e cadeia de confiana;

7) validar a integridade de todas as LCR utilizadas pelo sistema;

8) prazo de validade de cada LCR utilizada (verificar data inicial e final).

19
4.7. Resumo dos padres tcnicos

A tabela a seguir resume os principais padres de tecnologia utilizados:

Caracterstica Descrio

Padro definido pelo WS-I Basic Profile 1.1 (http://www.ws-


Webservices
i.org/Profiles/BasicProfile-1.1-2004-08-24.html)

Meio lgico de
Webservice (s) disponibilizado (s) pelo sistema eSocial
comunicao

Meio fsico de
INTERNET
comunicao

HTTPS (TLS), com autenticao mtua atravs de certificados


Protocolo Internet
digitais

Padro de troca de
SOAP verso 1.1
mensagens

Padro da mensagem XML no padro Style/Encoding: Document/Literal

X.509 verso 3, emitido por Autoridade Certificadora credenciada


pela Infraestrutura de Chaves Pblicas Brasileira ICP-Brasil, do
Padro de certificado tipo A1 ou A3, devendo ser um e-CPF (e-PF) ou e-CNPJ (e-PJ).
digital
Para transmisso, utilizar o certificado digital do responsvel pela
transmisso.

20
XML Digital Signature, Enveloped, com certificado digital X.509
verso 3, com chave privada de tamanho varivel, conforme o
Padro de assinatura
padro da ICP-Brasil (1024, 2048, ou mais bits), com padres de
digital
criptografia assimtrica RSA, algoritmo message digest SHA-256
e utilizao das transformaes Enveloped e C14N.

Validao de assinatura Ser validada alm da integridade e autoria, a cadeia de confiana


digital com a validao das LCR.

Campos no obrigatrios do Schema que no possuam contedo


tero suas tags suprimidas no arquivo XML

Padres de Nos campos numricos inteiros, no incluir vrgula ou ponto


preenchimento XML decimal.

Nos campos numricos com casas decimais, utilizar o ponto


decimal na separao da parte inteira.

21
5. Webservices

5.1. Padro de Mensagens dos Webservices

Os mtodos de solicitao de processamento e de consultas dos Webservices do


sistema eSocial foram projetados para receberem mensagens no padro XML como
parmetro de entrada dos mtodos, assim como retornar mensagens no padro XML.

Os Schemas que definem os XML recebidos pelo sistema eSocial sero


disponibilizados no stio https://portal.esocial.gov.br, e sero liberados aps autorizao da
Coordenao Tcnica do Sistema.

Haver dois pacotes de Schemas:

Comunicao: contm os Schemas envolvidos no processo de comunicao


com o eSocial (Schema do Lote de Eventos, Schema do Retorno de Envio de
Lote, Schema do Retorno de Processamento de Lotes). Os Schemas deste pacote
esto descritos nas sees 5.4. Webservice de Envio de Lote de Eventos e 5.5.
Webservice de Consulta ao Resultado do Processamento de um Lote de
Eventos.

Eventos: contm os Schemas dos eventos de negcio previstos para o eSocial


(Schema do Evento de remunerao, de frias, de admisso, etc..). Os Schemas
deste pacote esto descritos na seo 6.

22
Eventos.

5.2. Validao da Estrutura da Mensagem no Webservice

Os Webservices disponibilizados pelo sistema eSocial, possuem como entrada de


dados mensagens utilizando a linguagem de marcao XML, as quais so validadas com os
Schemas que as define, e rejeitadas caso seja encontrada alguma inconsistncia.

Assim, os aplicativos que fazem solicitaes ao sistema eSocial devem estar


preparados para gerar lotes de eventos no formato definido pelo XSD em vigor.

As alteraes da estrutura de dados XML realizadas nas mensagens so controladas


atravs da verso definida no namespace do Schema. A identificao da verso dos
Schemas ser realizada com o acrscimo do nmero da verso como sufixo no namespace
do XML e no nome do arquivo, conforme o exemplo abaixo:

Namespace:

http://www.esocial.gov.br/schema/lote/eventos/envio/vx_x_x

Nome arquivo:

loteEventos-vx_x_x.xsd (Schema XML para o lote de eventos)

Onde x_x_x corresponde a verso mais recente publicada.

As modificaes de leiaute das mensagens do Webservice podem ser causadas por


necessidades tcnicas ou em razo da modificao de alguma legislao. As modificaes
decorrentes de alterao da legislao devero ser implementadas nos prazos previstos no
ato normativo que introduziu a alterao. As modificaes de ordem tcnica sero
divulgadas pela Coordenao Tcnica do Sistema e podero ocorrer sempre que se fizerem
necessrias.

23
5.3. Validao do Certificado Digital

Os certificados digitais podem ser utilizados tanto nas conexes TLS de transmisso
dos lotes de eventos para o eSocial, quanto para a assinatura dos eventos. Neste caso, os
efeitos da validao podem se dar para todo o lote (no caso de o erro ser gerado a partir do
certificado de transmisso) como para um evento especfico (no caso do erro ser gerado a
partir de uma assinatura de um documento XML, enviado ao eSocial, que representa o
evento).

Os Certificados Digitais utilizados no acesso aos servios disponibilizados pelo


sistema eSocial e na assinatura dos arquivos XML enviados a este devero atender aos
seguintes critrios:

Critrio Mensagem Efeito

A formao da cadeia de certificao at sua raiz deve Rejeio do lote


148
ser confivel. ou do evento

A raiz da cadeia dever pertencer a Autoridade Rejeio do lote


149
Certificadora Raiz Brasileira (ICP-Brasil). ou do evento

Rejeio do lote
O certificado no poder estar revogado. 150
ou do evento

O certificado no poder estar expirado na data da Rejeio do lote


151
verificao. ou do evento

O certificado dever ser do tipo e-CNPJ, ou e-PJ, se o Rejeio do lote


152
certificado for de Pessoa Jurdica. ou do evento

O certificado dever ser do tipo e-CPF, ou e-PF, se o Rejeio do lote


153
certificado for de Pessoa Fsica. ou do evento

Rejeio do lote
O certificado no foi encontrado. 4
ou do evento

24
Rejeio do lote
Falha ao acessar a lista de certificados revogados. 11
ou do evento

5.4. Webservice de Envio de Lote de Eventos

A funo deste Webservice receber um lote de eventos, valid-lo e retornar o


Protocolo de Envio, que dever ser armazenado pelo empregador para, em outro momento,
consultar o resultado do processamento do lote.

Neste Webservice sero as executadas as validaes de nvel 1, conforme descrito


na seo 3.2. Nveis de Validao.

Cada evento enviado, atravs do lote de eventos, deve ser assinado individualmente
dentro do lote. Alm disso, o lote somente poder conter eventos de um nico empregador
e do mesmo grupo. Caso existam eventos pertencentes a um grupo diferente do informado
no lote, o sistema eSocial ir considera-los rejeitados e no ir processa-los. Os grupos dos
eventos, e os eventos que compem estes, esto listados no "Manual de Orientao do
eSocial".

5.4.1. Dados para a chamada ao Webservice

Nome do mtodo EnviarLoteEventos

Assinatura xsd:any EnviarLoteEventos(xsd:any loteEventos)

Sim.

Requer Certificado de Cliente? Observao: No necessrio qualquer tipo de


vnculo formal (ex: procurao) entre o transmissor e
o empregador.

Schema Parmetro loteEventos EnvioLoteEventos-vx_x_x.xsd

25
Schema Retorno RetornoEnvioLoteEventos-vx_x_x.xsd

URL A DEFINIR

26
5.4.2. Fluxo de Envio de Lote de Eventos

Abaixo descrito detalhadamente o processo de envio de lote de eventos:

27
5.4.3. Leiaute Mensagem de Entrada

A mensagem de entrada definida pelo Schema EnvioLoteEventos-vx_x_x.xsd,


cuja estrutura apresentada abaixo:

tag: eSocial

descrio: Tag raiz do documento

obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

xmlns obrigatrio 1 http://www.esocial.gov.br/ Namespace do XSD do


envio de lote de
schema/lote/
eventos.
eventos/envio/vx_x_x

28
grupo obrigatrio 1 1 - Eventos de Tabelas Define o grupo dos
eventos contidos no
2 - Eventos No Peridicos
lote. Durante o
3 - Eventos Peridicos
processamento
verificado se o evento
pertence ao grupo
informado no lote, e
caso no seja, o evento
rejeitado.

tag: envioLoteEventos

descrio: Contm as informaes necessrias ao envio de um lote de eventos

obrigatrio? Sim

ocorrncia nica

tag: ideEmpregador

descrio: Contm a identificao do empregador responsvel pelos eventos


contidos no lote.

obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

tpInsc obrigatrio 1 1 CNPJ; Contm o tipo de inscrio do


empregador.
2 CPF

nrInsc obrigatrio 1 - Contm o nmero de inscrio


do empregador.

29
do empregador.

Observaes:

As informaes do empregador contidas nesta tag so comparadas identificao do


empregador contida nos eventos. Caso as identificaes no coincidam o evento rejeitado.

tag: ideTransmissor

descrio: Contm a identificao da pessoa fsica ou jurdica que transmitiu o


lote de eventos.

obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

tpInsc obrigatrio 1 1 CNPJ; Contm o tipo de inscrio do


transmissor.
2 CPF

nrInsc obrigatrio 1 - Contm o nmero de inscrio


do transmissor.

Observaes:

As informaes do transmissor contidas nesta tag so comparadas ao tipo e nmero de


inscrio contidos no certificado digital utilizado na conexo TLS. Caso as identificaes
no coincidam o lote rejeitado.

tag: eventos

descrio: Contm os eventos que sero processados pelo eSocial.

30
obrigatrio? Sim

ocorrncia nica

tag: evento

descrio: Contm cada evento que ser processado pelo eSocial.

obrigatrio? Sim

ocorrncia 1 .. 50

campo obrigatoriedade ocorrncia valores vlidos descrio

Id obrigatrio 1 - Contm chave de acesso do


evento. O valor deste campo
deve coincidir com o atributo
Id do evento contido no
campo abaixo.

Importante: atravs deste


campo que o empregador
realizar a correlao entre o
evento enviado e o resultado
retornado pelo eSocial.

<any> obrigatrio 1 - Contm o XML do evento.

Observaes:

O contedo do campo evento, deve ser o XML do evento a ser enviado para processamento
no sistema eSocial. Este campo pode ser repetido at 50 vezes, isto quer dizer que o lote de
eventos pode ser composto, no mximo, por 50 eventos.

Existem diferentes estruturas XML, leiautes, para a representao dos eventos recebidos
pelo sistema eSocial. Mais informaes a respeito podem ser obtidas na seo 6. Eventos.

31
5.4.4. Leiaute Mensagem de Retorno do Envio do Lote

A mensagem de retorno definida pelo Schema RetornoEnvioLoteEventos-


vx_x_x.xsd, cuja estrutura apresentada abaixo:

tag: eSocial

descrio: Tag raiz do documento

32
obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

xmlns obrigatrio 1 http://www.esocial.gov.br/ Namespace do XSD do


retorno do envio de lote
schema/lote/
de eventos.
eventos/envio/

retornoEnvio/vx_x_x

tag: retornoEnvioLoteEventos

descrio: Contm o resultado da operao de recepo de um lote de eventos

obrigatrio? Sim

ocorrncia nica

tag: ideEmpregador

descrio: Contm a identificao do empregador responsvel pelos eventos


contidos no lote.

obrigatrio? No

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

tpInsc obrigatrio 1 1 CNPJ; Contm o tipo de inscrio do


empregador.
2 CPF

33
nrInsc obrigatrio 1 - Contm o nmero de inscrio
do empregador.

Observaes:

Esta tag ser preenchida somente quando o lote no apresentar erros de Schema.

tag: ideTransmissor

descrio: Contm a identificao da pessoa fsica ou jurdica que transmitiu o


lote de eventos.

obrigatrio? No

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

tpInsc obrigatrio 1 1 CNPJ; Contm o tipo de inscrio do


transmissor.
2 CPF

nrInsc obrigatrio 1 - Contm o nmero de inscrio


do transmissor.

Observaes:

Esta tag ser preenchida somente quando o lote no apresentar erros de Schema.

34
tag: status

descrio: Contm o resultado do processo de recepo. nesta tag que haver a


informao se o lote foi recebido com sucesso ou no, e qual a causa da
no recepo.

obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

cdResposta obrigatrio 1 201 - Lote recebido com Contm o cdigo de


sucesso. resposta do processo
de recepo. Caso o
202 - Lote recebido com
cdigo seja de erro
advertncias.
ou advertncia, os
301 - Erro servidor
detalhes do mesmo
eSocial.
estaro na tag
401 - Lote incorreto - Erro ocorrencias.
preenchimento.

402 - Lote incorreto -


Schema invlido.

403 - Lote incorreto -


Verso do schema no
permitida.

404 - Lote incorreto - Erro


certificado.

405 - Lote incorreto - Lote


nulo ou vazio.

descResposta obrigatrio 1 - Contm a descrio


correspondente ao
cdigo de resposta.

35
tag: ocorrencias

descrio: Contm as ocorrncias encontradas no lote quando o cdigo de


resposta contido na tag status for diferente de sucesso (cdigo: 201).

obrigatrio? No

ocorrncia nica

tag: ocorrencia

descrio: Contm cada uma das ocorrncias encontradas no lote quando o cdigo
de resposta contido na tag status for diferente de sucesso (cdigo: 201).

obrigatrio? Sim, caso exista a tag ocorrencias

ocorrncia 1..*

campo obrigatoriedade ocorrncia valores vlidos descrio

codigo obrigatrio 1 - Contm o cdigo da


ocorrncia detectada em
alguma das regras previstas na
seo 5.4.5. Validaes
aplicadas.

descricao obrigatrio 1 - Contm a descrio da


ocorrncia detectada em
alguma das regras previstas na
seo 5.4.5. Validaes
aplicadas.

tipo obrigatrio 1 1 - Erro Contm o cdigo do tipo de


ocorrncia.

36
2 - Advertncia

localizacao facultativo 1 - Contm o caminho da tag ou


atributo em que ocorreu o
erro.

tag: dadosRecepcaoLote

descrio: Contm os dados relativos a um lote recebido com sucesso. nesta tag
que est localizado o Protocolo de Envio.

obrigatrio? No

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

dhRecepcao obrigatrio 1 - Contm a data/hora de


recepo do lote de eventos.
Para os eventos para os quais
for emitido o recibo de
entrega esta data ser
considerada a data da entrega
do evento ao eSocial.

versaoAplicativo obrigatrio 1 - Contm a verso do aplicativo


Recepcao de recepo.

protocoloEnvio obrigatrio 1 - Nmero sequencial nico


produzido no instante de
recepo do lote de eventos e
que ser utilizado como
parmetro pelo empregador no
WebService de Consulta ao
Resultado de Processamento
do Lote.

37
Abaixo descrita a regra de
formao deste Protocolo:

A.B.YYYYMM.NNN....N

A = Agente de recepo:
Serpro=1 ou Caixa=2

B = Ambiente de recepo:
1=Produo;
2=Pr-produo - dados reais;
3=Pr-produo - dados
fictcios;
6=Homologao;
7=Validao;
8=Testes;
9=Desenvolvimento;

YYYYMM = Ano e ms da
recepo.

N = Nmero sequencial (19


posies)

Observaes:

Esta tag ser preenchida somente quando o lote for recebido com sucesso.

38
5.4.5. Validaes aplicadas

Critrio Mensagem Efeito

Foi identificado um erro na estrutura do lote 613 Rejeio do lote

No foi possvel verificar a revogao do certificado 11 Rejeio do lote

A solicitao ultrapassou o tamanho limite.


612 Rejeio do lote
Observao: O tamanho limite da mensagem SOAP
750 kbytes.

A verso do lote dever ser a mais recente 608 Rejeio do lote

CNPJ do empregador/transmissor invlido 380 Rejeio do lote

CPF do empregador/transmissor invlido 381 Rejeio do lote

O nmero de inscrio do empregador dever ter o


658 Rejeio do lote
tamanho de 8(CNPJ base), 11(CPF) ou 14 (CNPJ)

O nmero de inscrio do transmissor dever ser igual


ao CNPJ/CPF do certificado utilizado para o envio do 607 Rejeio do lote
lote

A quantidade mxima de eventos por lote de 50 611 Rejeio do lote

O id do evento no atendeu a regra de formao


609 Rejeio do lote
definida

39
5.5. Webservice de Consulta ao Resultado do Processamento de um
Lote de Eventos

A funo deste Webservice receber solicitaes de consulta ao resultado do


processamento de um lote de eventos, valida-los e retornar os objetos da consulta de acordo
com os parmetros enviados ao servio.

O Protocolo de Envio do lote dever ser passado como parmetro de entrada do


mtodo de consulta ao resultado do processamento.

5.5.1. Dados para a chamada ao Webservice

Nome do mtodo ConsultarResultadoProcessamento

Assinatura xsd:any ConsultarResultadoProcessamento(xsd:any consulta)

Sim.
Observao: Somente quem transmitiu a solicitao de
Requer Certificado de processamento tem acesso ao resultado do processamento.
Cliente? Portanto, necessrio utilizar o mesmo certificado (certificado
com o mesmo nmero de inscrio) da transmisso para acessar o
resultado do processamento do lote.

Schema Parmetro "consulta" ConsultaLoteEventos-vx_x_x.xsd

Schema Retorno RetornoProcessamentoLote-vx_x_x.xsd

URL A DEFINIR

40
5.5.2. Fluxo de consulta ao resultado do processamento do lote de eventos

Abaixo descrito detalhadamente o processo de consulta ao resultado do


processamento do lote de eventos:

41
5.5.3. Leiaute da Mensagem de Entrada

A mensagem de entrada definida pelo Schema ConsultaLoteEventos-vx_x_x.xsd,


cuja estrutura apresentada abaixo:

tag: eSocial

descrio: Tag raiz do documento

obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

xmlns obrigatrio 1 http://www.esocial.gov.br/ Namespace do XSD


de consulta ao
schema/lote/
resultado do
eventos/envio/consulta/
processamento de
retornoProcessamento/vx_x_x lote de eventos.

tag: consultaLoteEventos

descrio: Contm os parmetros da consulta ao lote de eventos.

obrigatrio? Sim

ocorrncia nica

42
campo obrigatoriedade ocorrncia valores vlidos descrio

protocoloEnvio obrigatrio 1 - Nmero sequencial nico


retornado pelo eSocial no
instante de recepo do lote de
eventos.

43
5.5.4. Leiaute Mensagem de Retorno do Processamento do Lote

A mensagem de entrada definida pelo Schema RetornoProcessamentoLote-


vx_x_x.xsd, cuja estrutura apresentada abaixo:

44
tag: eSocial

descrio: Tag raiz do documento

obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

xmlns obrigatrio 1 http://www.esocial.gov.br/sc Namespace do XSD


hema/lote/eventos/envio/retor de retorno do
noProcessamento/vx_x_x resultado do
processamento de
lote de eventos.

tag: retornoProcessamentoLoteEventos

descrio: Contm o resultado da operao de processamento de um lote de


eventos

obrigatrio? Sim

ocorrncia nica

tag: ideEmpregador

descrio: Contm a identificao do empregador responsvel pelos eventos


contidos no lote.

obrigatrio? No

ocorrncia nica

45
campo obrigatoriedade ocorrncia valores vlidos descrio

tpInsc obrigatrio 1 1 CNPJ; Contm o tipo de inscrio do


empregador.
2 CPF

nrInsc obrigatrio 1 - Contm o nmero de inscrio


do empregador.

Observaes:

Esta tag somente no ser preenchida quando houver um erro no servidor que impossibilite
a obteno do lote sob consulta.

tag: ideTransmissor

descrio: Contm a identificao da pessoa fsica ou jurdica que transmitiu o


lote de eventos.

obrigatrio? No

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

tpInsc obrigatrio 1 1 CNPJ; Contm o tipo de inscrio do


transmissor.
2 CPF

nrInsc obrigatrio 1 - Contm o nmero de inscrio


do transmissor.

Observaes:

Esta tag somente no ser preenchida quando houver um erro no servidor que impossibilite
a obteno do lote sob consulta.

46
tag: status

descrio: Contm o resultado do processamento do lote. nesta tag que haver a


informao se o lote j foi processado e qual o resultado do
processamento do lote.

obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

cdResposta obrigatrio 1 101 - Lote Contm o cdigo de


Aguardando resposta do
Processamento. processamento do lote.
Caso o cdigo seja de
201 - Lote Processado
erro ou advertncia, os
com Sucesso.
detalhes do mesmo
202 - Lote Processado
estaro na tag
com Advertncias.
ocorrencias.
301 - Erro Servidor
eSocial

401 - Lote Incorreto -


Erro preenchimento.

402 - Lote Incorreto -


Schema Invlido.

403 - Lote Incorreto -


Verso do Schema no
permitida.

404 - Lote Incorreto -


Erro Certificado.

405 - Lote Incorreto -


Lote nulo ou vazio.

501 - Solicitao de
Consulta Incorreta -

47
Erro Preenchimento.

502 - Solicitao de
Consulta Incorreta -
Schema Invlido.

503 - Solicitao de
Consulta Incorreta -
Verso do Schema
No Permitida.

504 - Solicitao de
Consulta Incorreta -
Erro Certificado.

505 - Solicitao de
Consulta Incorreta -
Consulta nula ou
vazia.

descResposta obrigatrio 1 - Contm a descrio


correspondente ao cdigo
de resposta.

tempoEstimado opcional 1 - Contm o tempo


Conclusao estimado, em segundos,
para concluso do
processamento do lote de
eventos. importante que
este tempo seja
considerado no
desenvolvimento da
consulta ao Webservice
para no ser considerado
um uso indevido
conforme seo 5.6.4.
Tempo de espera para
busca do resultado do
processamento.

48
tag: ocorrencias

descrio: Contm as ocorrncias encontradas no lote quando o cdigo de


resposta contido na tag status indicar que foram encontrados erros ou
advertncias no lote.

obrigatrio? No

ocorrncia nica

tag: ocorrencia

descrio: Contm cada uma das ocorrncias encontradas no lote quando o cdigo
de resposta contido na tag status indicar que foram encontrados erros
ou advertncias no lote.

obrigatrio? Sim, caso exista a tag ocorrencias

ocorrncia 1..*

campo obrigatoriedade ocorrncia valores vlidos descrio

codigo obrigatrio 1 - Contm o cdigo da


ocorrncia detectada em
alguma das regras previstas na
seo 5.4.5. Validaes
aplicadas.

descricao obrigatrio 1 - Contm a descrio da


ocorrncia detectada em
alguma das regras previstas na
seo 5.4.5. Validaes
aplicadas.

tipo obrigatrio 1 1 - Erro Contm o cdigo do tipo de


ocorrncia.

49
2 - Advertncia ocorrncia.

localizacao facultativo 1 - Contm o caminho da tag ou


atributo em que ocorreu o
erro.

tag: dadosRecepcaoLote

descrio: Contm os dados relativos a recepo de um lote.

obrigatrio? No

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

dhRecepcao obrigatrio 1 - Contm a data/hora de


recepo do lote de eventos.

versaoAplicativo obrigatrio 1 - Contm a verso do


Recepcao aplicativo de recepo.

protocoloEnvio obrigatrio 1 - Nmero sequencial nico


produzido no instante de
recepo do lote de eventos.

Observaes:

Esta tag ser preenchida somente quando a consulta ao lote for realizada com sucesso.

tag: dadosProcessamentoLote

descrio: Contm os dados relativos ao processamento de um lote.

obrigatrio? No

50
ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

versaoAplicativo obrigatrio 1 - Contm a verso do


Processamento aplicativo de processamento
Lote do lote.

Observaes:

Esta tag ser preenchida somente quando a consulta ao lote for realizada com sucesso.

tag: retornoEventos

descrio: Contm o retorno com o resultado do processamento de cada um dos


eventos contido no lote.

obrigatrio? No

ocorrncia nica

Observaes:

Esta tag somente ser preenchida quando o campo <cdResposta> contido na tag <status>
contiver o valor maior que 200 e menor que 300.

tag: evento

descrio: Contm o resultado do processamento de cada evento contido no lote e o


resultado do respectivo totalizador, caso o evento retorne algum dos
totalizadores.

obrigatrio? No

51
ocorrncia 1 .. 50

campo obrigatoriedade ocorrncia valores vlidos descrio

Id obrigatrio 1 - Contm a chave de acesso do


evento ao qual o retorno de
processamento se refere.

Importante: atravs deste


campo que o empregador
realizar a correlao entre o
evento enviado e o resultado
retornado pelo eSocial.

tag: retornoEvento

descrio: Contm o resultado do processamento de um evento contido no lote.

obrigatrio? Sim

ocorrncia 1

campo obrigatoriedade ocorrncia valores vlidos descrio

<any> obrigatrio 1 - Contm o XML de retorno do


evento. O Schema que define
este retorno est descrito na
seo 6.5. Estrutura do retorno
de processamento do evento.

tag: tot

descrio: Contm o resultado do processamento do totalizador de um evento


contido no lote.

52
obrigatrio? No

ocorrncia 0 .. *

campo obrigatoriedade ocorrncia valores vlidos descrio

tipo obrigatrio 1 S-5001 Deve ser preenchido com os


valores vlidos para este campo.
S-5002

S-5011

S-5012

<any> obrigatrio 1 - Contm o XML do totalizador.

Observaes:

As orientaes sobre o preenchimento da tag tot est da seo 5.5.5. Retorno dos eventos
totalizadores.

5.5.5. Retorno dos eventos totalizadores

Os eventos totalizadores sero obtidos atravs do retorno dos eventos S-1200, S-


1210, S-1299, S-2299 e S-2399.

Sempre que os eventos S-1200, S-2299 e S-2399 forem processados pelo eSocial,
sero retornados o seu recibo (na tag retornoEvento) e o totalizador S-5001 (na tag tot com
o atributo tipo preenchido com o valor S-5001).

Sempre que o evento S-1210 for processado pelo eSocial, sero retornados o seu
recibo (na tag retornoEvento) e o totalizador S-5002 (na tag tot com o atributo tipo
preenchido com o valor S-5002).

Sempre que o evento S-1299 for processado pelo eSocial, sero retornados o seu
recibo na tag retornoEvento e os totalizadores S-5011 e S-5012. Neste caso, sero

53
retornadas 2 tags tot, uma com o atributo tipo preenchido com o valor S-5011 e a outra com
o atributo tipo preenchido com o valor S-5012.

5.5.6. Validaes aplicadas

Critrio Mensagem Efeito

O retorno do processamento do lote somente acessvel Rejeio da


604
a quem enviou o lote consulta

O lote no foi localizado ou j no est mais disponvel Rejeio da


605
no sistema. consulta

Rejeio da
Foi identificado um erro na estrutura da solicitao. 606
consulta

O lote no foi localizado ou ainda no foi entregue ao Rejeio da


662
Ambiente Nacional pelo agente de recepo. consulta

5.6. Recomendaes e boas prticas

O objetivo desta seo orientar os usurios dos Webservices a utilizarem o eSocial


seguindo boas prticas, facilitando a integrao com o sistema.

5.6.1. Respeitar a ordem de precedncia no envio dos eventos em lotes

O eSocial controla a precedncia do recebimento dos eventos por empregador e por


empregado, de acordo com as regras estabelecidas pelo leiaute, com o objetivo de garantir a
integridade dos dados da empresa e do trabalhador.

O primeiro evento a ser enviado deve sempre ser o S-1000 (Informaes do


Empregador/Contribuinte/rgo Pblico) e, em seguida, devem ser enviados os eventos de
tabelas. Quanto a estes h uma especificidade: quando houver necessidade do envio de mais
de um lote deste tipo de evento, eles no sero processados simultaneamente. O usurio
deve aguardar a mensagem de sucesso do processamento do primeiro lote para, na
sequncia, enviar o prximo e, assim, sucessivamente.

54
Alm disso, para todos os tipos de evento, deve sempre ser observada a ordem
lgica para o seu envio, conforme regras estabelecidas no leiaute.

Quanto transmisso dos eventos de tabelas, ela deve ocorrer lote a lote, de forma
sequencial, por empregador.

O envio dos eventos no peridicos deve ocorrer lote a lote, de forma sequencial,
por empregado, respeitando a precedncia definida pelo leiaute do eSocial. Dessa forma,
uma boa prtica agrupar os eventos de um trabalhador em um nico lote. Caso o
trabalhador possua uma quantidade de eventos maior que a quantidade permitida no lote, o
prximo lote somente deve ser transmitido aps a empresa receber o resultado do
processamento referente a ltima transmisso.

Segue abaixo um exemplo de transmisso de eventos no peridicos.

Situao: O empregado foi admitido e em seguida afastado. Existem duas formas


corretas de envio:

1. Enviar a admisso em um lote. Aguardar o resultado do processamento. Em caso


de sucesso, enviar o afastamento em outro lote.

1. Enviar a admisso seguida do afastamento em um nico lote. Caso o eSocial


receba o afastamento antes da admisso, o afastamento ser rejeitado.

O envio dos eventos peridicos pode e deve ser paralelizado. Porm, deve-se
atentar para a precedncia definida pelo leiaute do eSocial. Por exemplo, o S-1200 de um
trabalhador deve ser enviado antes do S-1210.

Recomendamos as seguintes alternativas para envio dos eventos peridicos:

1. Enviar lotes dos S-1200 de todos os empregados de forma paralela; em seguida,


enviar lotes de todos os S-1210, tambm de forma paralela; para em seguida
enviar o S-1299.

55
2. Enviar pares de eventos S-1200 e S-1210 em um mesmo lote, de forma paralela,
para em seguida enviar o S-1299. Caso as regras de precedncia no forem
seguidas, o eSocial rejeitar o evento.

5.6.2. Evitar o envio de eventos de outros grupos durante o envio dos


eventos peridicos

O fluxo de processamento dos eventos peridicos se inicia com o processamento do


primeiro evento do perodo e termina com o processamento do evento de fechamento.

Enquanto o envio de eventos peridicos est em aberto, pode-se enviar eventos de


outros agrupamentos (eventos iniciais, de tabelas e no peridicos) para o sistema eSocial,
mas alguns destes eventos podem gerar impacto nos eventos peridicos j enviados,
fazendo com que seja necessrio retific-los. Com isto, o envio de eventos de outros
agrupamentos enquanto o envio de eventos peridicos est em aberto desencorajado.
Caso seja estritamente necessrio pede-se muita ateno para evitar transtornos no
fechamento do envio de eventos peridicos.

5.6.3. Evitar o envio de eventos durante o processamento do fechamento


da folha

Durante o processamento do evento S-1299 - Fechamento dos Eventos Peridicos


o eSocial no ir internalizar nenhum evento, com o objetivo de garantir a integridade dos
dados do Empregador no Sistema.

Caso algum evento seja enviado durante o processamento do fechamento da folha


ele ser rejeitado. O retorno do processamento do lote informar que o(s) evento(s)
enviado(s) foi(ram) rejeitado(s) pelo motivo da folha estar em processamento. Nesta
situao, o Empregador deve aguardar o trmino do fechamento atravs da recepo do
recibo do evento S-12999 e retransmitir o(s) evento(s).

56
5.6.4. Tempo de espera para busca do resultado do processamento

No retorno do processamento do lote de eventos h uma tag


(<tempoEstimadoConclusao>) em que os servidores do eSocial informaro ao empregador
qual o tempo estimado para concluso do lote de eventos consultado. importante que os
sistemas implementados pelos empregadores utilizem esta informao como referncia para
definir o intervalo de consulta aos Webservices do eSocial, visto que o eSocial controlar o
uso indevido dos servidores do eSocial pelos sistemas dos empregadores.

5.6.5. Otimizao na montagem do arquivo

No dever ser includa a tag de campo com contedo zero (para campos tipo
numrico) ou vazio (para campos tipo caractere) na gerao do arquivo XML para servir de
insumo e de resposta para os servios disponibilizados pelo eSocial. Exceto para os campos
identificados como obrigatrios no modelo, neste caso, dever constar a tag com o valor
correspondente (mesmo que este seja zero ou vazio) e, para os demais campos, devero ser
eliminadas as tags.

Para reduzir o tamanho final do arquivo XML a ser transportado alguns cuidados de
programao devero ser assumidos:

no incluir "zeros no significativos" para campos numricos, exceto quando o


campo possuir um universo definido de valores vlidos;

no incluir "espaos" no incio ou no final de campos numricos e alfanumricos;

no incluir comentrios no arquivo XML;

no incluir anotao e documentao no arquivo XML (tag annotation e tag


documentation);

no incluir caracteres de formatao.

57
5.6.6. Validao de Schema

Para garantir minimamente a integridade das informaes prestadas e a correta


formao dos arquivos XML, o consumidor dos servios dever submeter as mensagens
XML para validao pelo Schema do XML (XSD XML Schema Definition),
disponibilizado no stio https://portal.esocial.gov.br antes do seu envio.

58
6. Eventos

As informaes relativas a elaborao dos documentos XML contendo o Evento e o


Retorno do processamento esto detalhados abaixo:

6.1. Estrutura do evento

Cada evento tem sua prpria estrutura, obedecendo ao leiaute estabelecido no


"Manual de Orientao do eSocial". A verificao da estrutura dos eventos, conforme os
seus respectivos leiautes, ser realizada atravs de XSD (Xml Schema Definition).

Cada XSD que representa um leiaute tem o seu prprio Namespace.

Ex. http://www.esocial.gov.br/schema/evt/evtInfoEmpregador/vx_x_x

http://www.esocial.gov.br/schema/evt Estabelece que o XSD de um evento do eSocial.


evtInfoEmpregador Identificao do tipo do evento.
vx_x_x Identificao da verso do XSD e do Leiaute.
Conforme "Versionamento dos leiautes dos
eventos"

59
A imagem abaixo ilustra a estrutura bsica de um evento:

tag: eSocial

descrio: Tag raiz do documento do eSocial

obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

xmlns obrigatrio 1 Namespace Namespace do Xsd que


representa o leiaute do tipo do
evento.

60
tag: evtXXX

descrio: Tag que identifica o tipo do evento (O nome dessa tag est presente tambm
no namespace do Xsd da estrutura do evento).

Em cada tipo de evento essa tag tem um nome especfico.

obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

Id obrigatrio 1 - Identificao nica do evento.


Conforme definido em
"Identificao do evento"

tag: ideEvento

descrio: Contm informaes gerais do evento.

obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

tpAmb obrigatrio 1 1=Produo; Identificao do ambiente


para o qual o evento est
2=Pr-produo -
sendo transmitido
dados reais;

3=Pr-produo -
dados fictcios;

6=Homologao;

61
7=Validao;

8=Testes;

9=Desenvolvimento;

procEmi obrigatrio 1 1 - Aplicativo do Origem do documento.


Empregador;

2 - Aplicativo Web
do ESocial

verProc obrigatrio 1 - Verso do aplicativo emissor


do evento

tag: ideEmpregador

descrio: Contm a identificao do empregador.

obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

tpInsc obrigatrio 1 1 CNPJ; Contm o tipo de inscrio do


empregador.
2 CPF

nrInsc obrigatrio 1 - Contm o nmero de inscrio


do empregador.

tag: infoXXX

descrio: Tag que comporta as informaes especficas de cada evento, conforme o


leiaute definido no "Manual de Orientao do eSocial".

Em cada tipo de evento essa "tag" tem um nome especifico.

62
obrigatrio? Sim

ocorrncia nica

tag: Signature

descrio: Contm a assinatura do evento.

obrigatrio? Obrigatrio

ocorrncia nica

Observaes:

O padro de assinatura do evento est descrito em "Assinatura do evento".

6.2. Identificao do evento

Cada evento do eSocial possui uma identificao nica, gerada pelo empregador,
conforme o padro abaixo:

Campo Tipo Nr Inscrio Data e hora de gerao Sequencial


Fixo inscrio

ID 1 - CNPJ CPF, CNPJ, ou CNPJ Formato: Nmero sequencial de


ou Base. YYYYMMDDhhmmss livre preenchimento
2 - CPF YYYY- ano; do empregador.
Preencher com zeros a MM - ms;
direita at completar as DD - dia;
14 posies. hh - hora;
mm - minuto;
ss - segundo.
2 (pos) 1 (pos) 14 (pos) 14 (pos) 5 (pos)

63
Exemplo: ID2333901700001892014020213424700001 (36 posies).

OBS.: O nmero de inscrio deve ser informado com CNPJ completo quando a
natureza jurdica do empregador for igual a 1015, 1040, 1074 e 1163, para as demais
naturezas jurdicas deve ser informado o CNPJ base (8 primeiras posies do CNPJ).

6.3. Assinatura do evento

O documento Xml do Evento dever ser assinado com um certificado digital do tipo
e-CPF (e-PF) ou e-CNPJ (e-PJ)., conforme a especificao definida em 4.5 - Padro de
assinatura digital e os critrios estabelecidos no "Manual de Orientao do eSocial".

A assinatura do evento dever ser realizada sobre todo documento Xml e inserida no
local estabelecido no Schema (XSD) de cada tipo de evento, ou seja, no elemento
"Signature".

6.4. Versionamento dos leiautes dos eventos

O versionamento dos leiautes dos eventos ser por tipo de evento. Assim, a
alterao do leiaute de um determinado tipo de evento no afeta a verso dos demais tipos
de eventos.

Os leiautes vlidos em um determinado perodo sero empacotados e distribudos


atravs dos "Pacotes de liberao". Cada pacote de liberao tem os leiautes dos tipos de
eventos suportados pelo eSocial com as suas respectivas verses.

Segue abaixo os princpios que sero considerados no versionamento dos leiautes:

O leiaute do tipo de evento compreende apenas a sua estrutura. Assim um


mesmo leiaute pode ter diferente conjunto de regras e valores vlidos durante o
seu perodo de vigncia. A alterao dos valores vlidos ou do conjunto de
regras de um leiaute, sem alterao de sua estrutura, ser realizada atravs da

64
atualizao do "Manual de Orientao do eSocial", ou seja, no haver alterao
da verso do leiaute.

Para cada tipo de evento haver apenas uma verso de leiaute vigente em um
determinado perodo.

Cada XSD identificado por um nico Namespace e cada XSD representa


apenas um leiaute.

O eSocial identificar a verso do leiaute do evento atravs do namespace do


Xml do evento.

Identificao da verso de Leiaute (X.Y) e Schema XML - XSD (X_Y_Z)

Onde:

X -> utilizado para representar mudanas muito significativas (Reestruturao do


evento)

Y -> utilizado para representar mudanas estruturais comuns (Incluso/excluso de


campos, dente outras).

Z -> utilizados para corrigir erros em XSD publicados e, possivelmente, j


utilizados. Neste caso haver uma substituio do "Pacote de liberao" do referido
perodo.

OBS.: A necessidade de alterao da verso do leiaute de um determinado tipo de


evento, sem a alterao da sua estrutura, o que representa uma exceo, implicar a
criao de um novo XSD. Assim, no haver qualquer modificao estrutural no XSD,
apenas o namespace ser modificado para acompanhar a nova verso do leiaute.

65
6.5. Estrutura do retorno de processamento do evento

Para cada evento enviado, o Sistema eSocial gera um documento Xml com
informaes referentes ao processamento do evento. Se o Sistema eSocial no identificar
nenhum erro no evento durante o seu processamento, o evento ser aceito e um nmero de
recibo de entrega ser gerado. O documento de retorno de processamento somente ser
assinado digitalmente se o evento for validado sem erros e aceito pelo eSocial.

A imagem abaixo ilustra a estrutura do retorno de processamento do evento que est


especificado no Schema RetornoEvento-vx_x_x.xsd:

66
tag: eSocial

descrio: Tag raiz do documento do eSocial.

obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

xmlns obrigatrio 1 http://www.esocial.gov.br/sch Namespace do


ema/evt/retornoEvento/vx_x_x Xsd do retorno
de
processamento
do evento.

tag: retornoEvento

descrio: Tag principal do retorno de processamento de evento.

obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

Id obrigatrio 1 Identificao nica do evento.


Conforme definido em
"Identificao do evento"

tag: ideEmpregador

descrio: Contm a identificao do empregador.

67
obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

tpInsc obrigatrio 1 1 CNPJ; Contm o tipo de inscrio do


empregador.
2 CPF

nrInsc obrigatrio 1 - Contm o nmero de inscrio


do empregador.

tag: recepcao

descrio: Contm os dados de recepo do evento.

obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

tpAmb obrigatrio 1 1=Produo; Identificao do ambiente de


recepo do evento.
2=Pr-produo -
dados reais;

3=Pr-produo -
dados fictcios;

6=Homologao;
7=Validao;

8=Testes;

9=Desenvolvimento;

dhRecepcao obrigatrio 1 - Data e horrio da recepo do


evento.

68
versaoApp obrigatrio 1 - Verso do aplicativo de
recepo do evento.
Recepcao

protocoloEnvio facultativo 1 - Nmero sequencial nico


produzido no instante de
Lote
recepo do lote de eventos.

tag: processamento

descrio: Contm os dados de processamento do evento.

obrigatrio? Sim

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

cdResposta obrigatrio 1 Cdigo de resposta do


processamento do evento
conforme descrito em
"Cdigos de retorno do
processamento de eventos".

descResposta obrigatrio 1 - Descrio da mensagem de


retorno.

versaoApp obrigatrio 1 Verso do Aplicativo de


processamento do evento.
Processamento

dhProcessamento obrigatrio 1 - Data e horrio do


processamento do evento.

tag: ocorrencias

69
descrio: Contm as ocorrncias encontradas no evento.

obrigatrio? no

ocorrncia nica

Observaes:

Somente poder existir ocorrncia se o campo cdResposta da Tag status for diferente de
Sucesso (Cdigo 201).

tag: ocorrencia

descrio: Contm cada uma das ocorrncias encontradas no evento.

obrigatrio? sim, caso exista a tag ocorrencias

ocorrncia 1..*

campo obrigatoriedade ocorrncia valores descrio


vlidos

tipo obrigatrio 1 1 - Erro Contm o tipo de


ocorrncia.
2 - Advertncia

codigo obrigatrio 1 - Contm o cdigo da


ocorrncia.

descricao obrigatrio 1 - Contm a descrio da


ocorrncia.

localizacao facultativo 1 - Contm a localizao da


ocorrncia no
documento do evento.

70
tag: recibo

descrio: Contm os dados do recibo de entrega do evento

obrigatrio? Facultativo

ocorrncia nica

campo obrigatoriedade ocorrncia valores vlidos descrio

nrRecibo obrigatrio 1 - Nmero de recibo do evento.

Abaixo descrita a regra de


formao deste cdigo:

A.B.CC.NNNNNNNN....N

A = Agente de processamento:
Serpro=1

B = Ambiente de recepo:
1=Produo;
2=Pr-produo - dados reais;
3=Pr-produo - dados
fictcios;
6=Homologao;
7=Validao;
8=Testes;
9=Desenvolvimento;

C = Partio do Empregador
N = Nmero sequencial (19
posies)

hash obrigatrio 1 - Hash do evento. Ser


considerado o hash utilizado
na assinatura do contedo
evento. Elemento DigestValue
do documento Xml assinado.

Observaes:

A tag recibo somente ser preenchida se o evento estiver vlido para o Sistema eSocial.

71
tag: Signature

descrio: Contm a assinatura do documento.

obrigatrio? Facultativo

ocorrncia nica

Observaes:

O retorno do evento somente ser assinado caso o Evento esteja vlido para o Sistema
eSocial. O padro de assinatura do documento de retorno est descrito em "Padro de
Assinatura Digital".

6.6. Cdigos de reposta de processamento do evento

Cdigo Descrio
201 Sucesso.
Sucesso
202 Sucesso com advertncia.
Erro 301 Erro Servidor
eSocial
401 Erro no contedo do evento.
402 Schema invlido.
403 Leiaute invlido.
Erro Erro do certificado digital da
404
cliente assinatura do evento.
405 Erro na assinatura evento
Evento no pertence ao grupo
406
especificado no lote de eventos

72
7. Orientaes para utilizao do ambiente de Produo Restrita

7.1. Sobre a Produo Restrita

O ambiente de Produo Restrita do eSocial tem o objetivo de disponibilizar uma


infraestrutura para as empresas realizarem os testes funcionais de suas aplicaes.

A Produo Restrita ter a mesma verso do eSocial que ser disponibilizada em


ambiente de produo. Toda evoluo do eSocial ser implantada primeiramente no
ambiente de Produo Restrita, onde ficar disponveis para os testes das empresas por um
determinado tempo a ser definido de acordo a caracterstica/tamanho da mudana. Em
seguida, ser implantada no ambiente de Produo.

Com isso, as Empresas faro uso do ambiente de produo, somente aps as suas
aplicaes estarem amadurecidas e estabilizadas diante dos testes realizados na Produo
Restrita.

muito importante ressaltar que a Produo Restrita no um ambiente para as


Empresas realizarem testes de carga ou para simularem suas folhas de pagamento antes de
transmitirem para a Produo.

Seguem abaixo as caractersticas dos ambientes:

Ambiente de Produo Restrita Ambiente de Produo


Menor capacidade de processamento Grande capacidade de processamento
Disponibilidade 24 x 7 (com maior
flexibilidade para realizao de janelas de Disponibilidade 24 x7
manuteno)
Tempo limitado de guarda dos dados.
Tempo de guarda dos dados conforme
(ver seo "Tempo de guarda dos dados"
legislao
deste documento)

73
Este ambiente no d validade jurdica s
informaes recebidas. Dessa forma, os As informaes recebidas possuem validade
dados transmitidos pelas empresas podem jurdica.
ser reais ou fictcios.
Testes funcionais -

7.2. Estratgia de disponibilizao

O ambiente de Produo Restrita ser disponibilizado em duas etapas:

Primeira etapa: de 26/06/2017 a 31/07/2017 (restrita s empresas de Tecnologia


da Informao);

Segunda etapa: de 01/08/2017 em diante (acessvel a qualquer empresa).

Para a Produo Restrita, a data de 01/01/2017 deve ser adotada como incio de
obrigatoriedade do eSocial.

7.3. Eventos

Inicialmente, o ambiente de Produo Restrita ser disponibilizado contendo os


eventos abaixo que foram implementados de acordo com a verso 2.2.02 do leiaute e
schemas XML:

1. S-1000 - Informaes do Empregador/Contribuinte


2. S-1005 - Tabela de Estabelecimentos, Obras ou Unidades de rgos Pblicos
3. S-1010 - Tabela de Rubricas
4. S-1020 - Tabela de Lotaes Tributrias
5. S-1030 - Tabela de Cargos/Empregos Pblicos
6. S-1035 - Tabela de Carreiras Pblicas
7. S-1040 - Tabela de Funes/Cargos em Comisso
8. S-1050 - Tabela de Horrios/Turnos de Trabalho
9. S-1070 - Tabela de Processos Administrativos/Judiciais
10. S-1080 - Tabela de Operadores Porturios
11. S-1200 - Remunerao de trabalhador vinculado ao Regime Geral de Previd.
Social
12. S-1210 - Pagamentos de Rendimentos do Trabalho
13. S-1250 - Aquisio de Produo Rural

74
14. S-1260 - Comercializao da Produo Rural Pessoa Fsica
15. S-1270 - Contratao de Trabalhadores Avulsos No Porturios
16. S-1280 - Informaes Complementares aos Eventos Peridicos
17. S-1298 - Reabertura dos Eventos Peridicos
18. S-1299 - Fechamento dos Eventos Peridicos
19. S-1300 - Contribuio Sindical Patronal
20. S-2100 - Cadastramento Inicial do Vnculo
21. S-2190 - Admisso de Trabalhador - Registro Preliminar
22. S-2200 - Admisso de Trabalhador
23. S-2205 - Alterao de Dados Cadastrais do Trabalhador
24. S-2206 - Alterao de Contrato de Trabalho
25. S-2210 - Comunicao de Acidente de Trabalho
26. S-2230 - Afastamento Temporrio
27. S-2250 - Aviso Prvio
28. S-2298 - Reintegrao
29. S-2299 - Desligamento
30. S-2300 - Trabalhador Sem Vnculo de Emprego/Estatutrio - Incio
31. S-2306 - Trabalhador Sem Vnculo de Emprego/Estatutrio - Alterao
Contratual
32. S-2399 - Trabalhador Sem Vnculo de Emprego/Estatutrio - Trmino
33. S-3000 - Excluso de eventos
34. S-5001 - Informaes das contribuies sociais por trabalhador
35. S-5002 - Imposto de Renda Retido na Fonte
36. S-5011 - Informaes das contribuies sociais consolidadas por contribuinte
37. S-5012 - Informaes do IRRF consolidadas por contribuinte

As datas para disponibilizao de verses futuras do eSocial nos ambientes de


Produo Restrita e Produo sero divulgadas quando da publicao dos respectivos
leiautes.

7.4. Restries

A Produo Restrita limitar a utilizao de 1.000 (mil) vnculos por empregador.


Dessa forma, cada empresa poder realizar testes funcionais considerando uma folha de
pagamento com at 1.000 (mil) empregados ativos.

Caso a empresa utilize os 1.000 (mil) vnculos e queira incluir um novo empregado,
um empregado que esteja ativo deve ser desligado.

75
7.5. Tempo de guarda dos dados

Considerando que a Produo Restrita um ambiente para realizao de testes


funcionais para os empregadores testarem suas aplicaes e que os dados recebidos no
possuem validade jurdica, no existe a necessidade de armazenamento da mesma forma
que previsto para o ambiente de produo.

Nesse sentido, todos os eventos enviados ao ambiente de Produo Restrita sero


completamente excludos periodicamente ou quando houver a necessidade de manuteno
que gere impacto significativo para o sistema, com comunicao prvia.

7.6. Validaes

Segue abaixo o comportamento do eSocial, no ambiente de Produo Restrita, em


relao s validaes com outros Sistemas:

CNPJ - Cadastro Nacional de Pessoa Jurdica

Descrio simplificada: O CNPJ compreende as informaes cadastrais das


entidades de interesse das administraes tributrias da Unio, dos Estados, do Distrito
Federal e dos Municpios.

Orientao de uso: Os CNPJ informados nos eventos do eSocial Produo Restrita,


sero validados contra o ambiente de produo do Sistema CNPJ. Dessa forma, os eventos
devem ser preenchidos com CNPJ vlidos e em situao regular junto a RFB - Receita
Federal do Brasil.

CPF - Cadastro Pessoa Fsica

Descrio simplificada: O CPF compreende as informaes cadastrais das pessoas


fsicas.

76
Orientao de uso: Os CPF informados nos eventos do eSocial sero validados
contra o ambiente de produo do Sistema CPF. Dessa forma, os eventos devem ser
preenchidos com CPF vlidos e em situao regular junto a RFB - Receita Federal do
Brasil.

Tabela de Municpios

Descrio simplificada: Contm os cdigos de municpios conforme tabela de


municpios do IBGE.

Orientao de uso: As informaes relacionadas a municpios informados nos


eventos do eSocial sero validadas contra o ambiente de produo do Sistema que detm os
dados de municpios. Dessa forma, os eventos devem ser preenchidos com cdigos de
municpios vlidos.

CNO - Cadastro Nacional de Obras

Descrio simplificada: Refere-se ao registro, perante a RFB, das informaes


especficas de obras de construo civil, seja para pessoas fsicas ou para pessoas jurdicas.

Orientao de uso: Inicialmente o ambiente de Produo Restrita validar somente o


dgito verificador (DV) do CNO. Dessa forma, os eventos podem ser preenchidos com
qualquer CNO, desde que o DV seja vlido. Todas as outras regras relacionadas ao CNO
no sero aplicadas.

CNIS - Cadastro Nacional de Informaes Sociais

Descrio simplificada: Base de dados nacional que contm informaes cadastrais


dos trabalhadores.

77
Orientao de uso: Inicialmente o ambiente de Produo Restrita validar somente o
dgito verificador (DV) do NIS. Dessa forma, os eventos podem ser preenchidos com
qualquer NIS, desde que o DV seja vlido.

FAP - Fator Acidentrio de Preveno

Descrio simplificada: um ndice aplicado sobre a Contribuio do Grau de


Incidncia de Incapacidade Laborativa decorrente dos Riscos Ambientais do Trabalho -
GIL-RAT (devida pelos empregadores), que tanto pode resultar em aumento como
diminuio da respectiva contribuio. O FAP consiste num multiplicador varivel num
intervalo contnuo de cinquenta centsimos (0,50) a dois inteiros (2,00), desprezando-se as
demais casas decimais, a ser aplicado respectiva alquota.

Orientao de uso: Inicialmente o ambiente de Produo Restrita aceitar o FAP


informado pela empresa dentro do intervalo contnuo de cinquenta centsimos (0,50) a dois
inteiros (2,00).

Procurao Eletrnica

Descrio simplificada: um documento eletrnico de procurao assinado


digitalmente por um Certificado Digital vlido.

Orientao de uso: Inicialmente o ambiente de Produo Restrita no aceitar o uso


de procurao eletrnica.

7.7. Regra para identificao do ambiente

Todos os eventos gerados para o ambiente de Produo Restrita devero ter a


informao de identificao do ambiente, conforme abaixo:

A tag tpAmb deve ser preenchida com o valor 2 Produo Restrita.

78
7.8. URL dos Web Services

Seguem as URL para acesso aos Web Services do eSocial:

URL do Web Service de envio de lotes:


https://webservices.producaorestrita.esocial.gov.br/servicos/empregador/enviarloteeventos/WsEnviarLoteEventos.svc

URL do Web Service de consulta de resultado de processamento de lotes:


https://webservices.producaorestrita.esocial.gov.br/servicos/empregador/consultarloteeventos/WsConsultarLoteEventos.svc

Para conhecimento, a URL base para os Web Services de produo ser:

webservices.esocial.gov.br

7.9. Atendimento

Ser criado no Portal do eSocial (https://portal.esocial.gov.br) um canal exclusivo


para atendimento das demandas provenientes da utilizao do ambiente de Produo
Restrita, por meio de formulrio prprio. As respostas sero de acesso pblico.

No sero atendidas por esse canal dvidas que tratem exclusivamente de direito
material.

7.10. Certificao digital

O usurio que ir consumir os Webservices do eSocial devero instalar em seus


servidores a cadeia de certificado do eSocial que est disponvel em:
https://certificados.serpro.gov.br/serproacf/certificate-chain

Atualmente a cadeia utilizada a emitida em 06/02/2017.

Para que a conexo HTTPS (TLS) seja feita com sucesso estes certificados devem
estar instalados como certificados confiveis na mquina que ser cliente dos Webservices.

79
7.11. Remover empregador da base de dados

As empresas podero remover todos os eventos enviados ao ambiente de Produo


Restrita, inclusive o evento S-1000. Esta funcionalidade viabiliza flexibilidade para os
testes neste ambiente.

Para tanto, a empresa dever transmitir um evento S-1000 preenchido conforme


abaixo:

Tag nmRazao = RemoverEmpregadorDaBaseDeDadosDaProducaoRestrita


Tag classTrib = 00
tag tpAmb = 2 Produo Restrita.

Ser retornada a mensagem "1012 - Empregador {0} removido com sucesso da base
de dados da Producao Restrita do eSocial", onde {0} o identificador do empregador.

Vale ressaltar que esta uma funcionalidade exclusiva do ambiente de produo


restrita. Esta funcionalidade no ser disponibilizada no ambiente de produo.

80