ManualOrientacaoDesenvolvedor REINF v1.1
ManualOrientacaoDesenvolvedor REINF v1.1
ManualOrientacaoDesenvolvedor REINF v1.1
Verso 1.1
Julho de 2017
ndice
1. INTRODUO..............................................................................................................4
2. CONSIDERAES INICIAIS.......................................................................................4
2.1. OBJETIVOS DO PROJETO..........................................................................................4
2.2. VISO GERAL..........................................................................................................4
2.3. LEGISLAO............................................................................................................5
2.4. PESSOAS OBRIGADAS A DECLARAR........................................................................5
2.5. PRAZOS DE ENTREGA..............................................................................................6
2.6. PROCEDIMENTOS DE CONTINGNCIA INDISPONIBILIDADE DOS SERVIDORES........7
3. DEFINIES GERAIS SOBRE EVENTOS.................................................................7
3.1. ASSINATURA............................................................................................................7
3.2. LOTES DE EVENTOS.................................................................................................8
3.3. VALIDAO DO CERTIFICADO DIGITAL...................................................................8
3.4. NVEIS DE VALIDAO DOS EVENTOS....................................................................9
3.5. RECIBO E PROTOCOLO DE RECEBIMENTO DOS EVENTOS......................................10
3.6. VERSIONAMENTO DOS LEIAUTES DOS EVENTOS....................................................10
4. PADRES TCNICOS................................................................................................11
4.1. PADRO DE DOCUMENTO XML............................................................................11
4.2. DECLARAO NAMESPACE....................................................................................12
4.3. SCHEMA XML.......................................................................................................13
4.4. PADRO DE COMUNICAO..................................................................................14
4.5. PADRO DE CERTIFICADO DIGITAL........................................................................15
4.6. PADRO DE ASSINATURA DIGITAL.........................................................................17
4.7. PROCESSO DE VALIDAO DE ASSINATURA DIGITAL.............................................19
4.8. RESUMO DOS PADRES TCNICOS.........................................................................21
5. WEBSERVICES...........................................................................................................22
5.1. PADRO DE MENSAGENS DOS WEBSERVICES.......................................................22
5.2. VALIDAO DA ESTRUTURA DA MENSAGEM NO WEBSERVICE............................23
5.3. WEBSERVICE DE ENVIO DE LOTE DE EVENTOS.....................................................24
a) Dados para a chamada ao Webservice de Envio de Lote de Eventos..................24
b) Fluxo de Envio de Lote de Eventos......................................................................25
c) Leiaute Mensagem de Entrada.............................................................................27
d) Leiaute Mensagem de Retorno do Envio do Lote.................................................29
e) Validaes aplicadas na Recepo do Lote..........................................................33
5.4. WEBSERVICE DE CONSULTA DO EVENTO DE TOTALIZADOR..................................35
a) Dados para a chamada ao Webservice de Consulta do Evento de Totalizador...35
b) Fluxo de Envio de Lote de Eventos......................................................................35
c) Leiaute da Mensagem de Entrada........................................................................35
d) Leiaute da Mensagem de Retorno........................................................................36
e) Retorno dos Totalizadores....................................................................................36
6. ARQUITETURA DE COMUNICAO.....................................................................36
6.1. MODELO OPERACIONAL.........................................................................................36
6.2. ETAPAS DO PROCESSO IDEAL.................................................................................37
7. EVENTOS....................................................................................................................38
7.1. ESTRUTURA DO EVENTO........................................................................................39
2
7.2. IDENTIFICAO DO EVENTO..................................................................................43
7.3. ASSINATURA DO EVENTO.......................................................................................44
7.4. ESTRUTURA DO RETORNO DE PROCESSAMENTO DO EVENTO................................44
8. RECOMENDAES E BOAS PRTICAS................................................................44
8.1. RESPEITAR A ORDEM DE PRECEDNCIA NO ENVIO DOS EVENTOS EM LOTES.........44
8.2. EVITAR O ENVIO DE EVENTOS DURANTE O PROCESSAMENTO DO EVENTO DE
FECHAMENTO.....................................................................................................................45
8.3. OTIMIZAO NA MONTAGEM DO ARQUIVO...........................................................45
8.4. VALIDAO DE SCHEMA.......................................................................................46
9. ORIENTAES PARA UTILIZAO DO AMBIENTE DE PRODUO
RESTRITA............................................................................................................................46
9.1. SOBRE A PRODUO RESTRITA.............................................................................46
9.2. EVENTOS................................................................................................................47
9.3. RESTRIES...........................................................................................................48
9.4. TEMPO DE GUARDA DOS DADOS............................................................................48
9.5. VALIDAES..........................................................................................................49
9.6. REGRA PARA IDENTIFICAO DO AMBIENTE.........................................................50
9.7. URL DOS WEB SERVICES......................................................................................50
9.8. Da data de disponibilizao do ambiente..............................................................50
3
1. Introduo
2. Consideraes Iniciais
4
Nos casos de procurao eletrnica, o declarante dever habilitar poderes
especficos para esta obrigao acessria, no portal do e-CAC, conforme orientaes
descritas no item Error: Reference source not found - Error: Reference source not found
deste manual.
2.3. Legislao
Pessoas jurdicas que prestam e que contratam servios realizados mediante cesso
de mo de obra;
5
Empresa ou entidade patrocinadora que tenha destinado recursos a associao
desportiva que mantenha equipe de futebol profissional a ttulo de patrocnio,
licenciamento de uso de marcas e smbolos, publicidade, propaganda e transmisso
de espetculos desportivos;
6
As entidades promotoras de espetculos desportivos a que se refere o inciso VII do
art. 2 devero transmitir ao Sped as informaes relacionadas ao evento no prazo de at 02
(dois) dias teis aps a sua realizao.
3.1. Assinatura
7
3.2. Lotes de Eventos
Os certificados digitais podem ser utilizados tanto nas conexes TLS de transmisso
dos lotes de eventos para a EFD-REINF, quanto para a assinatura dos eventos. Neste caso,
8
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 EFD-REINF, que representa o
evento).
9
3.5. Recibo e Protocolo de Recebimento dos Eventos
Para cada evento contido em um determinado lote e que for processado com sucesso
a EFD-REINF retornar o respectivo nmero de recibo ou um Protocolo de Recebimento,
conforme detalhado na seo Error: Reference source not found - Error: Reference source
not found.
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.
Para cada tipo de evento haver apenas uma verso de leiaute vigente em um
determinado perodo.
10
O Sistema EFD-REINF identificar a verso do leiaute do evento atravs do
namespace do Xml do evento.
Onde:
4. Padres Tcnicos
11
<?xml version="1.0" encoding="UTF-8"?>
Caractere Escape
Cada evento XML dever ter uma nica declarao de namespace no elemento raiz
do documento, conforme tipo do evento, com o seguinte padro:
12
leiaute (v1_01_01) deve ser atualizada sempre que necessrio, quando houver atualizaes
do Schema .xsd.
<Reinf xmlns="http://www.reinf.esocial.gov.br/schemas/NOME_DO_EVENTO/v1_01_01">
<Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
<.../>
</Signature>
</Reinf>
1
Essa considerao tambm valida para exemplos apresentados em sees mais
adiante nesse manual.
13
4.4. Padro de Comunicao
<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">
<soap:Header></soap:Header>
</soap:Envelope>
14
4.5. Padro de certificado digital
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.
15
2. Assinatura de documentos: para garantir o no repdio e a integridade das
informaes os documentos eletrnicos enviados para a EFD-REINF so assinados
digitalmente seguindo a especificao descrita em 4.6 - Padro de assinatura digital
e as orientaes estabelecidas neste Manual.
16
O certificado dever ser do MS0007 Rejeio do lote ou do evento.
tipo e-CNPJ, e-PJ, e-CPF ou
e-PF.
17
2. Certificado digital: emitido por AC credenciada no ICP-Brasil
(http://www.w3.org/2000/09/xmldsig#X509Data)
18
<Reinf xmlns="http://www.reinf.esocial.gov.br/schemas/NOME_DO_EVENTO/v01_01_01">
<!-- 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>fLTJL1BLGP9giKdsEGP9xSVyeWBlPzkvyy78GtbsC9I=</DigestValue>
</Reference>
</SignedInfo>
<SignatureValue>...</SignatureValue>
<KeyInfo>
<X509Data>
<X509Certificate>...</X509Certificate>
</X509Data>
</KeyInfo>
</Signature>
</Reinf>
19
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);
6) adotar as regras definidas pelo RFC 3280 para as LCR e cadeia de confiana;
20
4.8. Resumo dos padres tcnicos
Caracterstica Descrio
Meio lgico de
Webservice (s) disponibilizado (s) pelo sistema EFD-REINF.
comunicao
Meio fsico de
INTERNET
comunicao
Padro de troca de
SOAP verso 1.1
mensagens
21
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, com padres de criptografia assimtrica RSA,
digital
algoritmo message digest SHA-256 e utilizao das transformaes
Enveloped e C14N.
5. Webservices
22
Comunicao: contm os Schemas envolvidos no processo de comunicao com a
EFD-REINF (Schema do Envio Lote de Eventos, Schema do Retorno do
Evento, Schema do Retorno de Processamento de Lotes). Os Schemas deste
pacote esto descritos nas sees 5.3 - Webservice de Envio de Lote de Eventos
e Error: Reference source not found - Error: Reference source not found.
Namespace:
http://www.reinf.esocial.gov.br/schemas/envioLoteEventos/v1_01_01
Nome arquivo:
23
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 e podero ocorrer sempre que se fizerem necessrias.
Cada evento enviado, atravs do lote de eventos, deve ser assinado individualmente
dentro do lote.
Sim.
24
Schema Parmetro loteEventos envioLoteEventos-v1_01_01.xsd
https://reinf.receita.fazenda.gov.br/WsREINF/Recepcao
URL
LoteReinf.svc
25
c) Leiaute Mensagem de Entrada
tag: REINF
obrigatrio? Sim
ocorrncia nica
tag: loteEventos
obrigatrio? Sim
ocorrncia nica
26
tag: evento
descrio:
Contm cada evento individual que ser processado pela EFD-REINF.
obrigatrio? Sim
ocorrncia 1..100
Informaes complementares
podem ser obtidas atravs do
XSD correspondente.
campo obrigatoriedade ocorrncia valores vlidos descrio
O contedo do campo evento deve ser o XML do evento a ser enviado para processamento na
EFD-Reinf. Este campo pode ser repetido at 100 vezes, isto quer dizer que o lote de eventos
pode ser composto no mximo por 100 eventos. Existem diferentes estruturas XML e leiautes
para a representao dos eventos recebidos pela EFD-Reinf.
27
tag: REINF
obrigatrio? Sim
ocorrncia nica
28
tag: retornoLoteEventos
obrigatrio? Sim
ocorrncia nica
id obrigatrio 1 -
Contm o identificador do
retorno do lote.
Informao utilizada
apenas pelo mecanismo
de assinatura XML.
tag: ideTransmissor
obrigatrio? Sim
ocorrncia nica
idTransmissor obrigatrio 1 -
Contm a identificao do
transmissor.
tag: status
obrigatrio? Sim
ocorrncia nica
29
campo obrigatoriedade ocorrncia valores vlidos descrio
tag: ocorrencias
obrigatrio? No
ocorrncia 1..N
1 - Aviso
tipo obrigatrio 1 Contm o tipo da
ocorrncia.
2 - Erro
-
localizacaoErro No obrigatrio 1 Campo onde ocorreu o
Aviso aviso/erro.
30
tag:
retornoEventos
descrio: Contm o(s) resultado(s) do processamento dos eventos do lote.
obrigatrio? No
ocorrncia nica
tag: signature
obrigatrio? Sim
ocorrncia nica
31
O certificado digital do signatrio ou do solicitante da
0005 Rejeio do lote
informao encontra-se revogado.
32
5.4. Webservice de Consulta do evento de Totalizador
Sim.
https://reinf.receita.fazenda.gov.br/WsREINF/
URL
ConsultasReinf.svc
33
d) Leiaute da Mensagem de Retorno
6. Arquitetura de comunicao
34
6.2. Etapas do processo ideal
35
1) O aplicativo da instituio declarante inicia a conexo enviando uma mensagem de
solicitao de processamento de lote de eventos para o Web Service de Recepo de
Lote de Eventos;
7. Eventos
36
7.1. Estrutura do evento
Cada evento tem sua prpria estrutura, obedecendo ao leiaute estabelecido nesse
manual. A verificao da estrutura dos eventos, conforme os seus respectivos leiautes, ser
realizadas atravs de XSD (Xml Schema Definition).
Ex: http://www.reinf.esocial.gov.br/schemas/evtInfoContribuinte/v1_01_01
37
tag: REINF
obrigatrio? Sim
ocorrncia nica
tag: evtInfoContri
descrio: Tag que identifica o tipo do evento (O nome dessa tag est presente tambm
no namespace do Xsd da estrutura do evento).
obrigatrio? Sim
ocorrncia nica
tag: ideEvento
obrigatrio? Sim
ocorrncia nica
38
campo obrigatoriedade ocorrncia valores vlidos descrio
3=Pr-produo -
dados fictcios.
2 - Aplicativo
governamental.
tag: ideContri
obrigatrio? Sim
ocorrncia nica
tag: infoContri
obrigatrio? Sim
39
ocorrncia nica
tag: Signature
obrigatrio? Obrigatrio
ocorrncia nica
Observaes:
Cada evento da EFD-REINF possui uma identificao nica, gerada pelo prprio
declarante, conforme o padro abaixo:
40
Exemplo: ID2333901700001892014020213424700001. (36 posies)
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.6 - Padro de
assinatura digital e os critrios estabelecidos nesse manual.
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".
41
Recomenda-se fortemente que o transmissor faa primeiramente a transmisso dos
seus eventos iniciais e de tabelas. Em seguida, envie os eventos peridicos. Caso as regras
de precedncia no forem seguidas, a EFD-REINF rejeitar o evento.
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 pela EFD-REINF. 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:
42
no incluir anotao e documentao no arquivo XML (tag annotation e tag
documentation);
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.
43
Seguem abaixo as caractersticas dos ambientes:
9.2. Eventos
44
9.3. Restries
45
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.
9.5. Validaes
Procurao Eletrnica
46
9.6. Regra para identificao do ambiente
A tag tmAmb deve ser preenchida com o valor 2 Produo Restrita Dados Reais
ou 3 Produo Restrita Dados Fictcios.
O ambiente de Produo Restrita estar disponvel para uso pelas empresas a partir
do dia 17/07/2017.
47