ManualOrientacaoDesenvolvedoreSocial Versao 1.0

Sistema eSocial

Manual de orientao do desenvolvedor

Verso 1.0 Dezembro de 2014

2

Histrico de verses

Data Verso Descrio 19/12/2014 1.0 Verso inicial

3

ndice

1. INTRODUO ......................................................................................................... 5 2. CONSIDERAES INICIAIS.............................................................................. 5

2.1. OBJETIVOS DO PROJETO ........................................................................................... 5 2.2. CONCEITO DE EVENTO ............................................................................................. 6

3. ARQUITETURA DE COMUNICAO ........................................................... 7 3.1. MODELO OPERACIONAL........................................................................................... 7 3.2. NVEIS DE VALIDAO ............................................................................................ 8 3.3. AMBIENTES DE RECEPO....................................................................................... 9 3.4. ETAPAS DO PROCESSO IDEAL ................................................................................. 10 3.5. PROCEDIMENTOS DE CONTINGNCIA ..................................................................... 12

3.5.1. Indisponibilidade dos servidores ......................................................... 12 4. PADRES TCNICOS ......................................................................................... 13

4.1. PADRO DE DOCUMENTO XML............................................................................. 13 4.1.1.1. Declarao namespace.......................................................................... 14

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 ............................. 22 5.3. VALIDAO DO CERTIFICADO DIGITAL ................................................................. 23 5.4. WEBSERVICE DE ENVIO DE LOTE DE EVENTOS ...................................................... 24

5.4.1. Dados para a chamada ao Webservice.............................................. 25 5.4.2. Fluxo de Envio de Lote de Eventos ..................................................... 26 5.4.3. Leiaute Mensagem de Entrada............................................................. 27 5.4.4. Leiaute Mensagem de Retorno do Envio do Lote............................ 31 5.4.5. Validaes aplicadas .............................................................................. 38

5.5. WEBSERVICE DE CONSULTA AO RESULTADO DO PROCESSAMENTO DE UM LOTE DE EVENTOS ........................................................................................................................... 39

5.5.1. Dados para a chamada ao Webservice.............................................. 39 5.5.2. Fluxo de consulta ao resultado do processamento do lote de eventos 40 5.5.3. Leiaute da Mensagem de Entrada ....................................................... 41 5.5.4. Leiaute Mensagem de Retorno do Processamento do Lote .......... 43 5.5.5. Validaes aplicadas .............................................................................. 52

5.6. RECOMENDAES E BOAS PRTICAS ..................................................................... 53 5.6.1. Evitar o envio de eventos de outros grupos durante o envio dos eventos peridicos ..................................................................................................................... 53

4

5.6.2. Tempo de espera para busca do resultado do processamento..... 53 5.6.3. Otimizao na montagem do arquivo................................................. 54 5.6.4. Validao de Schema.................................................................................... 54

6. EVENTOS ................................................................................................................. 55 6.1. ESTRUTURA DO EVENTO ........................................................................................ 55 6.2. IDENTIFICAO DO EVENTO................................................................................... 59 6.3. ASSINATURA DO EVENTO....................................................................................... 60 6.4. VERSIONAMENTO DOS LEIAUTES DOS EVENTOS ..................................................... 60 6.5. ESTRUTURA DO RETORNO DE PROCESSAMENTO DO EVENTO .................................. 62 6.6. CDIGOS DE REPOSTA DE PROCESSAMENTO DO EVENTO........................................ 68

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 iniciais e 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. Ambientes de Recepo

Os lotes de eventos enviados pelo empregador sero recebidos em um dos dois ambientes do eSocial:

Ambiente Caixa: neste ambiente os lotes sero validados (validao nvel 1) e os lotes vlidos sero armazenados no repositrio da Caixa, e enviados para a fila de processamento assncrono localizada no ambiente do Serpro.

Ambiente Serpro: neste ambiente os lotes sero validados (validao nvel 1) e os lotes vlidos sero inseridos na fila de processamento assncrono. Alm disso, neste ambiente que sero realizadas todas as validaes de nvel 2, e onde estar disponvel a consulta ao resultado do processamento do lote.

10

3.4. 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;

11

2) O balanceador de carga do eSocial define se o lote ser enviado para o ambiente do Serpro ou da Caixa;

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

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

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

6) O sistema eSocial retira e processa a solicitao de processamento da fila de solicitaes;

7) 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;

8) 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;

9) 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;

10) 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.

12

3.5. Procedimentos de contingncia

3.5.1. Indisponibilidade dos servidores

O procedimento de contingncia para a indisponibilidade dos servidores Webservice do sistema eSocial o Portal Web que permite a manuteno e a consulta dos dados mantidos pelo sistema.

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, os servidores Webservice do sistema eSocial estiverem indisponveis.

13

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:

Cada arquivo XML somente poder ter uma nica declarao . 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 devem ser evitados para no gerar erros quanto a codificao do documento enviado ao sistema eSocial. Para isto ser necessrio substituir os caracteres pelas seqncias de caracteres escape adequadas, conforme a tabela abaixo demonstra:

Caractere Escape

> (sinal de maior) >

< (sinal de menor) <

& (e comercial) &

14

(aspas duplas) "

(sinal de apstrofe ou aspas simples) '

4.1.1.1. Declarao namespace

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

O uso de declarao namespace diferente do padro estabelecido vetado.

A declarao do namespace da assinatura digital dever ser realizada na prpria tag , conforme exemplo abaixo:

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

15

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 (SSL verso 3.0), 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.2, com troca de mensagens XML no padro Style/Enconding: Document/Literal.

Exemplo de uma mensagem SOAP:

16

CORPO DA MENSAGEM SOAP

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.

17

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 (1024 e 2048 bits)

5. Funo criptogrfica assimtrica: RSA (http://www.w3.org/2000/09/xmldsig#rsa-sha1)

6. Funo de message digest: SHA-1 (http://www.w3.org/2000/09/xmldsig#sha1)

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

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

18

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 a 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:

7ZFzmAV6TKTa4fzbAJlFDAL6BZI=

k/.......+FKpYamLYxA==

MIIHdzCCBVk......3DP8d2TOROQw==

19

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).

20

4.7. Resumo dos padres tcnicos

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

Caracterstica Descrio

Webservices Padro definido pelo WS-I Basic Profile 1.1 (http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html)

Meio lgico de comunicao

Webservice (s) disponibilizado (s) pelo sistema eSocial

Meio fsico de comunicao

INTERNET

Protocolo Internet

HTTPS (SSL verso 3.0), com autenticao mtua atravs de certificados digitais

Padro de troca de mensagens

SOAP verso 1.2

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 tipo A1 ou A3, devendo ser um e-CPF (e-PF) ou e-CNPJ (e-PJ). Padro de certificado

digital

Para transmisso, utilizar o certificado digital do responsvel pela transmisso.

21

Padro de assinatura digital

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

Validao de assinatura digital

Ser validada alm da integridade e autoria, a cadeia de confiana com a validao das LCR.

Campos no obrigatrios do Schema que no possuam contedo tero suas tags suprimidas no arquivo XML

Nos campos numricos inteiros, no incluir vrgula ou ponto

decimal.

Padres de preenchimento XML

Nos campos numricos com casas decimais, utilizar o ponto decimal na separao da parte inteira.

22

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 http://www.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 - 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.

23

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, como segue:

Namespace:

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

Nome arquivo:

loteEventos-v1_0_0.xsd (Schema XML para o lote de eventos, verso 1.0.0)

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.

5.3. Validao do Certificado Digital

Os certificados digitais podem ser utilizados tanto nas conexes SSL 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 do 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).

24

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 ser confivel.

MS0148 Rejeio do lote ou do evento

A raiz da cadeia dever pertencer a Autoridade Certificadora Raiz Brasileira (ICP-Brasil).


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

O certificado no poder estar expirado na data da verificao.


O certificado dever ser do tipo e-CNPJ, ou e-PJ, se o certificado for de Pessoa Jurdica.


O certificado dever ser do tipo e-CPF, ou e-PF, se o certificado for de Pessoa Fsica.


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

Falha ao acessar a lista de certificados revogados. MS0011 Rejeio do lote 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.

25

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)

Requer Certificado de Cliente?

Sim.

Observao: No necessrio qualquer tipo de vnculo formal (ex: procurao) entre o transmissor e o empregador.

Schema Parmetro loteEventos EnvioLoteEventos-v1_0_0.xsd

Schema Retorno RetornoEnvioLoteEventos-v1_0_0.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-v1_0_0.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/

schema/empregador/lote/

eventos/envio/v1_0_0

Namespace do XSD do

do envio de lote de

eventos .

28

grupo obrigatrio 1 1 - Eventos Iniciais e de

Tabelas

2 - Eventos No Peridicos

3 - Eventos Peridicos

Define o grupo dos

eventos contidos no

lote. Durante o

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


tpInscricao obrigatrio 1 1 CNPJ;

2 CPF

Contm o tipo de inscrio do

empregador.

nrInscricao 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



2 CPF

Contm o tipo de inscrio do transmissor.

nrInscricao 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 SSL. 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


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.

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-v1_0_0.xsd, cuja estrutura apresentada abaixo:

tag: eSocial


32

obrigatrio? Sim

ocorrncia nica




eventos/envio/

retornoEnvio/v1_0_0

Namespace do XSD do

retorno do envio de lote

de eventos .

tag: retornoEnvioLoteEventos

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

obrigatrio? Sim

ocorrncia nica

tag: ideEmpregador


obrigatrio? No

ocorrncia nica



2 CPF


empregador.

33


do empregador.

Observaes:

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

tag: ideTransmissor


obrigatrio? No

ocorrncia nica



2 CPF

Contm o tipo de inscrio do transmissor.


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


cdResposta obrigatrio 1 201 - Lote recebido com sucesso.

202 - Lote recebido com advertncias.

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.

Contm o cdigo de

resposta do processo

de recepo. Caso o cdigo seja de erro ou advertncia, os

detalhes do mesmo

estaro na tag

ocorrencias.

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..*


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


alguma das regras previstas na 5.4.5 - Validaes aplicadas.

tipo obrigatrio 1 1 - Erro

2 - Advertncia

Contm o cdigo do tipo de

ocorrncia.

36

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


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

Recepcao

obrigatrio 1 - Contm a verso do aplicativo de recepo.

hash obrigatrio 1 - Contm o hash do lote

enviado.

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

37

do Lote.

Abaixo descrita a regra de

formao deste Protocolo:

A.B.NNNNNNNN....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;

N = Nmero sequencial (19 posies)

Observaes:

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

38

5.4.5. Validaes aplicadas


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

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

A solicitao ultrapassou o tamanho limite.

Observao: O tamanho limite da mensagem SOAP 750 kbytes.

MS0612 Rejeio do lote

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

CNPJ do empregador/transmissor invlido MS0380 Rejeio do lote

CPF do empregador/transmissor invlido MS0381 Rejeio do lote

O nmero de inscrio do empregador dever ter o 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 lote


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

O id do evento no atendeu a regra de formao 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)

Requer Certificado de Cliente?

Sim. Observao: Somente quem transmitiu a solicitao de processamento tem acesso ao resultado do processamento. 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-v1_0_0.xsd

Schema Retorno RetornoProcessamentoLote-v1_0_0.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-v1_0_0.xsd, cuja estrutura apresentada abaixo:

tag: eSocial


obrigatrio? Sim

ocorrncia nica




eventos/envio/consulta/

retornoProcessamento/v1_0_0

Namespace do XSD de consulta ao

resultado do

processamento de

lote de eventos .

tag: consultaLoteEventos

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

obrigatrio? Sim

ocorrncia nica

42



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-v1_0_0.xsd, cuja estrutura apresentada abaixo:

44

tag: eSocial


obrigatrio? Sim

ocorrncia nica


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

hema/empregador/lote/evento

s/envio/retornoProcessamento/v1_0_0

Namespace do XSD

de retorno do

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


obrigatrio? No

45

ocorrncia nica



2 CPF

Contm o tipo de inscrio do empregador.


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


obrigatrio? No

ocorrncia nica



2 CPF


transmissor.


do transmissor.

Observaes:

46

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

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


cdResposta obrigatrio 1 101 - Lote Aguardando

Processamento.

201 - Lote Processado com Sucesso.

202 - Lote Processado com Advertncias.

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 -

Contm o cdigo de

resposta do

processamento do lote.

Caso o cdigo seja de erro ou advertncia, os

detalhes do mesmo

estaro na tag

ocorrencias.

47

Erro Certificado.

405 - Lote Incorreto - Lote nulo ou vazio.

501 - Solicitao de Consulta Incorreta -

Erro Preenchimento.


Schema Invlido.


Verso do Schema No Permitida.


Erro Certificado.


Consulta nula ou vazia.

descResposta obrigatrio 1 - Contm a descrio

correspondente ao cdigo

de resposta.

tempoEstimadoConclusao

opcional 1 - Contm o tempo 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

48

conforme seo 5.6.2 - Tempo de espera para

busca do resultado do

processamento.

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..*


codigo obrigatrio 1 - Contm o cdigo da ocorrncia detectada em


seo 5.5.5 Validaes aplicadas.

49




seo 5.5.5 Validaes aplicadas.


2 - Advertncia

Contm o cdigo do tipo de

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


dhRecepcao obrigatrio 1 - Contm a data/hora de


versaoAplicativo

Recepcao

obrigatrio 1 - Contm a verso do

aplicativo de recepo.

hash obrigatrio 1 - Contm o hash do lote

enviado.


produzido no instante de


50

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

ocorrncia nica


versaoAplicativo

Processamento

Lote

obrigatrio 1 - Contm a verso do

aplicativo de processamento

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:

51

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

tag: evento

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

obrigatrio? No

ocorrncia 1 .. 50


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.

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

52

5.5.5. Validaes aplicadas


O retorno do processamento do lote somente acessvel a quem enviou o lote MS0604

Rejeio da consulta

O lote no foi localizado ou j no est mais disponvel no sistema. MS0605

Rejeio da consulta

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

O lote no foi localizado ou ainda no foi entregue ao Ambiente Nacional pelo agente de recepo. MS0662

Rejeio da consulta

53

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. 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.2. Tempo de espera para busca do resultado do processamento

No retorno do processamento do lote de eventos h uma tag () 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.

54

5.6.3. 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.

5.6.4. 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 http://www.esocial.gov.br/ antes de seu envio.

55

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 realizadas 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/v1_0_0

http://www.esocial.gov.br/schema/evt Estabelece que o XSD de um evento do eSocial. evtInfoEmpregador Identificao do tipo do evento. v1_0_0 Identificao da verso do XSD e do Leiaute.

Conforme "Versionamento dos leiautes dos eventos"

A imagem abaixo ilustra a estrutura bsica de um evento:

56

tag: eSocial

descrio: Tag raiz do documento do eSocial

obrigatrio? Sim

ocorrncia nica


xmlns obrigatrio 1 Namespace Namespace do Xsd que

representa o leiaute do tipo do evento.

57

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


Id obrigatrio 1 - Identificao nica do evento. Conforme definido em

"Identificao do evento"

versao obrigatrio 1 - Verso do leiaute do evento.

tag: ideEvento

descrio: Contm informaes gerais do evento.

obrigatrio? Sim

ocorrncia nica


tpAmb obrigatrio 1 1=Produo;

2=Pr-produo - dados reais;

3=Pr-produo -

dados fictcios;

6=Homologao;

Identificao do ambiente

para o qual o evento est

sendo transmitido

58

7=Validao;

8=Testes;

9=Desenvolvimento;

procEmi obrigatrio 1 1 - Aplicativo do

Empregador;

2 - Aplicativo Web

do ESocial

Origem do documento.

verProc obrigatrio 1 - Verso do aplicativo emissor

do evento

tag: ideEmpregador

descrio: Contm a identificao do empregador.

obrigatrio? Sim

ocorrncia nica


tpInsc obrigatrio 1 1 CNPJ;

2 CPF


empregador.

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.

59

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 Fixo

Tipo

inscrio

Nr Inscrio Data e hora de gerao Sequencial

ID 1 - Cnpj ou

2 - Cpf

CPF, CNPJ, ou CNPJ

Base.

Prencher com zeros a

direita at completar as 14 posies.

Formato:

YYYYMMDDhhmmss

YYYY- Ano;

MM - Ms;

DD - dia; hh - hora;

mm - minuto;

ss - segundo.

Nmero sequencial de livre preenchimento

do empregador.

60

2 (pos) 1 (pos) 14 (pos) 14 (pos) 5 (pos)

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 tipo 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

61

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 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.

62

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:

63

tag: eSocial

descrio: Tag raiz do documento do eSocial.

obrigatrio? Sim

ocorrncia nica



schema/recepcao/retornoEvento

/v1_0_0

Namespace do

Xsd do retorno

de processamento

do evento.

tag: retornoEvento

descrio: Tag principal do retorno de processamento de evento.

obrigatrio? Sim

ocorrncia nica


Id obrigatrio 1 Identificao nica do evento.

Conforme definido em "Identificao do evento"

tag: ideEmpregador

descrio: Contm a identificao do empregador.

64

obrigatrio? Sim

ocorrncia nica



2 CPF


empregador.


do empregador.

tag: recepcao

descrio: Contm os dados de recepo do evento.

obrigatrio? Sim

ocorrncia nica


tpAmb obrigatrio 1 1=Produo;

2=Pr-produo -

dados reais;

3=Pr-produo -

dados fictcios;

6=Homologao; 7=Validao;

8=Testes;

9=Desenvolvimento;

Identificao do ambiente de recepo do evento.

dhRecepcao obrigatrio 1 - Data e horrio da recepo do

evento.

65

versaoApp

Recepcao

obrigatrio 1 - Verso do aplicativo de

recepo do evento.

protocoloEnvio

Lote

facultativo 1 - Nmero sequencial nico

produzido no instante de


tag: processamento

descrio: Contm os dados de processamento do evento.

obrigatrio? Sim

ocorrncia nica


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

Processamento

obrigatrio 1 Verso do Aplicativo de

processamento do evento.

dhProcessamento obrigatrio 1 - Data e horrio do

processamento do evento.

tag: ocorrencias

66

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 vlidos

descrio


2 - Advertncia

Contm o tipo de ocorrncia.

codigo

obrigatrio 1 - Contm o cdigo da

ocorrncia.


ocorrncia.

localizacao facultativo 1 - Contm a localizao da

ocorrncia no

documento do evento.

67

tag: recibo

descrio: Contm os dados do recibo de entrega do evento

obrigatrio? Facultativo

ocorrncia nica


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.

68

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

eSocial

301 Erro Servidor

401 Erro no contedo do evento. 402 Schema invlido. 403 Leiaute invlido. 404

Erro do certificado digital da assinatura do evento.

405 Erro na assinatura evento

Erro

cliente

406 Evento no pertence ao grupo

especificado no lote de eventos

ManualOrientacaoDesenvolvedoreSocial Versao 1.0

Documents

Transcript of ManualOrientacaoDesenvolvedoreSocial Versao 1.0