Manual de Eventos NFe Draft

Nota Fiscal eletrnica
Registro de Eventos da Nota Fiscal Eletrnica
Projeto Nota Fiscal Eletrnica
Verso 0.03 Agosto 2009

Controle de Verses
Verso 0.00 0.01 0.02 0.03 Data 09/12/2008 SP 22/04/2009 Reunio GO 21/05/2009 Reunio RS 03/08/2009 Reunio MG
Pg. 2 / 34

Identificao e vigncia do Manual

Verso do manual Data de divulgao do manual Pacote de liberao de Schemas XML Data de incio de vigncia no ambiente de homologao Data de incio de vigncia no ambiente de produo
0.03
Verses de leiautes do PL_SRE_000

Leiaute envEvento leiauteEvento retEvento xmldsig-core-schema
verso
1.00 1.00 1.00 1.01
Schema XML envEvento_v1.00.xsd leiauteEvento_v1.00.xsd retEvento_v1.00.xsd xmldsig-core-schema_v1.01.xsd
Observao Mensagem de envio de Evento Repositrio de tipos utilizados no pacote Mensagem de retorno de processamento do Evento Schema da assinatura digital
A verso final do PL ser divulgada at a data de entrada em produo.
Pg. 3 / 34

ndice
Introduo ............................................................................................................................. 5 Modelo Operacional do Registro de Eventos da NF-e........................................................... 6 2.1 Eventos de interesse da Nota Fiscal Eletrnica - NF-e ........................................................ 6 2.2 Fluxo dos eventos ................................................................................................................ 8 2.3 Sincronizao e compartilhamento de eventos .................................................................... 8 2.4 Modelo genrico de Eventos ................................................................................................ 9 2.5 Exibio dos eventos vinculados.......................................................................................... 9 2.6 Nova Consulta Status da NF-e para suportar o modelo de eventos vinculados ................. 12 2.6.1 Diagrama simplificado da Mensagem de Consulta ........................................................ 12 2.6.2 Diagrama simplificado da Mensagem de Retorno da Consulta ..................................... 13 3. Arquitetura do Sistema de Registro de Eventos da NF-e .................................................... 14 3.1 Modelo Conceitual do SRE da NF-e .................................................................................. 14 3.2 Padres Tcnicos .............................................................................................................. 14 3.2.1 Padro de documento XML ........................................................................................... 14 3.2.2 Padro de Comunicao ............................................................................................... 15 3.2.3 Padro de Certificado Digital ......................................................................................... 16 3.2.4 Resumo dos Padres Tcnicos ..................................................................................... 17 3.3 Padro de mensagens dos Web Services.......................................................................... 17 3.3.1 Informao de controle e rea de dados das mensagens ............................................. 17 3.3.2 Validao da estrutura XML das Mensagens dos Web Services ................................... 17 3.3.3 Schemas XML das Mensagens dos Web Services ....................................................... 18 3.4 Verso dos Schemas ......................................................................................................... 19 3.4.1 Liberao das verses dos Schemas para o WS de Registro de Eventos..................... 19 3.4.2 Pacote de Liberao Preliminar .................................................................................... 19 3.4.3 Pacote de Liberao de Homologao e Pacote de Liberao definitivo....................... 19 3.4.4 Correo de Pacote de Liberao ................................................................................. 20 3.4.5 Divulgao de novos Pacotes de Liberao .................................................................. 20 3.4.6 Controle de Verso ....................................................................................................... 20 4. Web Service ....................................................................................................................... 21 4.1 Servio de Recepo de Evento ........................................................................................ 22 4.1.1 Web Service RecepcaoEvento ................................................................................... 23 4.1.2 Leiaute Mensagem de Entrada ..................................................................................... 23 4.1.3 Leiaute Mensagem de Retorno ..................................................................................... 26 4.1.4 Descrio do Processo de Recepo de Evento ........................................................... 29 4.1.5 Validao do Certificado de Transmisso ..................................................................... 29 4.1.6 Validao Inicial da Mensagem no Web Service ........................................................... 29 4.1.7 Validao das informaes de controle da chamada ao Web Service ........................... 30 4.1.8 Validao da rea de Dados ......................................................................................... 30 4.1.9 Processamento das validaes especficas do evento .................................................. 32 4.1.10 Final do Processamento do Lote ................................................................................... 32 5. Web Services Informaes Adicionais ............................................................................. 33 5.1 Regras de validao .......................................................................................................... 33 5.1.1 Tabela de cdigos de erros e descries de mensagens de erros ................................ 33 1. 2.
Pg. 4 / 34

1. Introduo
Este documento tem por objetivo a definio das especificaes e critrios tcnicos necessrios para implementao do registro de eventos da Nota Fiscal Eletrnica.
Pg. 5 / 34

2. Modelo Operacional do Registro de Eventos da NF-e

A Nota Fiscal o documento fiscal que registra as informaes da operao e do fato gerador do tributo, sendo um documento importante para a Administrao Tributria e aos demais interessados na operao. O Projeto da NF-e baseado no conceito de documento fiscal eletrnico: um arquivo eletrnico com as informaes fiscais da operao comercial com a assinatura digital do emissor. A NF-e provocou uma alterao significativa no modelo operacional existente. Como as informaes da NF-e no esto fixadas em uma folha de papel como acontece com a nota fiscal tradicional, hoje podemos ter diversos exemplares de uma mesma NF-e com pessoas distintas e todos os exemplares so juridicamente vlidos por representarem a mesma NF-e. Na Nota Fiscal tradicional, as informaes estavam vinculadas ao suporte fsico, no havendo nenhuma dificuldade de identificar qual seria o documento fiscal original, pois s existe um original no documento fixado no papel. Um documento fiscal registra uma operao de circulao de mercadorias ou prestao de servios e aps a sua emisso ocorrem diversos eventos que tm conseqncias relevantes para este documento fiscal, que eram na maioria das vezes registrados no prprio documento. Este modelo impraticvel com a NF-e, pois mesmo que passssemos a agregar as novas informaes na NF-e, podemos ficar com diversos exemplares da mesma NF-e com registros totalmente diferentes em razo da dificuldade de identificar qual seria a NF-e original, pois todos os exemplares so vlidos. Uma forma de minimizar esta situao a adoo de um repositrio central onde ficam armazenadas as NF-e existentes, para registro de todos eventos que tenham alguma relevncia para a Administrao Tributria. O Ambiente Nacional e da SEFAZ de origem so repositrio de registro da NF-e, onde so registradas os eventos de autorizao, denegao e cancelamento da NF-e, estes registros tambm so distribudos para os demais rgos interessados na operao, sem garantia de sincronismo dos repositrios. Os demais eventos ou no so registrados em nenhum lugar ou so registrados em um sistema autnomo o que dificulta a identificao de todos os eventos de interesse que ocorreram com uma NF-e. Cabe destacar que a ausncia de registo dos eventos de interesse da Administrao Tributria tambm ocorre com a nota fiscal tradicional, no sendo uma deficincia exclusiva da NF-e. Vale observar que antes do advento da NF-e, no existia qualquer possibidade de verificar a regularidade da operao, no mximo era possvel consultar a situao cadastral do suposto emitente na consulta SINTEGRA.
2.1
Eventos de interesse da Nota Fiscal Eletrnica - NF-e
Existem diversos eventos que interessam para a NF-e, pois estes eventos podem alterar a situao da NF-e, como o caso do cancelamento. Apesar de no ter consequncia para a situao da NF-e existem eventos como o Registro de Passagem que registra a circulao da mercadoria e impossibilita o registro do evento de cancelamanto. Podem existir outros eventos como o caso da carta de correo, onde o emissor da NF-e pode sanear uma informao incorreta da NF-e, desde no modifique as informaes vedadas na legislao, ou outras que confirmam um benefcio tributrio condicional como o caso da internalizao da mercadoria na SUFRAMA ou a confirmao do embarque em operao de exportao ou o licenciamento de veculo.
Pg. 6 / 34

A confirmao de recebimento da mercadoria um evento importante para a Administrao Tributria pois circulariza a operao declarada na nota fiscal.
Eventos de interesse da Nota Fiscal Eletrnica
A partir das reunies tcnicas da equipe do Pojeto NF-e, foram mapeados os seguintes eventos: Registros de sada; Registro de passagem; Confirmao de Internalizao na Suframa; Sada para exportao; Confirmao de recebimento; Desconhecimento da operao; Devoluo de mercadoria; Restituio ICMS sobre Combustveis; Ocorrncia em Fiscalizao de Trnsito; Cancelamento pelo Fisco; Reverso do cancelamento; Visto da NF-e; Carta de Correo; Carta de Correo pelo Fisco; NF-e referenciada pelo Fisco; Registro de Veculos; Roubo de Carga; Rastreamento RFID; Outros.
Pg. 7 / 34

2.2
Fluxo dos eventos
Os eventos podem ser praticados pelo prprio emissor, como o caso do cancelamento ou por um rgo da Administrao Tributria, como caso da Secretaria de Fazenda, SUFRAMA, Receita Federal do Brasil e outros rgos da Administrao como o DETRAN no licenciamento de veculos. A recepo do evento pode ser realizada pela SEFAZ de origem quando o evento for praticado pelo emissor ou pela SEFAZ de destino quando o evento for praticado pelo destinatrio da mercadoria. Existem outros eventos que sero tratados pelo Ambiente Nacional como o caso do registro de passagem que pode envolver qualquer rgo da Administrao Tributria e requer um sistema de controle nico de abrangncia nacional para melhor perfomance e controle. Todos os eventos devem ser encaminhados para o repositrio de NF-e do ambiente nacional para que sejam vinculadas respectiva NF-e para permitir que todos os interessados possam consultar a NF-e e os seus eventos.
Fluxo do Evento
Origem
Recepo
Compartilhamento
Distribuio
Emissor
NF-e, cancelamento, inutilizao, carta de correo, etc.
UF Origem
Trnsito, SUFRAMA, DETRAN, RFB, etc.
Registro de passagem, internalizao, licenciamento, embarque exportao, etc.
SVAN
Ambiente Nacional
UF Origem/Destino, SUFRAMA, DETRAN e rgos interessados
Destinatrio
Confirmao de recebimento
UF Destino
2.3
Sincronizao e compartilhamento de eventos
Alm do registro de todos os eventos no repositrio de NF-e do ambiente nacional existe a necessidade de compartilhamento destes eventos para todos os interessados, de forma que todos tenham a mesma viso atualizada da NF-e e dos eventos existentes para esta NF-e. O sincronismo das informaes necessrio para que todos tenham a mesma viso da situao da NF-e, sendo a sua implementao um grande desafio em razo da existncia da informao em
Pg. 8 / 34

diversos rgos interessados que podem autorizar eventos incompatveis com a situao atual do documento fiscal por absoluta falta de atualizao da infomao, como o caso do cancelamento de NF-e cuja circulao j havia sido registrada pela fiscalizao de trnsito. O rgo que recepcionar ou gerar o evento deve encaminh-lo para o sistema de compartilhamento de documentos do Ambiente Nacional que ir atualizar o Ambiente Nacional vinculando o evento respectiva NF-e, alm de disponibilizar o evento para os demais rgos interessados. Os rgos interessados devem implementar um mecanismo de sincronismo permanente de seu repositrio local atravs do download de documentos que oferecido pelo sistema de compartilhamento de documentos do Ambiente Nacional.
2.4
Modelo genrico de Eventos
Como novos eventos sempre podem ser associados NF-e, a arquitetura de Registro de Eventos das UF deve adotar um modelo genrico para permitir a recepo de novos eventos sem grandes alteraes nas aplicaes e principalmente evitar a necessidade de oferecer Web Services especficos para recepo dos novos eventos que surgiro. O acrscimo de um novo evento no deve provocar alterao no leiaute de recepo dos eventos j existentes para que os demais interessados e usurios do servio de Registro de Eventos no sejam obrigados a atualizar a sua aplicao a cada novo evento que surgir. O modelo de mensagem do evento dever ter um conjunto mnimo de informaes comuns, a saber: identificao do autor da mensagem; identificao do evento; identificao da NF-e vinculada; informaes especficas do evento; assinatura digital da mensagem; Exibio dos eventos vinculados
2.5
A consulta de uma NF-e deve oferecer o acesso a todos os eventos que esto vinculados NF-e consultada. Os eventos sero mostrados por ordem cononolgica em forma de uma lista de acontecimentos, com a descrio sucinta do evento, a data e hora de ocorrncia e respectivo nmero do protocolo do evento.
Pg. 9 / 34

A exibio do detalhamento do evento ser realizada atravs de um hiperlink existente em cada evento. Ao clicar no hiperlink, ser exibida uma nova pgina HTML com o detalhamento do evento. A seguir temos um exemplo de detalhamento do evento de autorizao de uso:
Pg. 10 / 34

A tecnologia XSLT de apresentao de documentos XML ser utilizada para apresentar o evento que um documento XML assinada pelo autor do evento. Alguns tipos de eventos podem conter informaes reservadas de interesse exclusivo da Administrao Tributria, sendo necessrio algum mecanismo de controle para filtrar os eventos vinculados a NF-e que sero exibidos na consulta da NF-e.
Pg. 11 / 34

2.6
Nova Consulta Status da NF-e para suportar o modelo de eventos vinculados
Um novo Web Service de consulta status da NF-e dever ser oferecido para que possa recuperar todos os eventos vinculados NF-e. 2.6.1
Diagrama simplificado da Mensagem de Consulta
Pg. 12 / 34

2.6.2
Diagrama simplificado da Mensagem de Retorno da Consulta
Pg. 13 / 34

3. Arquitetura do Sistema de Registro de Eventos da NF-e

3.1
Modelo Conceitual do SRE da NF-e
O Sistema de Registro de Eventos da NF-e SRE NF-e o modelo genrico que permite o registro de evento de interesse da NF-e por personagem que pratica ou recepciona qualquer evento que tenha vinculao e interesse para a NF-e. O registro do evento dever ocorrer preferencialmente no rgo que autorizou a NF-e vinculada ao evento e ser propagado para os demais rgos interessados pelo mecanismo de compartilhamento de documentos fiscais eletrnicos. O Ambiente Nacional deve oferecer um servio de registro de eventos que sero utilizados nas situaes em que o autor do evento gere eventos que envolvam NF-e emitidas por qualquer UF, como so os casos dos eventos relacionados com a fiscalizao de trnsito. O registro do evento requer a existncia da NF-e vinculada na SEFAZ ou no Portal Nacional, contudo alguns eventos do trnsito e da confirmao de recebimento podero ser registrados sem que exista a confirmao da existncia da NF-e vinculada. Os eventos sero representados por mensagens no formato XML que sero gerados pela aplicao do contribuinte ou atravs dos servios oferecidos atravs do Portal da Secretaria de Fazenda interessada ou rgo pblico que pratique atos de interesse da NF-e. O autor da assinatura da mensagem XML do evento pode ser o emissor da NF-e, o destinatrio da NF-e ou qualquer rgo interessado que gerou o evento. Quando o evento envolver a participao de personagem que no possua um certificado digital de pessoa jurdica, como o caso do evento de confirmao de recebimento, a Secretaria da Fazenda interessada dever oferecer um servio em seu Portal para que estes participantes possam gerar o evento que a legislao lhe obrigue. A mensagem XML desta classe de evento ser assinado digitalmente com o certificado digital do rgo interveniente, que dever manter a trilha de auditoria com os dados do usurio que acessou o servio oferecido. O projeto no prev o uso de certificado digital de pessoa fsica para assinatura de mensagens, assim apesar de existir previso no modelo para que uma pessoa fsica seja a autora de um evento, a assinatura digital da mensagem do evento dever ser realizada com uso do certificado digital da pessoa jurdica do rgo participante do evento. O evento de Registro de Veculo, apesar da possibilidade de envolver uma pessoa fsica no evento um evento de responsabilidade do DETRAN que ser o autor do evento. Os servios oferecidos sero sncronos com o processo de solicitao concludo na mesma conexo. O Web Service ser nico com a funcionalidade de tratar eventos de forma genrica para facilitar a criao de novos eventos sem a necessidade de criao de novos servios e com poucas alteraes na aplicao de Registro de Eventos dos Portais das Secretarias de Fazenda.
3.2
3.2.1
Padres Tcnicos
Padro de documento XML
a) Padro de Codificao
Pg. 14 / 34

A especificao do documento XML adotada a recomendao W3C para XML 1.0, disponvel em www.w3.org/TR/REC-xml e a codificao dos caracteres ser o UTF-8, assim todos os documentos XML sero iniciados com a seguinte declarao: <?xml version="1.0" encoding="UTF-8"?> b) Declarao namespace O documento XML dever ter uma nica declarao de namespace no elemento raiz do documento com o seguinte padro: <envEvento xmlns=http://www.portalfiscal.inf.br/nfe > (exemplo para o XML de envio de Evento) O uso de declarao namespace diferente do padro estabelecido vedado. A declarao do namespace da assinatura digital dever ser realizada na prpria tag <Signature>, conforme exemplo abaixo. Segue abaixo um exemplo:
<?xml version="1.0" encoding="UTF-8"?> <envEvento xmlns="http://www.portalfiscal.inf.br/nfe" versao="1.00"> <evento xmlns="http://www.portalfiscal.inf.br/nfe"> <infEvento Id="CRB31060243816719000108650000000010001234567890" versao="1.00"> ... <Signature xmlns="http://www.w3.org/2000/09/xmldsig#"> </evento> </envEvento>
c) Prefixo de namespace No permitida a utilizao de prefixos de namespace. Essa restrio visa otimizar o tamanho do arquivo XML. Assim, ao invs da declarao: <evento xmlns:nfe=http://www.portalfiscal.inf.br/nfe> (exemplo para o XML de evento com prefixo nfe) dever ser adotado a declarao: <evento xmlns =http://www.portalfiscal.inf.br/nfe > d) Validao de Schema Para garantir minimamente a integridade das informaes prestadas e a correta formao dos arquivos XML, as mensagens XML devero ser submetidas ao respectivo Schema XML (XSD XML Schema Definition).
3.2.2
Padro de Comunicao
A comunicao ser baseada em Web Services disponibilizados pelo Sistema de Registro de Eventos.
Pg. 15 / 34

O meio fsico de comunicao utilizado ser a Internet, com o uso do protocolo 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, eliminando a necessidade de identificao do usurio atravs de nome ou cdigo de usurio e senha. O modelo de comunicao segue o padro de Web Services definido pelo WS-I Basic Profile. A troca de mensagens entre os Web Services do Ambiente Nacional e o aplicativo da administrao tributria interessada ser realizada no padro SOAP verso 1.2, com troca de mensagens XML no padro Style/Enconding: Document/Literal. A chamada de diferentes Web Services do Sistema de Registro de Eventos realizado com o envio de uma mensagem XML atravs do parmetro nfeDadosMsg. A verso do leiaute da mensagem XML contida no parmetro nfeDadosMsg ser informado no elemento versaoDados do tipo string localizados no elemento nfeCabecMsg do SOAP Header. Exemplo de uma mensagem requisio padro SOAP:
<?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soapenvelope"> <soap12:Header> <nfeCabecMsg xmlns="http://www.portalfiscal.inf.br/nfe/wsdl/RecepcaoEvento> <versaoDados>string</versaoDados> </nfeCabecMsg> </soap12:Header> <soap12:Body> <nfeRecepcaoEvento xmlns="http://www.portalfiscal.inf.br/nfe/wsdl/nfeRecepcaoEvento"> <nfeDadosMsg>xml</nfeDadosMsg> </nfeRecepcaoEvento> </soap12:Body> </soap12:Envelope>
Exemplo de uma mensagem de retorno padro SOAP:

<?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soapenvelope"> <soap12:Header> <nfeCabecMsg xmlns="http://www.portalfiscal.inf.br/nfe/wsdl/nfeRecepcaoEvento"> <versaoDados>string</versaoDados> </nfeCabecMsg> </soap12:Header> <soap12:Body> <nfeRecepcaoEventoResponse xmlns="http://www.portalfiscal.inf.br/nfe/wsdl/nfeRecepcaoEvento"> <nfeRecepcaoEventoResult>xml</nfeRecepcaoEventoResult> </ nfeRecepcaoEventoResponse > </soap12:Body> </soap12:Envelope>
3.2.3
Padro de Certificado Digital
O certificado digital utilizado no estabelecimento da conexo segura com autenticao mtua ser emitido por Autoridade Certificadora credenciada pela Infra-estrutura de Chaves Pblicas Brasileira ICP-Brasil, tipo A1 ou A3, devendo conter o CNPJ da pessoa jurdica titular do certificado digital no campo otherName OID =2.16.76.1.3.3 e ter a extenso Extended Key Usage com permisso de "Autenticao Cliente".
Pg. 16 / 34

3.2.4
Resumo dos Padres Tcnicos
A tabela a seguir resume os principais padres de tecnologia utilizados:
3.3
Padro de mensagens dos Web Services
As chamadas dos Web Services disponibilizados pelo Ambiente Nacional e os respectivos resultados do processamento so realizadas atravs das mensagens com o seguinte padro:
Padro de Mensagem de chamada/retorno de Web Service

versaoDados
Estrutura XML definida na documentao do Web Service

rea de dados (SOAP Body)
Elemento nfeCabecMsg (SOAP Header)
versaoDados - verso do leiaute da estrutura XML informado na rea de dados. rea de Dados estrutura XML varivel definida na documentao do Web Service acessado.
3.3.1
Informao de controle e rea de dados das mensagens
A identificao da verso da mensagem XML submetida ao Web Service ser realizada atravs do campo versaoDados informado no elemento sceCabecMsg do SOAP Header:
<soap12:Header>
<nfeCabecMsg xmlns="http://www.portalfiscal.inf.br/nfe/wsdl/nfeRecepcaoEvento"> <versaoDados>string</versaoDados> </nfeCabecMsg>
</soap12:Header>
A informao armazenada na rea de dados um documento XML que deve atender o leiaute definido na documentao do Web Service acessado:
<soap12:Body> <nfeRecepcaoNfeCResponse xmlns="http://www.portalfiscal.inf.br/nfe/wsdl/nfeRecepcaoEvento"> <nfeRetornoMsg>xml</nfeRetornoMsg> </nfeRecepcaoDPECResponse> </soap12:Body>
3.3.2
Validao da estrutura XML das Mensagens dos Web Services
As informaes so enviadas ou recebidas dos Web Services atravs de mensagens no padro XML definido na documentao de cada Web Service. As alteraes de leiaute e da estrutura de dados XML realizadas nas mensagens so controladas atravs da atribuio de um nmero de verso para a mensagem. Um Schema XML uma linguagem que define o contedo do documento XML, descrevendo os seus elementos e a sua organizao, alm de estabelecer regras de preenchimento de contedo e de obrigatoriedade de cada elemento ou grupo de informao.
Pg. 17 / 34

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 do Schema XML. A primeira condio para que a mensagem seja validada com sucesso que ela seja submetida ao Schema XML correto. Assim, os aplicativos clientes devem estar preparados para gerar as mensagens no leiaute em vigor, devendo ainda informar a verso do leiaute da estrutura XML da mensagem no campo versaoDados do elemento nfeCabecMsg do SOAP Header.
<soap12:Header> <nfeCabecMsg xmlns="http://www.portalfiscal.inf.br/nfe/wsdl/SCERecepcaoRFB"> <versaoDados>1.00</versaoDados> </nfeCabecMsg> </soap12:Header>
3.3.3
Schemas XML das Mensagens dos Web Services
Qualquer altera de leiaute das mensagens dos Web Services implica na atualizao do seu respectivo Schema XML. A identificao da verso dos Schemas ser realizada com o acrscimo do nmero da verso no nome do arquivo precedida da literal _v, como segue: envEvento_v1.00.xsd (Schema XML da mensagem de envio da Evento, verso 1.00); leiauteEvento_v10.15.xsd (Schema XML dos tipos bsicos do Evento, verso 10.15). A maioria dos Schemas XML do Sistema de Registro de Eventos utilizam as definies de tipos bsicos ou tipos complexos que esto definidos em outros Schemas XML (ex.: leiauteEvento_v1.00.xsd, etc.), nestes casos, a modificao de verso do Schema bsico ser repercutida no Schema principal. Por exemplo, o tipo numrico de 15 posies com 2 decimais definido no Schema leiuateEvento_v1.00.xsd, caso ocorra alguma modificao na definio deste tipo, todos os Schemas que utilizam este tipo bsico devem ter a sua verso atualizada e as declaraes import ou include devem ser atualizadas com o nome do Schema bsico atualizado. Exemplo de Schema XML
<?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:ds="http://www.w3.org/2000/09/xmldsig#" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://www.portalfiscal.inf.br/nfe" targetNamespace="http://www.portalfiscal.inf.br/nfe" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:import namespace="http://www.w3.org/2000/09/xmldsig#" schemaLocation="xmldsig-coreschema_v1.01.xsd"/> <xs:include schemaLocation="leiauteEvento_v1.00.xsd"/> <xs:element name="envEvento"> <xs:annotation> <xs:documentation>mensagem de envio de Evento</xs:documentation> </xs:annotation>
As modificaes de leiaute das mensagens dos Web Services 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
Pg. 18 / 34

normativo que introduziu a alterao. As modificaes de ordem tcnica sero divulgadas pela Coordenao Tcnica do ENCAT e podero ocorrer sempre que se fizerem necessrias.
3.4
3.4.1
Verso dos Schemas
Liberao das verses dos Schemas para o WS de Registro de Eventos
Os schemas vlidos para o WS de Registro de Eventos sero disponibilizados no stio nacional do Projeto (www.nfe.fazenda.gov.br), e sero liberados aps autorizao da Coordenao Tcnica do Projeto. A cada nova liberao ser disponibilizado um arquivo compactado contendo o conjunto de schemas a serem utilizados pelos emissores de NF-e para a gerao dos arquivos XML. Este arquivo ser denominado Pacote de Liberao e ter a mesma numerao da verso do Manual que lhe compatvel. Os pacotes de liberao sero identificados pelas letras PL_SRE, seguida do nmero da verso do Manual de Sistema de Registro de Eventos correspondente. Exemplificando: O pacote PL_SRE_1.00.zip representa o Pacote de Liberao de schemas do WS do Sistema de Registro de Eventos compatveis com o Manual de Sistema de Registro de Eventos verso 1.00. Os schemas XML das mensagens XML do projeto so identificados pelo seu nome, seguido da verso do respectivo schema. Assim, para o schema XML de Envio de Evento, corresponder um arquivo com a extenso .xsd, que ter o nome de envEvento_v9.99.xsd, onde v9.99, corresponde verso do respectivo schema. Para identificar quais os schemas que sofreram alterao em um determinado pacote liberado, devese comparar o nmero da verso do schema deste pacote com o do pacote anterior. Exemplificando: PACOTE DATA LIBERAO SCHEMAS PL_ SRE_ 1.00.ZIP 01/09/2008 envEvento_v1.00.xsd retEvento_v1.00.xsd leiauteEvento_v1.00.xsd PL_SRE_ 1.01.ZIP 01/10/2009 envEvento_v1.30.xsd retEvento_v1.00.xsd leiauteEvento_v1.01.xsd
3.4.2
Pacote de Liberao Preliminar
Aps a divulgao de uma nova verso do Manual de Sistema de Registro de Eventos, ser divulgado um pacote de liberao preliminar com vigncia limitada at o incio da fase de disponibilizao do ambiente de homologao. Durante este perodo, os novos Schemas XML sero avaliados e testados para a identificao de eventuais falhas de implementao das alteraes realizadas na nova verso do Manual de Sistema de Registro de Eventos. O PL preliminar ser identificado com o acrscimo do literal pre na identificao do pacote, como por exemplo: PL_SRE_1.00pre.zip. 3.4.3
Pacote de Liberao de Homologao e Pacote de Liberao definitivo
Para o ambiente de homologao ser divulgado um pacote de liberao de homologao identificado com o acrscimo da literal hom na identificao do pacote, como por exemplo: PL_SRE_100hom.zip.
Pg. 19 / 34

A principal caracterstica do pacote de liberao de homologao seu uso estar restrito ao ambiente de homologao por aceitar somente mensagens XML com tpAmb=2-homologao. O pacote de liberao definitivo ser divulgado na vspera da data de incio da vigncia do ambiente de produo. 3.4.4
Correo de Pacote de Liberao
Em algumas situaes pode surgir a necessidade de correo de um Schema XML por um erro de implementao de regra de validao, obrigatoriedade de campo, nome de tag divergente do definido no leiaute da mensagem, que no modifica a estrutura do Schema XML e nem exige a alterao dos aplicativos da SEFAZ. Nesta situao, divulgaremos um novo pacote de liberao com o Schema XML corrigido, sem modificar o nmero da verso do PL para manter a compatibilidade com o Manual de Sistema de Registro de Eventos vigente. A identificao dos pacotes mais recentes se dar com o acrscimo de letra minscula do alfabeto, como por exemplo: PL_SRE_1.00a.ZIP, indicando que se trata da primeira verso corrigida do PL_SRE_1.00.ZIP 3.4.5
Divulgao de novos Pacotes de Liberao
A divulgao de novos pacotes de liberao ou atualizaes de pacote de liberao ser realizada atravs da publicao de Notas Tcnicas pela Coordenao do ENCAT com as informaes necessrias para a implementao dos novos pacotes de liberao. 3.4.6
Controle de Verso
O controle de verso de cada um dos schemas vlidos para o WS do Sistema de Registro de Eventos compreende uma definio nacional sobre: qual a verso vigente (verso mais atualizada); quais so as verses anteriores ainda suportadas. Este controle de verses permite a adaptao dos sistemas de informtica dos emissores em diferentes datas. Ou seja, alguns emissores podero estar com uma verso de leiaute mais atualizada, enquanto outros podero ainda estar operando com mensagens em um leiaute anterior. Mensagens recebidas com uma verso de leiaute no suportada sero rejeitadas com uma mensagem de erro especfica na verso do leiaute de resposta mais recente em uso.
Pg. 20 / 34

4. Web Service
O mecanismo de utilizao do Web Service segue as seguintes premissas: a) Ser disponibilizado um nico Web Service; b) O envio da solicitao e a obteno do retorno sero realizados na mesma conexo atravs de um nico mtodo. c) A URL do Web Service ser publicada no portal do Ambiente Nacional. Acessando a URL pode ser obtido o WSDL (Web Services Description Language) do Web Service. d) O processo de utilizao do Web Service sempre iniciado pelo interessado com o envio uma mensagem nos padres XML e SOAP, atravs do protocolo SSL com autenticao mtua. e) A ocorrncia de qualquer erro na validao dos dados recebidos interrompe o processo com a disponibilizao de uma mensagem contendo o cdigo e a descrio do erro.
Pg. 21 / 34

4.1
Servio de Recepo de Evento
O Servio de Recepo de Evento o servio oferecido para Registro de Eventos da NF-e. Existem atualmente os seguintes eventos identificados nas reunies da NF-e:
Cdigo Evento Autor do Evento rgo responsvel pelo Registro 1-UF Autorizadora 1-UF Autorizadora 1-UF Autorizadora 1-UF Autorizadora 1-UF Autorizadora 1-UF Autorizadora 1-UF Autorizadora 1-UF Autorizadora 1-UF Autorizadora 1-UF Autorizadora 2-Ambiente Nacional 2-Ambiente Nacional 2-Ambiente Nacional 2-Ambiente Nacional 2-Ambiente Nacional 2-Ambiente Nacional 3-Ambiente Nacional ou UF Autorizadora 3-Ambiente Nacional ou UF Autorizadora 3-Ambiente Nacional ou UF Autorizadora 3-Ambiente Nacional ou UF Autorizadora 3-Ambiente Nacional ou UF Autorizadora 3-Ambiente Nacional ou UF Autorizadora 3-Ambiente Nacional ou UF Autorizadora 3-Ambiente Nacional ou UF Autorizadora
NF-e deve existir? Visibilidade (obs)
10101nn 10102nn 10103nn 10104nn 10105nn 10106nn 10107nn 10201nn 10202nn 10203nn 20501nn 20502nn 20503nn 20601nn 20701nn 20801nn 30401nn
Cancelamento pelo Fisco Reverso do cancelamento Recuperao do ICMS Operao no realizada NF-e referenciada pelo Fisco Correo pelo Fisco Restituio ICMS sobre Combustveis Carta de Correo Registros de sada Roubo de Carga Ocorrncia na Fiscalizao de Trnsito Rastreamento RFID Registro de passagem Registro de Veculos Confirmao de Internalizao na SUFRAMA Sada para exportao Confirmao de recebimento
01-Fisco Autorizador 01-Fisco Autorizador 01-Fisco Autorizador 01-Fisco Autorizador 01-Fisco Autorizador 01-Fisco Autorizador 01-Fisco Autorizador 02-Emitente 02-Emitente 02-Emitente 05-Fisco 05-Fisco 05-Fisco 06-DETRAN 07-SUFRAMA 08-RFB 04-Destinatrio
SIM SIM SIM SIM SIM SIM SIM SIM SIM SIM SIM NO NO SIM SIM SIM NO
F/C/O F/C/O F/C/O F/C/O F/C/O F/C/O F/C/O F/C/O F/C/O F/C/O F/C/O F/C/O F/C/O F/C/O F/C/O F/C/O F/C/O
30402nn
Desconhecimento da operao
04-Destinatrio
NO
F/C/O
30403nn
Devoluo de mercadoria
04-Destinatrio
NO
F/C/O
30501nn
NF-e em anlise
05-Fisco
NO
F/C/O
30502nn
Confirmao de recebimento Portal SEFAZ Desconhecimento da operao Portal SEFAZ Devoluo de mercadoria Portal SEFAZ NF-e visada pelo Fisco
05-Fisco
NO
F/C/O
30503nn
05-Fisco
NO
F/C/O
30504nn
05-Fisco
NO
F/C/O
30505nn
05-Fisco
SIM
F/C/O
Obs: F-> fisco, C-> contribuinte e O-> outros rgos interessados. nn-> cdigo IBGE da UF do autor do evento.
Pg. 22 / 34

A implementao dos eventos ser gradual e sero acrescentadas como Anexo neste documento a medida que forem definidos. 4.1.1
Web Service RecepcaoEvento
Sistema de Registro de Eventos

Emissor NF-e
WS da Fazenda
Web Service :
RecepcaoEvento
Envio de Evento da NF-e
Proc. nfeRecepcaoEvento
Ret
Recepo Aplicao SRE
Cliente
Retorno
Funo: servio destinado recepo de mensagem de Evento da NF-e Processo: sncrono. Mtodo: nfeRecepcaoEvento 4.1.2
Leiaute Mensagem de Entrada
Entrada: Estrutura XML com o Evento Schema XML: envEvento_v9.99.xsd

# Campo Ele Raiz A E Pai AP01 AP01 Tipo Ocor. Tam. Dec. N N 1-1 1-1 1-4 1-15 2 TAG raiz Verso do leiaute Identificador de controle do Lote de envio do Evento. Nmero seqencial autoincremental nico para identificao do Lote. A responsabilidade de gerar e controlar exclusiva do autor do evento. O Web Service no faz qualquer uso deste identificador. Evento, um lote pode conter at 20 eventos 2 Verso do leiaute do evento Grupo de informae do registro do Evento 67 Identificador da TAG a ser assinada, a regra de formao do Id : ID + cdEvento (9999999) + data e hora do evento (aaaammddhhmmss)+ chave da NF-e (99999999999999999999999999999999999999999999) Cdigo do rgo de recepo do Evento. Utilizar a Tabela do IBGE, criar cdigo para Ambiente Nacional. Identificao do Ambiente: 1 - Produo 2 Homologao Informar o CNPJ ou o CPF do autor do Evento Chave de Acesso da NF-e vinculada ao Evento Data e hora do evento no formato AAAA-MMPg. 23 / 34
Descrio/Observao
AP01 envEvento AP02 versao AP03 idLote
AP04 evento AP05 versao AP06 infEvento AP07 Id
G A G ID
AP04 AP04 AP06
N C
1-20 1-1 1-1 1-1
1-4
AP08 cOrgao AP09 tpAmb
E E
AP06 AP06
N N
1-1 1-1
2 1
AP10 CNPJ AP11 CPF AP12 chNFe AP13 dhEvento
CE AP06 CE AP06 E E AP06 AP06
N N N D
1-1 1-1 1-1 1-1
14 11 44

Campo
Ele E E G G
Pai AP06 AP06
Tipo Ocor. Tam. Dec. DDTHH:MM:SS N N 1-1 1-1 1-1 1-1 7 1-4 2
Descrio/Observao Cdigo do de evento, vide codificao adotada no item 4.1 Verso do evento Informaes do evento (estrutura XML varivel, depende do tipo do evento) Assinatura Digital do documento XML, a assinatura dever ser aplicada no elemento infEvento
AP14 cEvento AP15 verEvento AP16 detEvento AR17 Signature
AP06 XML AP04 XML
Pg. 24 / 34

Diagrama simplificado do Schema XML: envEvento_v9.99.xsd
Pg. 25 / 34

4.1.3
Leiaute Mensagem de Retorno
Retorno: Estrutura XML com a mensagem do resultado da transmisso. Schema XML: retEnvEvento_v9.99.xsd
# Campo Ele Raiz A E Pai AR01 AR01 Tipo Ocor. Tam. Dec. N N 1-1 1-1 1-4 1-15 2 Verso do leiaute Identificador de controle do Lote de envio do Evento. Nmero seqencial autoincremental nico para identificao do Lote. A responsabilidade de gerar e controlar o identificador exclusiva do autor do evento. O Web Service no faz qualquer uso deste identificador. Identificao do Ambiente: 1 Produo / 2 - Homologao Verso da aplicao que processou o evento. Cdigo da UF que registrou o Evento Cdigo do status da resposta Descrio do status da resposta TAG de grupo do resultado do processamento do Evento 2 Verso do leiaute Grupo de informae do registro do Evento 67 Identificador da TAG a ser assinada, a regra de formao do Id : ID + cdEvento (9999999) + data e hora de registro do evento (aaaammddhhmmss)+ chave da NF-e (99999999999999999999999999999999999999999999) Identificao do Ambiente: 1 Produo / 2 Homologao Verso da aplicao que registrou o Evento. Cdigo da UF que registrou o Evento Cdigo do status da resposta Descrio do status da resposta Chave de Acesso da NF-e vinculada ao evento Cdigo do Tipo do Evento Data e hora de registro do evento no formato AAAA-MMDDTHH:MM:SS 15 Nmero do Protocolo da NF-e 1 posio (1-Secretaria da Fazenda Estadual, 2-RFB), 2 posies para o cdigo da UF, 2 posies para o ano e 10 posies para o seqencial no ano. Assinatura Digital do documento XML, a assinatura dever ser aplicada no elemento infEvento Descrio/Observao TAG raiz do Resultado do Envio do Evento
AR01 retEnvEvento AR02 versao AR03 idLote
AR04 tpAmb AR05 verAplic AR06 cOrgao AR07 cStat AR08 xMotivo AR09 retEvento AR10 versao AR11 infEvento AR12 Id
E E E E E G A G
AR01 AR01 AR01 AR01 AR01 AR01 AR09 AR09
N C N N N N C
1-1 1-1 1-1 1-1 1-1 1-1 1-1 1-1
1 1-20 2 3 255 0-20 1-4
ID AR11
AR13 tpAmb AR14 verAplic AR15 cOrgao AR16 cStat AR17 xMotivo AR18 chNFe AR19 cEvento AR20 dhRegEvento AR21 nProt
E E E E E E E E E
AR11 AR11 AR11 AR11 AR11 AR11 AR11 AR11 AR11
N C N N N N N D N
1-1 1-1 1-1 1-1 1-1 0-1 0-1 0-1 0-1
1 1-20 2 3 255 44 7
AR22 Signature
AR09 XML
0-1
Pg. 26 / 34

Diagrama Simplificado do retorno
Pg. 27 / 34

Pg. 28 / 34

4.1.4
Descrio do Processo de Recepo de Evento
O WS do Sistema de Recepo de Registro de Eventos acionado pelo interessado (emissor, destinatrio ou rgo pblico) que deve enviar mensagem de registro de evento. O processo de Registro de Eventos recebe eventos em uma estrutura de lotes, que pode conter de 1 a 20 eventos.
4.1.5
Validao do Certificado de Transmisso

Validao do Certificado Digital do Transmissor (protocolo SSL
Regra de Validao
Crtica Obrig.
Msg 280
Efeito Rej.
A01 Certificado de Transmissor Invlido: - Certificado de Transmissor inexistente na mensagem - Verso difere "3" - Se informado o Basic Constraint deve ser true (no pode ser Certificado de AC) - KeyUsage no define "Autenticao Cliente" A02 Validade do Certificado (data incio e data fim) A03 Verifica a Cadeia de Certificao: - Certificado da AC emissora no cadastrado na SEFAZ - Certificado de AC revogado - Certificado no assinado pela AC emissora do Certificado A04 LCR do Certificado de Transmissor - Falta o endereo da LCR (CRL DistributionPoint) - LCR indisponvel - LCR invlida A05 Certificado do Transmissor revogado A06 Certificado Raiz difere da "ICP-Brasil" A07 Falta a extenso de CNPJ no Certificado (OtherName - OID=2.16.76.1.3.3)
Obrig. Obrig.
281 283
Rej. Rej.
Obrig.
286
Rej.
Obrig. Obrig. Obrig.
284 285 282
Rej. Rej. Rej.
As validaes de A01, A02, A03, A04 e A05 so realizadas pelo protocolo SSL e no precisam ser implementadas. A validao A06 tambm pode ser realizada pelo protocolo SSL, mas pode falhar se existirem outros certificados digitais de Autoridade Certificadora Raiz que no sejam ICP-Brasil no repositrio de certificados digitais do servidor de Web Service do rgo de registro. 4.1.6
Validao Inicial da Mensagem no Web Service

Validao Inicial da Mensagem no Web Service
Regra de Validao
Aplic. Obrig. Obrig. Obrig.
Msg 214 108 109
Efeito Rej. Rej. Rej.
B01 Tamanho do XML de Dados superior a 500 KB B02 Verifica se o Servidor de Processamento est Paralisado Momentaneamente B03 Verifica se o Servidor de Processamento est Paralisado sem Previso
A mensagem ser descartada se o tamanho exceder o limite previsto (500 KB). A aplicao do Emissor no poder permitir a gerao de mensagem com tamanho superior a 500 KB. Caso isto ocorra, a conexo poder ser interrompida sem retorno da mensagem de erro se o controle do tamanho da mensagem for implementado por configuraes do ambiente de rede do Sistema de Registro de Eventos (ex.: controle no firewall). No caso do controle de tamanho ser implementado por aplicativo teremos a devoluo da mensagem de erro 214.
Pg. 29 / 34

Caso o Web Service fique disponvel, mesmo quando o servio estiver paralisado, devero implementar as verificaes 108 e 109. Estas validaes podero ser dispensadas se o Web Service no ficar disponvel quando o servio estiver paralisado. 4.1.7
Validao das informaes de controle da chamada ao Web Service

Validao das informaes de controle da chamada ao Web Service
Regra de Validao
Aplic. Obrig. Obrig. Facult. Obrig.
Msg 409 412 238 239
Efeito Rej. Rej. Rej. Rej.
C01 Elemento nfeCabecMsg inexistente no SOAP Header C02 Campo versaoDados inexistente no elemento nfeCabecMsg do SOAP Header C03 Verso dos Dados informada superior verso vigente C04 Verso dos Dados no suportada
A informao da verso do leiaute da registro de evento informada no elemento nfeCabecMsg do SOAP Header (para maiores detalhes vide item 3.4). A aplicao dever validar o campo de verso da mensagem (versaoDados), rejeitando a solicitao recebida em caso de informaes inexistentes ou invlidas.
4.1.8
Validao da rea de Dados
a) Validao de forma da rea de dados A validao de forma da rea de dados da mensagem realizada com a aplicao da seguinte regra:
Validao da rea de dados da mensagem # Regra de Validao Aplic. Obrig. Obrig. Obrig. Msg 215 404 402 Efeito Rej. Rej. Rej. D01 Verifica Schema XML da rea de Dados D02 Verifica o uso de prefixo no namespace D03 XML utiliza codificao diferente de UTF-8
A validao do Schema XML realizada em toda mensagem de entrada, mas como existe uma parte da mensagem que varivel pode ocorrer erro de falha de Schema XML da parte especfica da mensagem. b) Extrao dos eventos do lote e validao do Schema XML do evento A aplicao deve extrarir os eventos do lote para tratar idividualmente os eventos, a princpio no existe necessidade de que todos os eventos sejam do mesmo tipo. A escolha do Schema XML aplicvel para o evento realizado com base nos 7 primeiros dgitos do cEvento combinado com a verEvento, assim, a aplicao deve manter um controle dos cEvento vlidos e as verEvento em vigncia e o respectivo Schema XML.
Validao do evento # Regra de Validao Aplic. Obrig. Obrig. Obrig. Msg 491 492 493 Efeito Rej. Rej. Rej. D04 Verifica se o cEvento vlido D05 Verifica se o verEvento vlido D06 Verifica se o detEvento atende o respectivo schema XML
Pg. 30 / 34

c) Validao do Certificado Digital de Assinatura
Validao do Certificado Digital utilizado na Assinatura Digital do DF-e # Regra de Validao Aplic. Obrig. Msg 290 Efeito Rej. E01 Certificado de Assinatura invlido: - Certificado de Assinatura inexistente na mensagem (*validado tambm pelo Schema) - Verso difere "3" - Se informado o Basic Constraint deve ser true (no pode ser Certificado de AC) - KeyUsage no define "Assinatura Digital" e No Recusa E02 Validade do Certificado (data incio e data fim) E03 Falta a extenso de CNPJ no Certificado (OtherName OID=2.16.76.1.3.3) E04 Verifica Cadeia de Certificao: - Certificado da AC emissora no cadastrado na SEFAZ - Certificado de AC revogado - Certificado no assinado pela AC emissora do Certificado E05 LCR do Certificado de Assinatura: - Falta o endereo da LCR (CRLDistributionPoint) - Erro no acesso a LCR ou LCR inexistente E06 Certificado de Assinatura revogado E07 Certificado Raiz difere da ICP-Brasil
Obrig. Obrig. Obrig.
291 292 293
Rej. Rej. Rej.
Obrig.
296
Rej.
Obrig. Obrig.
294 295
Rej. Rej.
c) Validao da Assinatura Digital
Validao da Assinatura Digital do DF-e # Regra de Validao Aplic. Obrig. Msg 298 Efeito Rej. F01 Assinatura difere do padro do Projeto: - No assinado o atributo "ID" (falta "Reference URI" na assinatura) (*validado tambm pelo Schema) - Faltam os "Transform Algorithm" previstos na assinatura ("C14N" e "Enveloped") Estas validaes so implementadas pelo Schema XML da Signature F02 Valor da assinatura (SignatureValue) difere do valor calculado
Obrig.
297 213
Rej. Rej.
F03 CNPJ-Base do Autor da mensagem difere do CNPJ-Base do Certificado Digital Obrig.
d) Validao de regras de negcios do Registro de Evento- parte Geral

Validao do Registro de Eventos Regras de Negcios parte Geral # Regra de Validao Aplic. Obrig. Obrig. Obrig. Obrig. Obrig. Msg 252 250 489 490 Efeito Rej. Rej. Rej. Rej. Rej. G01 Tipo do ambiente difere do ambiente do Web Service G02 UF diverge da solicitada G03 CNPJ do autor do evento informado invlido (DV ou zeros) G04 CPF do autor do evento informado invlido (DV ou zeros) G05 Validar se atributo Id corresponde a concatenao dos campos respecitvos do
Pg. 31 / 34

Validao do Registro de Eventos Regras de Negcios parte Geral # Regra de Validao Aplic. Obrig. Obrig. Obrig. Obrig. Msg Efeito Rej. Rej. Rej. Rej. evento (Id + cEvento + aaaammddHHMMSS da data do evento + chNFe) G06 Data do evento no pode ser maior que a data de processamento G07 NF-e vinculada inexistente para o tpEvento que exige a existncia da NF-e G08 Data do evento no pode ser menor que a data de autorizao para NF-e no emitida em contingncia se a NF-e existir. G09 Data do evento no pode ser menor que a data de emisso para NF-e emitida em contingncia e existente na base
4.1.9
Processamento das validaes especficas do evento
Sero definidos no respectivo Anexo do evento.
4.1.10 Final do Processamento do Lote O processamento do lote pode resultar em: Rejeio do Lote por algum problema que comprometa o processamento do lote; Processamento do Lote o lote foi processado (cStat=130), a validao de cada evento do lote poder resultar em: o Rejeio o Evento ser descartado, com retorno do cdigo do status do motivo da rejeio; o Recebido pelo Sistema de Registro de Eventos, com vinculao do evento na respetiva NF-e, o Evento ser armazenado no repositrio do Sistema de Registro de Eventos com a vinculao do Evento respectiva NF-e (cStat=128); o Recebido pelo Sistema de Registro de Eventos vinculao do evento respectiva NF-e prejudicada o Evento ser armazenado no repositrio do Sistema de Registro de Eventos, a vinculao do evento respectiva NF-e fica prejudicada face a inexistncia da NF-e no momento do recebimento do Evento (cStat=129);
A UF que recepcionar o Evento deve envi-lo para o Sistema de compartilhamento do AN Ambiente Nacional para que o Evento seja distribudo para todos os interessados.
Pg. 32 / 34

5. Web Services Informaes Adicionais

5.1
Regras de validao As regras de validao aplicadas nos Web Services esto agrupadas da seguinte forma: Grupo Validao do Certificado Digital utilizado no protocolo SSL Validao da Mensagem Validao das informaes de controle da chamada ao Web Service Validao da rea de dados da Mensagem XML Validao do Certificado Digital utilizada na Assinatura Digital Validao da Assinatura Digital Validao do Evento parte geral Validao do Evento parte especfica Aplicao geral geral geral geral geral geral especfica especfica
A B C D E F G H
As regras do grupo A, B, C, D, E e F so de aplicao geral e aplicadas em todos os Web Services existentes, as regras do grupo G, H so especficos de cada Web Service. 5.1.1
Tabela de cdigos de erros e descries de mensagens de erros

RESULTADO DO PROCESSAMENTO DA SOLICITAO
CDIGO
108 109 129 135 136

CDIGO
Servio Paralisado Momentaneamente (curto prazo) Servio Paralisado sem Previso Lote de Evento Processado Evento registrado e vinculado a NF-e Evento registrado, mas no vinculado a NF-e
MOTIVOS DE NO ATENDIMENTO DA SOLICITAO
203 207 208 209 213 214 215 238 239 252 280 281 282 283 284 285 286 290 291 292 293 294 295 296 297 298 402
Rejeio: Emissor no habilitado para emisso da NF-e Rejeio: CNPJ do emitente invlido Rejeio: CNPJ do destinatrio invlido Rejeio: IE do emitente invlida Rejeio: CNPJ-Base do autor do documento difere do CNPJ-Base do Certificado Digital Rejeio: Tamanho da mensagem excedeu o limite estabelecido Rejeio: Falha no schema XML Rejeio: Cabealho - Verso do arquivo XML superior a Verso vigente Rejeio: Cabealho - Verso do arquivo XML no suportada Rejeio: Ambiente informado diverge do Ambiente de recebimento Rejeio: Certificado Transmissor invlido Rejeio: Certificado Transmissor Data Validade Rejeio: Certificado Transmissor sem CNPJ Rejeio: Certificado Transmissor - erro Cadeia de Certificao Rejeio: Certificado Transmissor revogado Rejeio: Certificado Transmissor difere ICP-Brasil Rejeio: Certificado Transmissor erro no acesso a LCR Rejeio: Certificado Assinatura invlido Rejeio: Certificado Assinatura Data Validade Rejeio: Certificado Assinatura sem CNPJ Rejeio: Certificado Assinatura - erro Cadeia de Certificao Rejeio: Certificado Assinatura revogado Rejeio: Certificado Assinatura difere ICP-Brasil Rejeio: Certificado Assinatura erro no acesso a LCR Rejeio: Assinatura difere do calculado Rejeio: Assinatura difere do padro do Projeto Rejeio: XML da rea de dados com codificao diferente de UTF-8
Pg. 33 / 34

404 409 412 489 490 491 492 493 494 496 497 498 499 500 501
Rejeio: Uso de prefixo de namespace no permitido Rejeio: Elemento nfeCabecMsg inexistente no SOAP Header Rejeio: Campo versaoDados inexistente no elemento nfeCabecMsg do SOAP Header Rejeio: CNPJ informado invlido (DV ou zeros) Rejeio: CPF informado invlido (DV ou zeros) Rejeio: O cEvento informado invlido Rejeio: O verEvento informado invlido Rejeio: Evento no atende o Schema XML especfico Rejeio: NF-e vinculada inexistente Rejeio: NF-e no se encontra cancelada Rejeio: Destinatrio desconhece a operao Rejeio: Destinatrio devolveu a mercadoria Rejeio: data de saida/entrada anterior a data de autorizao da NF-e Rejeio: hora da sada/entrada anterior a hora da autorizao da NF-e Rejeio: NF-e autorizda h mais de 30 dias (720 horas)
OBS.: 1. Recomendamos a no utilizao de caracteres especiais ou acentuao nos textos das mensagens de erro. 2. Recomendamos que o campo xMotivo da mensagem de erro para o cdigo 999 seja informado com a mensagem de erro do aplicativo ou do sistema que gerou a exceo no prevista.
Pg. 34 / 34

Manual de Eventos NFe Draft

Enviado por

Dados do documento

Descrição original:

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Manual de Eventos NFe Draft

Enviado por

Direitos autorais:

Formatos disponíveis

Nota Fiscal eletrnica

Registro de Eventos da Nota Fiscal Eletrnica

Projeto Nota Fiscal Eletrnica

Registro de Eventos da Nota Fiscal Eletrnica

Verso 0.03 Agosto 2009

Nota Fiscal eletrnica

Nota Fiscal eletrnica

Identificao e vigncia do Manual

Verses de leiautes do PL_SRE_000

1.00 1.00 1.00 1.01

Schema XML envEvento_v1.00.xsd leiauteEvento_v1.00.xsd retEvento_v1.00.xsd xmldsig-core-schema_v1.01.xsd

A verso final do PL ser divulgada at a data de entrada em produo.

Nota Fiscal eletrnica

Nota Fiscal eletrnica

Nota Fiscal eletrnica

2. Modelo Operacional do Registro de Eventos da NF-e

Eventos de interesse da Nota Fiscal Eletrnica - NF-e

Nota Fiscal eletrnica

Eventos de interesse da Nota Fiscal Eletrnica

Nota Fiscal eletrnica

Fluxo dos eventos

NF-e, cancelamento, inutilizao, carta de correo, etc.

Trnsito, SUFRAMA, DETRAN, RFB, etc.

Registro de passagem, internalizao, licenciamento, embarque exportao, etc.

UF Origem/Destino, SUFRAMA, DETRAN e rgos interessados

Sincronizao e compartilhamento de eventos

Nota Fiscal eletrnica

Modelo genrico de Eventos

Nota Fiscal eletrnica

Nota Fiscal eletrnica

Nota Fiscal eletrnica

Nova Consulta Status da NF-e para suportar o modelo de eventos vinculados

Diagrama simplificado da Mensagem de Consulta

Nota Fiscal eletrnica

Diagrama simplificado da Mensagem de Retorno da Consulta

Nota Fiscal eletrnica

3. Arquitetura do Sistema de Registro de Eventos da NF-e

Padro de documento XML

Nota Fiscal eletrnica

Nota Fiscal eletrnica

Exemplo de uma mensagem de retorno padro SOAP:

Padro de Certificado Digital

Nota Fiscal eletrnica

Resumo dos Padres Tcnicos

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

Padro de mensagens dos Web Services

Padro de Mensagem de chamada/retorno de Web Service

Estrutura XML definida na documentao do Web Service

Elemento nfeCabecMsg (SOAP Header)

Informao de controle e rea de dados das mensagens

Validao da estrutura XML das Mensagens dos Web Services

Nota Fiscal eletrnica

Schemas XML das Mensagens dos Web Services

Nota Fiscal eletrnica

Verso dos Schemas

Liberao das verses dos Schemas para o WS de Registro de Eventos

Pacote de Liberao Preliminar

Pacote de Liberao de Homologao e Pacote de Liberao definitivo

Nota Fiscal eletrnica

Correo de Pacote de Liberao

Divulgao de novos Pacotes de Liberao

Nota Fiscal eletrnica

Nota Fiscal eletrnica