Envio de Eventos

Última atualização em: 17 de novembro, 2016

 

Vamos trabalhar agora com a emissão de eventos da NF-e.

A emissão dos eventos ocorre através do mesmo Web Service de envio de NF-e. Os eventos da NF-e compreendem: Cancelamento, Carta de Correção Eletrônica e as Manifestações do Destinatário (confirmação, ciência, desconhecimento e não realização da operação).

Um evento é um registro de um fato que ocorreu com a NF-e após sua autorização de uso, pode ser emitido pelo contribuinte ou pelo Fisco. Os eventos podem ou não modificar a situação do documento, por exemplo, evento de cancelamento.

Para todos os eventos, a geração do XML segue a mesma estrutura, mudando apenas as tags específicas para cada tipo de evento. Clique aqui para realizar o download do manual de geração do XML de eventos.

Disponibilizamos também um arquivo de esquema XML, que poderá ser utilizado para auxiliar na geração do XML. É recomendável que o XML gerado seja validado contra o esquema antes de ser enviado ao InvoiCy. Clique para fazer o download do arquivo de esquema.

Proceda com os seguintes passos para enviar eventos:

1.      Envie uma nova NF-e
Você pode enviar uma nova NF-e ao InvoiCy, ou obter uma NF-e já autorizada anteriormente para o teste de eventos. A NF-e utilizada para a emissão de eventos deve estar autorizada. Não é permitido qualquer outro status para envio de eventos.

2.      Gere a estrutura do arquivo XML do evento desejado
Você deverá gerar a estrutura do XML de acordo com o evento desejado, seguindo o layout de eventos.

Nós disponibilizamos para você um exemplo da estrutura do arquivo de cancelamento para facilitar seu entendimento. Clique aqui, para realizar o download.

3.      Consuma o Web Service de envio de documentos do InvoiCy
Após gerar o layout do XML do evento, basta realizar o consumo do WS de integração do InvoiCy, conforme já descrito no artigo “Integrando com o módulo NF-e”.

Para facilitar o seu entendimento, anexamos a este artigo um exemplo completo de cancelamento de uma NF-e através do WS de integração do InvoiCy. Clique aqui, e realize o download do documento.

4.      Obtenha o retorno do envio do evento
Ao realizar o consumo do Web Service do InvoiCy, no retorno será possível identificar se a operação for realizada com sucesso.

O layout de retorno do Web Service para eventos, é o mesmo retornado no momento da emissão da NF-e. Para os eventos, estarão preenchidas as tags específicas no retorno, como o EveTp e EveId, como mostra a imagem abaixo.

Artigos Relacionados:

Enviando uma NF-e ou NFC-e

Última atualização em: 11 de maio, 2018

 

Neste momento iremos explicar como realizar a emissão de uma NF-e ou NFC-e integrando com o InvoiCy.

A partir de agora assumimos que você já leu o artigo “Integrando com o módulo NF-e”. Caso ainda não tenha lido o artigo, recomendamos que realize a leitura do mesmo, para facilitar o entendimento deste artigo.

O envio de um documento é muito simples. Para que isso se torne possível siga os seguintes passos:

1.      Consumindo o Web Service
Primeiramente, você deve realizar o consumo do Web Service de envio de documentos do InvoiCy, conforme o artigo “Integrando com o módulo NF-e”.

2.      Gerando o documento na estrutura correta
O InvoiCy permite o envio de documentos no layout 4.00 da NF-e e também da NFC-e. Para obter esse Layout consulte o artigo “Layout 4.00”. Nele você encontra a estrutura completa do arquivo XML para gerar o documento a ser enviado ao InvoiCy.

O XML do documento deve ser convertido para texto, e inserido entre as TAGS <inv:Documento> </inv:Documento> do SOAP de envio. Veja abaixo um exemplo:

Nos casos em que for usada uma ferramenta RAD para consumo do Web Service através de componente nativo, por exemplo Visual Studio utilizando Web Reference, a conversão do XML para texto irá ocorrer de forma automática. Para os casos em que o desenvolvedor preferir codificar toda a comunicação sem utilizar componentes, além de ser necessário escrever todo o XML do SOAP, também deverá ser feita a conversão do XML do documento para texto, substituindo os caracteres “<” e “>” por “&lt;” e “&gt;” respectivamente, de acordo com a tabela da W3C: http://www.w3schools.com/html/html_entities.asp.

Para facilitar o seu entendimento anexamos a este artigo um exemplo de arquivo XML no layout da NF-e.

Clique aqui, para realizar o download do exemplo de Envio de NF-e.

Para facilitar a geração do XML de integração, disponibilizamos um arquivo de esquema XSD que poderá servir como base. É recomendável que após a geração do arquivo XML e antes do consumo do Web Service, o mesmo seja validado contra o arquivo de esquema. OBS: O arquivo de esquema corresponde a versão 4.00.

Clique aqui, para realizar o download do arquivo de esquema XSD.

3.      Realize a leitura do retorno do envio
Após o envio da NF-e, precisamos realizar a leitura do retorno do processamento do documento. O retorno recebido segue a seguinte estrutura SOAP:

A estrutura SOAP acima demonstra o retorno do envio de apenas um único documento.

Note que na TAG <Documento> é retornado o conteúdo XML do retorno, codificado em “CDATA”. Este conteúdo pode ser lido pelo ERP para atualização do Status do documento.

Abaixo demonstramos a estrutura do XML de retorno:

Todo o conteúdo acima estará inserido em uma tag “CDATA” e retornará dentro da TAG <Documento> do SOAP de retorno.

Para facilitar seu entendimento, anexamos um exemplo do XML do retorno. Clique aqui, e realize o download.

Existe ainda uma tabela de códigos e descrições dos retornos da SEFAZ, que você pode consultar no artigo “Códigos de Retorno da SEFAZ”.

Agora que você já está familiarizado com a integração, podemos prosseguir ao próximo passo.

Seu próximo passo é:  Cancelando uma NF-e ou NFC-e

Artigos Relacionados: