Manual de Integração

Manual de Integração Versão 3.10

Conteúdo 1 Obtendo e Instalando o Emissor... 4 1.1 Obtendo o instalador... 4 1.2 Instalando o JAVA e o Framework.NET 2.0... 4 1.3 Instalando o Emissor... 5 2 Padrões de Arquivos... 8 2.1 Arquivos de Notas... 8 2.2 Arquivo de Reimpressão de Notas... 8 2.2.1 Conteúdo do arquivo de reimpressão de NF-e... 8 2.3 Arquivos de Cancelamentos de Notas... 9 2.3.1 Conteúdo do arquivo de Cancelamentos de NF-e... 9 2.4 Arquivos de Inutilização de Notas...10 2.4.1 Conteúdo do arquivo de inutilização...10 2.5 Arquivos de Carta de Correção Eletrônica (CC-e)...10 2.5.1 Conteúdo do arquivo de CCe...10 2.6 Consulta Situação Nota Fiscal Eletrônica...11 2.6.1 Conteúdo do arquivo de Consulta da NF-e...12 2.7 Prévia...12 2.7.1 Conteúdo do arquivo de Prévia da NF-e...12 3 Padrão de Pastas (Diretórios)...14 3.1 Arquivos de Notas, Cancelamento e Inutilização...15 2

3.2 Arquivos XML...15 3.2.1 Assinadas...15 3.2.2 Autorizadas...15 3.3 Arquivos de Texto...16 3.3.1 Processados...16 3.4 Arquivos PDF...16 3.4.1 Notas...16 4 Utilização do Sistema...16 4.1 Validando, Assinando e Transmitindo Notas e Imprimindo DANFE 16 4.1.1 Retornos em caso de processo realizado com sucesso...17 4.1.2 Retornos em caso de erro ao realizar o processo...17 4.2 Processando notas com número específico...17 5 Informações Úteis...18 4.3 Retornos de Processamento da Sefaz (XML)...18 4.3.1 Motivos de Retorno...18 4.4 Retornos de Processamento da Sefaz (.txt)...19 4.4.1 Notas...19 4.4.2 Cancelamentos...20 4.4.3 Inutilização...20 4.4.4 Carta de Correção Eletrônica...21 4.4.5 Consulta Situação da NFe...22 4.4.6 Prévia e Reimpressão...22 4.5 Chamando o Emissor a partir do seu Sistema...23 4.6 Acessando a tela de Operações Diretamente pelo Sistema ERP..24 3

1 Obtendo e Instalando o Emissor 1.1 Obtendo o instalador Para realizar o download do emissor acesse o link a seguir: http:///site/downloads/nsnfe Caso você ainda não possua cadastro em nosso site, utilize o formulário a esquerda onde esta escrito Ainda não sou cadastrado!. Após inserir as informações e confirmar, será enviado um email de confirmação para o endereço de email informado no cadastro, contendo sua senha. Informe seu email e senha no formulário a esquerda e clique em acessar. Na próxima página, faça o download do arquivo Instalador NS-NFe. 1.2 Instalando o JAVA e o Framework.NET 2.0 O emissor possui como requisitos mínimos a instalação do Microsoft Framework.NET 2.0 e da Maquina Virtual Java (JVM). Para fazer o download e instalação desses itens, utilize os links abaixo e siga as instruções fornecidas na pagina: Microsoft Framework.NET 2.0: http://www.microsoft.com/downloads/details.aspx?displaylang=ptbr&familyid=0856eacb-4362-4b0d-8edd-aab15c5e04f5 JAVA (JVM): http://www.java.com/pt_br/ 4

1.3 Instalando o Emissor Avançar: A tela a seguir irá aparecer indicando o início da instalação, clique em Figura 1 - Início da Instalação do NS NF-e Nesta tela seguinte você poderá ler os termos do contrato da instalação. Clique em Eu aceito os termos de contrato e clique em Avançar. Figura 2 - Processo de Instalação do Emissor Na próxima tela, selecione o local onde deseja instalar o sistema. Este local será o diretório raiz do sistema. Depois de selecionar o local, clique em Avançar: 5

Figura 3 - Seleção do Diretório de Instalação do Emissor sistema. Obs.: É aconselhável que o emissor seja instalado dentro da pasta do seu Clique em Instalar na próxima tela: Figura 4 - Confirmação de Instalação do Emissor A próxima tela mostrará o processo de instalação: 6

Figura 5 - Processo de Instalação do Emissor 7

2 Padrões de Arquivos O sistema NS NF-e utiliza arquivos de texto simples (.txt) pra comunicação com o sistema ERP da empresa. 2.1 Arquivos de Notas Para carregamento de notas o sistema utiliza o mesmo layout do arquivo de exportação de notas do emissor gratuito de NF-e da SEFAZ de São Paulo. O layout deste arquivo pode ser encontrado no seguinte endereço: http://www.emissornfe.fazenda.sp.gov.br/v2/docs/%5bemissor_nfe%5d_manual_de_layout_txt-nf-e_v2.0.0.pdf O arquivo deve ser gerado dentro da pasta remessas (vide capitulo 3.1): 2.2 Arquivo de Reimpressão de Notas Os arquivos de reimpressão de notas do emissor NS NFe possuem um formato próprio de layout. Este arquivo deve ser gerado dentro da pasta remessas 2.2.1 Conteúdo do arquivo de reimpressão de NF-e O arquivo de reimpressão é composto duas linhas de registro. Cada campo de registro possui seus valores separados por pipe( ); A primeira linha é o cabeçalho do arquivo e terá sempre o valor padrão igual a REIMPRIME 1 ; A segunda linha possui os dados de reimpressão da nota e é composta dos seguintes valores: A + chave de acesso Abaixo um exemplo de como ficaria um arquivo de reimpressão de nota fictício: 8

2.3 Arquivos de Cancelamentos de Notas Os arquivos de cancelamento de notas do emissor NS NF-e possuem um formato próprio de arquivo. Este arquivo deve ser gerado dentro da pasta remessas. 2.3.1 Conteúdo do arquivo de Cancelamentos de NF-e O arquivo de cancelamento é composto cinco linhas de registro. Cada campo de registro possui seus valores separados por pipe( ); Abaixo um exemplo de como ficaria um arquivo de reimpressão de nota fictício: 9

2.4 Arquivos de Inutilização de Notas Os arquivos de inutilização de notas do emissor NS NF-e possuem um formato próprio de arquivo. Este arquivo deve ser gerado dentro da pasta remessas. 2.4.1 Conteúdo do arquivo de inutilização O arquivo de inutilização é composto de duas linhas de registros. Cada campo de registro possui seus valores separados por pipe ( ): A primeira linha é o cabeçalho do arquivo e terá sempre o valor padrão igual a INUTILIZA 1 ; A segunda linha possui os dados de inutilização das notas e é composta dos seguintes valores: A + cod. estado + num. Inicial + num. Final + CNPJ do emitente + serie + modelo + ano + motivo da inutilização Abaixo um exemplo de como ficaria um arquivo de inutilização de nota fictício: 2.5 Arquivos de Carta de Correção Eletrônica (CC-e) Os arquivos de carta de correção eletrônica de notas do emissor NS NF-e possuem um formato próprio de arquivo. Este arquivo deve ser gerado dentro da pasta remessas. 2.5.1 Conteúdo do arquivo de CCe O arquivo de CC-e é composto de quatro linhas de registros. Cada campo de registro possui seus valores separados por pipe ( ): 10

A primeira linha é o cabeçalho do arquivo e terá sempre o valor padrão igual a EVENTO 1 ; A segunda linha possui os dados de versão e definição do evento da NF-e com os seguintes valores: A + 1.00 + CCE A Terceira linha possui os dados de identificação da CC-e propriamente dita com os seguintes valores: B + cod. estado + ambiente + chave de acesso + data de emissão da cce + hora de emissão da cce + UTC + tipo de evento da nfe + Numero sequencial do evento A quarta linha possui os dados do emitente da cc-e com os seguintes valores: C02 + CNPJ do emitente da cce A quinta linha possui os dados da CC-e D + Descricao do Evento + Texto de Correção da NFe + Condição de Uso da CCe Abaixo um exemplo de como ficaria um arquivo de Carta de Correção Eletrônica: EVENTO 1 A 1.00 CCE B 43 2 43120507364617000135550010000274881000274884 2012-05-30 11:00:00-03:00 110110 6 C02 07364617000135 D Carta de Correcao ERRO NO COMPLEMENTO DO ENDERECO, AO INVES DE SALA 301 E SALA 304, ERRO DIVERSO DE OUTRO ERRO A Carta de Correcao e disciplinada pelo paragrafo 1o-A do art. 7o do Convenio S/N, de 15 de dezembro de 1970 e pode ser utilizada para regularizacao de erro ocorrido na emissao de documento fiscal, desde que o erro nao esteja relacionado com: I - as variaveis que determinam o valor do imposto tais como: base de calculo, aliquota, diferenca de preco, quantidade, valor da operacao ou da prestacao; II - a correcao de dados cadastrais que implique mudanca do remetente ou do destinatario; III - a data de emissao ou de saida. 2.6 Consulta Situação Nota Fiscal Eletrônica Os arquivos de consulta situação de nota fiscal eletrônica do emissor NS NFe possuem um formato próprio de arquivo. Este arquivo deve ser gerado dentro da pasta remessas. 11

2.6.1 Conteúdo do arquivo de Consulta da NF-e O arquivo de consulta da NF-e é composto de duas linhas de registros. Cada campo de registro possui seus valores separados por pipe ( ): A primeira linha é o cabeçalho do arquivo e terá sempre o valor padrão igual a CONSULTA 1 ; A segunda linha possui os dados para consulta da NFe, composto pelas seguintes informações: A + Chave da NFe + cod. estado + ambiente 2.7 Prévia Uma prévia serve para você visualizar a sua NF-e antes de enviá-la para a SEFAZ. 2.7.1 Conteúdo do arquivo de Prévia da NF-e Os arquivos de uma prévia de notas do emissor NS NF-e tem quase o mesmo formato de uma NF-e normal. Este arquivo deve ser gerado dentro da pasta remessas. Cada campo de registro possui seus valores separados por pipe ( ), sofrendo a modificação apenas no nome da nota, início e fim da NF-e. Exemplo: Nota Fiscal- 12

Prévia- 13

3 Padrão de Pastas (Diretórios) O emissor NS NF-e contém uma série de pastas que são instaladas junto com o sistema e que podem ser acessadas pelo sistema ERP da software house. Estas pastas ficam localizadas no diretório raiz do sistema (selecionado durante o processo de instalação). Cada pasta possui uma finalidade específica para o sistema conforme descrito abaixo: 14

3.1 Arquivos de Notas, Cancelamento e Inutilização Os arquivos de notas, cancelamento e inutilização, devem ser gerados dentro da pasta REMESSAS conforme o modelo descrito do capítulo 2. 3.2 Arquivos XML Sempre que o processamento de notas é realizado, o sistema guarda diversos arquivos XML referente às notas processadas. O sistema possui uma pasta específica para cada arquivo XML conforme descrito: 3.2.1 Assinadas 3.2.1.1 Enviar Esta pasta guarda os arquivos XML das notas que já foram carregadas pelo sistema, assinadas e estão aguardando serem enviadas para o sistema da Sefaz. 3.2.1.2 Enviadas Quando o sistema envia o arquivo XML de uma nota para a Sefaz, o arquivo XML é movido de a pasta Enviar para a pasta Enviadas. 3.2.2 Autorizadas Esta pasta contém os arquivos XML retornados pelo sistema da Sefaz referentes a cada nota enviada. Cada arquivo possui, no final de seus registros, as informações fornecidas pela Sefaz referente ao recebimento e processamento das notas. 15

3.3 Arquivos de Texto O sistema também guarda alguns arquivos de texto que podem conter informações importantes para uso do sistema ERP da Software House. 3.3.1 Processados Sempre que um arquivo de texto é lido dentro da pasta de arquivos de notas o sistema move automaticamente o arquivo para dentro desta pasta. Nestes arquivos é adicionado ao final de seus registros, uma linha contendo o registro RP que contém dados sobre o retorno de processamento da nota fornecido pela Sefaz. Para mais informações sobre esses dados, verifica o capítulo de informações úteis. 3.4 Arquivos PDF 3.4.1 Notas Sempre que uma nota é processsada com sucesso e a mesma é impressa, o sistema gera na pasta Notas o PDF referente àquela nota processada, o padrão de nome deste arquivo é a chave de acesso da nota fiscal com a extensão pdf. 4 Utilização do Sistema 4.1 Validando, Assinando e Transmitindo Notas e Imprimindo DANFE O sistema realiza as funções de validação, assinatura e transmissão de notas e impressão de DANFE toda a vez que é executado e encontra um arquivo de notas na pasta padrão de notas (vide capítulo 3). Os passos necessários podem ser descritos então na seguinte ordem: Gerar o arquivo de notas dentro da pasta padrão de notas Executar o NFe.exe 16

4.1.1 Retornos em caso de processo realizado com sucesso Em caso de sucesso no processo de transmissão de notas o sistema exibe na tela o DANFE para impressão. 4.1.2 Retornos em caso de erro ao realizar o processo Quando ocorrer algum erro durante o processo de transmissão de notas o sistema automaticamente encerra o processo e exibe em tela a mensagem informando o respectivo erro. O sistema aguarda que o usuário leia e confirme a mensagem. O sistema fica aberto aguardando que o erro seja resolvido e que a nota seja exportada para a pasta padrão de notas novamente para recomeçar o processo. 4.2 Processando notas com número específico É possível dizer ao emissor que ele deve processar uma nota especifica disponível dentro da pasta padrão de notas. Para isso, basta que você passe o número da nota deseja como parâmetro na chamada do sistema. Este recurso é muito importante para sistemas que emitem notas em diversas estações, pois neste caso, duas máquinas podem gerar e lançar notas ao mesmo tempo dentro da pasta do emissor, mas cada máquina deve processar a nota que gerou. Exemplos de como chamar o emissor passando uma nota específica como parâmetro: Para processar somente a nota número 1 (arquivo: 00001.txt) : Visual Basic 6: Shell ( C:\NSNFe\NFe.exe 1 ) Java Process p = Runtime.getRuntime().exec("C:\\NSNFe\\NFe.exe 1"); 17

Delphi WinExec ('C:\NSNFe\NFe.exe 1', 1); VB.NET Dim p as Process = new Process() p.startinfo.filename = C:\NSNFe\NFe.exe p.startinfo.arguments = "1" p.start(); p.waitforexit() 5 Informações Úteis 4.3 Retornos de Processamento da Sefaz (XML) Os arquivos XML contidos dentro da pasta de arquivos autorizados (vide capítulo 3.2.2) possuem algumas informações que são fornecidas pelo sistema da Sefaz. Este capítulo descreve algumas dessas informações que podem ser de utilizadas pela Software House. 4.3.1 Motivos de Retorno Uma das informações mais úteis fornecidas pelo sistema da Sefaz é o motivo de retorno da nota. O campo que contém este valor é o campo <xmotivo>. Dentro dos motivos de retorno os mais comuns são: Autorizado Uso da NF-e: quando a nota é recebida pela Sefaz e a impressão do DANFE é autorizada; Rejeição: este motivo virá sempre seguido do motivo pelo qual a nota foi rejeitada. Exemplo: se o motivo for Rejeição: Duplicidade de NF-e, significa que a nota foi rejeitada, pois já estava no banco de dados da Sefaz quando foi enviada. 18

Obs.: Sempre que ocorrer alguma rejeição o sistema mostrará uma mensagem informando que a nota foi rejeitada e o motivo do mesmo. 4.4 Retornos de Processamento da Sefaz (.txt) O emissor NS NF-e também guarda algumas informações de retorno da Sefaz nos arquivos de texto referentes às notas processadas. 4.4.1 Notas Os arquivos.txt de notas contidos dentro da pasta de notas processadas possuem no final de seus registros, o registro RP que contém as seguinte informações de retorno: RP + protocolo de autorização + digest value + cod. Retorno + descrição do retorno + chave de acesso + Serie + Numero da Nota Fiscal + Data e hora da autorização Cada campo é separado dentro do registro pelo caracter pipe ( ). Ex.: para o registro RP: RP 143120002060179 QggaZu/qFPsZJYtvM8ZQR20E7/w= 100 Autorizado o uso da NF-e NFe43120607364617000135550000000007031000007034 0 703 2014-11-04T09:03:29-02:00 Os valores obtidos seriam: Protocolo de autorização: 143120002060179 Digest Value: QggaZu/qFPsZJYtvM8ZQR20E7/w= Código do Retorno: 100 Descrição do Retorno: Autorizado o uso da NF-e Chave de Acesso: NFe43120607364617000135550000000007031000007034 Serie da NFe: 0 Numero da NFe: 703 Data e hora da Autorização: 2014-11-04T09:03:29-02:00 19

4.4.2 Cancelamentos Os arquivos de cancelamento de notas que ficam armazenados dentro da pasta de arquivos processados também possuem as informações de retorno de processamento. O registro RP neste caso possui o seguinte layout: RP + protocolo de autorização + cod. Retorno + descrição do retorno + chave de acesso + Chave do Evento + Data e hora da autorização Cada campo é separado dentro do arquivo pelo caracter pipe ( ). Ex.: Para o registro RP: RP 143140001924263 135 Evento registrado e vinculado a NFe 43141007364617000135550000000077051000077050 11011143141007364617000135 55000000007705100007705001 2014-10-28T10:10:23-02:00 Os valores obtidos seriam Protocolo de autorização: 143140001924263 Código do Retorno: 135 Descrição do Retorno: Evento registrado e vinculado a NF-e Chave de Acesso: 43141007364617000135550000000077051000077050 Chave do Evento: 1101114314100736461700013555000000007705100007705001 Data e hora da Autorização: 2014-10-28T10:10:23-02:00 4.4.3 Inutilização Os arquivos de inutilização de notas que ficam armazenados dentro da pasta de arquivos de inutilização também possuem as informações de retorno de processamento. O registro RP neste caso possui o seguinte layout: 20

RP + protocolo de autorização + cod. Retorno + descrição do retorno + chave de acesso + Chave do Evento + Data e hora da autorização Cada campo é separado dentro do arquivo pelo caracter pipe ( ). Ex.: Para o registro RP: RP 143140001924263 135 Evento registrado e vinculado a NFe 43141007364617000135550000000077051000077050 11011143141007364617000135 55000000007705100007705001 2014-10-28T10:10:23-02:00 Os valores obtidos seriam Protocolo de autorização: 143140001924263 Código do Retorno: 135 Descrição do Retorno: Evento registrado e vinculado a NF-e Chave de Acesso: 43141007364617000135550000000077051000077050 Chave do Evento: 1101114314100736461700013555000000007705100007705001 Data e hora da Autorização: 2014-10-28T10:10:23-02:00Obs.: No momento em que o emissor recebe o retorno de processamento da Sefaz, na inutilização de notas, é salvo, dentro da pasta Inutilização, um arquivo xml contendo todos os dados de solicitação de inutilização e logo abaixo retorno do processamento. 4.4.4 Carta de Correção Eletrônica Os arquivos de CC-e de notas que ficam armazenados dentro da pasta processados também possuem as informações de retorno de processamento. O registro RP neste caso possui o seguinte layout: RP + protocolo de autorização + cod. Retorno + descrição do retorno + chave de acesso + Chave do Evento + Data e hora da autorização Cada campo é separado dentro do arquivo pelo caracter pipe ( ). Ex.: Para o registro RP: 21

RP 143140001924263 135 Evento registrado e vinculado a NFe 43141007364617000135550000000077051000077050 11011143141007364617000135 55000000007705100007705001 2014-10-28T10:10:23-02:00 Os valores obtidos seriam Protocolo de autorização: 143140001924263 Código do Retorno: 135 Descrição do Retorno: Evento registrado e vinculado a NF-e Chave de Acesso: 43141007364617000135550000000077051000077050 Chave do Evento: 1101114314100736461700013555000000007705100007705001 Data e hora da Autorização: 2014-10-28T10:10:23-02:00Obs.: No momento em que o emissor recebe o retorno de processamento da Sefaz, na CCe, é salvo, dentro da pasta CCe, um arquivo xml contendo todos os dados de solicitação de inutilização e logo abaixo retorno do processamento. 4.4.5 Consulta Situação da NFe Os arquivos de Consulta de Situação da NFe que ficam armazenados dentro da pasta processados também possuem as informações de retorno de processamento. O registro RP neste caso possui o seguinte layout: RP + protocolo de autorização + cod. Retorno + descrição do retorno + chave de acesso + Chave do Evento + Data e hora da autorização Cada campo é separado dentro do arquivo pelo caracter pipe ( ). Ex.: Para o registro RP: RP 143140001924263 135 Evento registrado e vinculado a NFe 43141007364617000135550000000077051000077050 11011143141007364617000135 55000000007705100007705001 2014-10-28T10:10:23-02:00 Os valores obtidos seriam 22

Protocolo de autorização: 143140001924263 Código do Retorno: 135 Descrição do Retorno: Evento registrado e vinculado a NF-e Chave de Acesso: 43141007364617000135550000000077051000077050 Chave do Evento: 1101114314100736461700013555000000007705100007705001 4.4.6 Data e hora da Autorização: 2014-10-28T10:10:23-02:00Prévia e Reimpressão Os arquivos de Prévia e Reimpressão de notas que ficam armazenados dentro da pasta processados não possuem as informações de retorno de processamento. 4.5 Chamando o Emissor a partir do seu Sistema O emissor pode ser integrado com qualquer sistema em ambiente Windows, independente da linguagem em que foi desenvolvido. Abaixo segue alguns exemplos de como chamar o executável do emissor diretamente pelo sistema ERP: Visual Basic 6: Shell ( C:\NSNFe\OperacoesNFe.exe ) Java Process p = Runtime.getRuntime().exec("C:\\NSNFe\\OperacoesNFe.exe"); Delphi WinExec ('C:\NSNFe\OperacoesNFe.exe', 1); VB.NET Dim p as Process = new Process() p.startinfo.filename = C:\NSNFe\NFe.exe p.start(); 23

4.6 Acessando a tela de Operações Diretamente pelo Sistema ERP A tela de operações possui um arquivo executável próprio que pode ser aberto diretamente através do sistema ERP da sofware house e que dá acesso as funções de reimpressão, cancelamento e inutilização de notas. Este arquivo encontra-se na pasta raiz do sistema com o nome o nome de OperacoesNFe.exe. Sempre que aberto, este executável carrega a lista a lista de todas as notas que foram emitidas através do emissor NS NF-e. Exemplo de execução do arquivo (levando em conta que o sistema tenha sido instalado no diretório C:\NSNFe): Visual Basic 6 e VB.NET: Shell ( C:\NSNFe\OperacoesNFe.exe ) Java Process p = Runtime.getRuntime().exec("C:\\NSNFe\\OperacoesNFe.exe"); Delphi WinExec ('C:\NSNFe\OperacoesNFe.exe', 1); VB.NET Dim p as Process = new Process() p.startinfo.filename = C:\NSNFe\OperacoesNFe.exe p.start(); 24