Layout da CC-e

Última atualização em: 10 de julho, 2014

 

Olá! Este artigo tem por objetivo disponibilizar o layout da CC-e. Aqui você irá encontrar a estrutura completa de campos da Carta de Correção Eletrônica, para realizar a integração de seu ERP com o InvoiCy.

A tabela abaixo deve ser utilizada como legenda para interpretação dos campos do arquivo de envio e retorno do XML.

Coluna

Nome do Campo

Tipo

(tamanho)

N – campo numéricoC – campo alfanuméricoD – campo dataH – campo hora

Ele

G – GrupoE – ElementoCG – Elemento de Grupo que deriva de uma escolha (choice)CE – Elemento que deriva de uma escolha (choice)

Pai

TAG raiz do XML de integração entre ERP e GNF-e

Ocorrência

x-y, onde x indica a ocorrência mínima e y, a ocorrência máxima:

1-1  = campo obrigatório, com uma possibilidade,

1-N = campo obrigatório, com uma ou várias possibilidades,

0-1  = campo opcional, com uma possibilidade,

0-N = campo opcional, com uma ou várias possibilidades.

Este layout encontra-se adequado com a Nota Técnica NT2013.005, disponibilizado pela SEFAZ (Secretaria da Fazenda). A íntegra desta NT pode ser consultada clicando aqui.

O layout da CC-e está disponível para download em arquivo XLS. Para visualizá-lo, certifique-se de que você possui o Microsoft Excel instalado em seu computador.

DOWNLOAD:

LAYOUT CC-e

Acesse também a Central de Downloads Migrate, onde você poderá encontrar diversos exemplos reais de Carta de Correção Eletrônica para download.

Artigos Relacionados:

Enviando uma NF-e ou NFC-e

Última atualização em: 29 de abril, 2016

 

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 3.10 da NF-e e também da NFC-e. Para obter esse Layout consulte o artigo “Layout 3.10”. 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 3.10.

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:

 

Integrando com o módulo NF-e

Última atualização em: 26 de março, 2015

 

Olá! Neste artigo vamos lhe auxiliar a realizar a integração de seu ERP com o módulo NF-e do InvoiCy. Pronto para iniciar? Vamos lá!

A integração de seu ERP com o módulo NF-e deve ser realizada através de Web Service disponibilizado pelo InvoiCy. Trata-se do WS arecepcao.aspx. Este Web Service é único, e deve ser utilizado para qualquer integração com o InvoiCy, independente do tipo de documento a ser enviado. Abaixo, detalhamos o processo de integração com o módulo NF-e.

Para realizar a integração, realize os seguintes passos:

1.      Visualize a estrutura WSDL do Web Service
Para visualizar a estrutura WSDL do Web Service, basta copiar e colar o link do Web Service em seu navegador de internet, por exemplo https://homolog.invoicy.com.br/arecepcao.aspx?wsdl. Assim podemos visualizar toda a estrutura do WSDL, conforme demonstra a imagem abaixo:

2.      Realize o consumo do Web Service
Você deverá realizar o consumo do Web Service para realizar a integração. Ao realizar a consumo do WS, você deverá informar os seguintes parâmetros:

  • EmpPK: Chave de Parceiro disponibilizada pela Migrate para cada cliente.
    Exemplo: PYcEsFuKroDBojfiFEl+Ms==

A chave de parceiro é gerada por nosso Sistema de Gestão no momento que a sua empresa é cadastrada como nosso parceiro. A mesma será enviada por e-mail e utilizada para controlar as empresas de clientes finais que utilizarão licenças adquiridas pela sua empresa.

  • EmpCK: Código HASH gerado em formato MD5 de acordo com dados enviados.
    Exemplo: 213f3b55d679e790258fd811cc86d309

Utilizado para validar a comunicação e propor segurança à comunicação. Consulte o artigo “Como gerar o código Hash MD5?” para mais informações.

  • EmpCO: Identificador do PDV.
  • Texto: Uso interno do InvoiCy. Não é necessário o preenchimento.
  • Documento: Conteúdo do documento Fiscal a ser enviado para o InvoiCy.
  • Parâmetros: Neste campo podem ser informados alguns parâmetros, como por exemplo, quais dados deseja que retorne na consulta de documentos. Seu preenchimento não é obrigatório.

Dentro da TAG <inv:Documento>, você deverá informar o conteúdo XML da NF-e, contendo a estrutura de campos do layout 3.10 da NF-e. Os campos da NF-e devem ser convertidos para texto.

Obs: Caso deseje enviar mais de um documento, deve-se repetir a TAG <inv:DadosItem>, contendo o conteúdo dos documentos a serem enviados.

Para facilitar seu entendimento, disponibilizamos para você o download de um exemplo completo de consumo do WS de recepção.

Clique aqui, e realize o download do documento.

Para obter o Layout atualizado da NF-e consulte o artigo “Layout 3.10”. Nele você encontra a estrutura completa do arquivo XML da NF-e para gerar o documento a ser enviado ao InvoiCy.

3.      Realize a leitura do retorno do envio da NF-e
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á codificado em “CDATA” e retornará dentro da TAG <Documento> do SOAP de retorno.

Para facilitar seu entendimento, anexamos um documento completo a este artigo.

Clique aqui, e realize o download do arquivo SOAP de retorno.

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á realizou sua integração, podemos dar prosseguimento ao próximo passo.

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

Artigos Relacionados:

Como funciona o InvoiCy?

 

Ansioso por dar início ao desenvolvimento da integração? Antes disso, leia este artigo e fique por dentro de como funciona a Plataforma InvoiCy!

O Sistema InvoiCy constitui-se de uma aplicação inteiramente WEB, formada por módulos, onde cada módulo constitui um produto. Desta forma, o Sistema permite a centralização de todos os produtos disponibilizados pela Migrate, tornando seu gerenciamento fácil e a manutenibilidade mais eficiente e segura, além da rapidez de integração de seu ERP e velocidade de processamento das informações recebidas.

Como funciona o envio de um documento através do InvoiCy?

  1. De maneira simplificada, a empresa emissora do documento fiscal gera um arquivo eletrônico contendo as informações fiscais da operação comercial, o qual deve ser assinado digitalmente de maneira a garantir a integridade dos dados e a autoria do emissor. Este documento nada mais é do que um arquivo XML, contendo todas as informações do documento.
  2. Este arquivo eletrônico é então transmitido através de Web Services disponibilizados pelo InvoiCy, que por sua vez os recebe e realiza o tratamento necessário, para só então enviá-lo para a Secretaria da Fazenda Estadual de jurisdição do contribuinte emitente, que faz uma pré-validação dos dados e devolve uma Autorização de Uso, sem o qual não pode haver o trânsito da mercadoria.
  3. Após o recebimento do documento, a Secretaria da Fazenda Estadual disponibiliza a consulta através da Internet para o destinatário e outros legítimos interessados que detenham a chave de acesso do documento eletrônico.
  4. Este mesmo arquivo é ainda transmitido pela Secretaria da Fazenda Estadual para a Receita Federal, que é um repositório nacional de todas os documentos emitidos, e no caso de uma operação interestadual, para a Secretaria da Fazenda Estadual de destino da operação.

Simples, não é mesmo?  Agora que você já tem o entendimento da Plataforma, vamos dar início a integração?

Seu próximo passo é: Integrando com o módulo NF-e

LAYOUT XML 4.00

Última atualização em: 12 de setembro, 2017

 

Olá! Este artigo tem por objetivo disponibilizar o layout 4.00 do XML da NF-e e da NFC-e. Aqui você irá encontrar a estrutura completa de campos para realizar a integração de seu ERP com o InvoiCy.

A tabela abaixo deve ser utilizada como legenda para interpretação dos campos do arquivo do envio e retorno do XML.

Coluna

Nome do Campo

Tipo

(tamanho)

N – campo numérico C – campo alfanumérico D – campo data H – campo hora

Ele

G – Grupo E – Elemento CG – Elemento de Grupo que deriva de uma escolha (choice) CE – Elemento que deriva de uma escolha (choice)

Pai

TAG raiz do XML de integração entre ERP e GNF-e

Ocorrência

x-y, onde x indica a ocorrência mínima e y, a ocorrência máxima:

1-1  = campo obrigatório, com uma possibilidade,

1-N = campo obrigatório, com uma ou várias possibilidades,

0-1  = campo opcional, com uma possibilidade,

0-N = campo opcional, com uma ou várias possibilidades.

Este layout encontra-se adequado com a Nota Técnica NT2016.002, disponibilizado pela SEFAZ (Secretaria da Fazenda). A íntegra desta NT pode ser consultada clicando aqui.

O layout 4.00 do XML está disponível para download em arquivo XLS. Para visualizá-lo, certifique-se de que você possui o Microsoft Excel instalado em seu computador.

DOWNLOAD:

LAYOUT XML 4.00 (NF-e e NFC-e)

Acesse também a Central de Downloads Migrate, onde você poderá encontrar diversos exemplos reais de NF-e e NFC-e para download.