Manual de Integração. Versão 1.0.2

Transcrição

1 Manual de Integração Versão 1.0.2

2 Sumário 1 Obtendo e Instalando o Emissor Obtendo o instalador Instalando o JAVA e o Framework.NET Instalando o Emissor Padrões de Arquivos Arquivos de Notas Impressão de Notas Comando de impressão via txt: Arquivo de Reimpressão de Notas Conteúdo do arquivo de reimpressão de NFC-e Arquivos de Cancelamentos de Notas Conteúdo do arquivo de cancelamento Arquivos de Inutilização de Notas Conteúdo do arquivo de inutilização Consulta Situação Nota Fiscal Eletrônica Conteúdo do arquivo de Consulta da NFC-e Padrão de Pastas (Diretórios) Utilização do Sistema Retornos em caso de processo realizado com sucesso Retornos em caso de erro ao realizar o processo Informações Úteis Retornos de Processamento da Sefaz (XML) Motivos de Retorno Retornos de Processamento da Sefaz (.txt) Notas Cancelamentos Inutilização Consulta Situação da NFCe Chamando o Emissor a partir do seu Sistema Acessando a tela de Operações Diretamente pelo Sistema ERP

3 1 Obtendo e Instalando o Emissor 1.1 Obtendo o instalador Para realizar o download do emissor você precisa realizar o cadastro de parceiro, em: após acessar este link, realizar o login para ter acesso ao download do instalador da ferramenta neste link: 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 página: Microsoft Framework.NET 2.0: eacb b0d-8edd-aab15c5e04f5 JAVA (JVM): Instalando o Emissor A tela a seguir irá aparecer indicando o início da instalação, clique em Avançar: 3

4 Avançar. Figura 1 - Início da Instalação do NS NF-e Próxima tela é os ternos de contrato! Marque a opção de Aceitar e clique em Figura 2 Termos de Contrato 4

5 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: 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 Próxima tela é aparecerá a confirmação do local da instalação. Clique em Instalar nesta tela: 5

6 Figura 4 - Confirmação de Instalação do Emissor A próxima tela mostrará o processo de instalação: Figura 5 - Processo de Instalação do Emissor Nesta Próxima tela é muito importante ressaltar que a opção Executar NFCe.exe esteja marcada para que na sequência já abra a tela de configuração do NS NFCe: 6

7 Figura 6 Conclusão do Processo de Instalação do Emissor 2 Padrões de Arquivos O sistema NS NFC-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 NFC-e da SEFAZ de São Paulo. O layout deste arquivo pode ser encontrado no seguinte endereço: 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 Impressão de Notas A impressão da NFCe pode ser feita de três formas diferentes: 1 Impressão via Modo Spooler: Descrição na página 10 do manual de Utilização. 7

8 2- Impressão via DLL: Descrição na página 10 do manual de Utilização Impressão via Comando do txt: Comando de impressão via txt: O comando de impressão via txt é informado na última linha do arquivo de emissão da NFCe que é composto por quatro campos. Cada campo de registro possui seus valores separados por pipe ( ); O primeiro campo é o comando que sempre terá o valor igual: IMPRESSAO; O segundo campo é o caminho completo da impressora; O terceiro campo é o número de cópias que deve ser impresso; O quarto campo é o tipo de impressão que pode ser: 0 - Impressão completa; 1 - impressão Ecológica; 2- sem impressão. Abaixo um exemplo de como ficaria um arquivo de impressão de nota fictício: 2.3 Arquivo de Reimpressão de Notas Os arquivos de reimpressão de notas do emissor NS NFCe possuem um formato próprio de layout. Este arquivo deve ser gerado dentro da pasta remessas 8

9 2.3.1 Conteúdo do arquivo de reimpressão de NFC-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: REIMPRIME 1 A Arquivos de Cancelamentos de Notas Os arquivos de cancelamento de notas do emissor NS NFC-e possuem um formato próprio de arquivo. Este arquivo deve ser gerado dentro da pasta remessas Conteúdo do arquivo de cancelamento O layout do arquivo de cancelamento pode ser obtido pelo Manual do Arquivo de Emissão do Evento de Cancelamento através do link: 0Cancelamento.pdf 9

10 2.5 Arquivos de Inutilização de Notas Os arquivos de inutilização de notas do emissor NS NFC-e possuem um formato próprio de arquivo. Este arquivo deve ser gerado dentro da pasta remessas 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: INUTILIZA 1 A TESTE DE INUTILIZACAO DE NOTA 10

11 2.6 Consulta Situação Nota Fiscal Eletrônica Os arquivos de consulta situação de nota fiscal eletrônica do emissor NS NFC-e possuem um formato próprio de arquivo. Este arquivo deve ser gerado dentro da pasta remessas Conteúdo do arquivo de Consulta da NFC-e O arquivo de consulta da NFC-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 NFCe, composto pelas seguintes informações: A Padrão de Pastas (Diretórios) O emissor NS NFC-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 e, não devem ser excluídas/alteradas, pois comprometerão a integridade dos dados fornecidos pelo NS NFC-e. O sistema ERP da Software House irá trabalhar apenas com as pastas Remessas onde é informado o Arquivo TXT ou Arquivo XML para processamento e a pasta Processados onde o NS NFC-e deixa o Arquivo TXT com os dados de Retorno de Processamento da nota emitida. 11

12 As demais pastas do sistema são: Assinadas: São guardados os XML das notas assinadas; Atualizador: Pasta que o NS NFC-e utiliza para realizar a atualização automática do sistema; Autorizadas: São guardados os XML das notas autorizadas; Cancelamentos: Enviados: XML de Cancelamentos enviados para a Sefaz; Enviar: XML de Cancelamentos aguardando envio para Sefaz; Consultas: Uso interno do Sistema. Eventos: Cancelamento: XML de Evento de Cancelamento; 12

13 *PDF: PDF de Evento de Cancelamento; Imprimir: Pasta utilizada pelo NS NFC-e para impressões, onde pode ser colocado o logo.jpg nas medidas de 180x150pixels para exibição no Danfe; Inutilizadas: XML de Inutilizadas; listanotas: Uso interno do sistema. Notas: São armazenados os PDF das notas emitidas, o Arquivo sempre será com a nomenclatura CHAVEDEACESSO.PDF; nscompact: Uso interno do sistema. Processados: Pasta de acesso do ERP da Software House para acesso ao Retorno de Processamento da Nota Emitida; Remessas: Pasta para processamento do Arquivo TXT ou XML gerado pelo ERP da Software House; Retornos: Uso interno do Sistema. Schemas: Schemas XML de validação da Sefaz, de uso interno do sistema. ws: Uso interno do sistema. 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 NFCe.exe 13

14 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, caso configurado para ser exibido 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. 5 Informações Úteis 4.2 Retornos de Processamento da Sefaz (XML) Os arquivos XML contidos dentro da pasta de arquivos autorizados 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 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 NFC-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 14

15 de NFC-e, significa que a nota foi rejeitada, pois já estava no banco de dados da Sefaz quando foi enviada. Obs.: Sempre que ocorrer alguma rejeição o sistema mostrará uma mensagem informando que a nota foi rejeitada e o motivo do mesmo. 4.3 Retornos de Processamento da Sefaz (.txt) O emissor NS NFC-e também guarda algumas informações de retorno da Sefaz nos arquivos de texto referentes às notas processadas 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 Cada campo é separado dentro do registro pelo caracter pipe ( ). Ex.: para o registro RP: RP QggaZu/qFPsZJYtvM8ZQR20E7/w= 100 Autorizado o uso da NFC- e NFCe T11:35:27-02:00 Os valores obtidos seriam: Protocolo de autorização: Digest Value: QggaZu/qFPsZJYtvM8ZQR20E7/w= Código do Retorno: 100 Descrição do Retorno: Autorizado o uso da NF-e Chave de Acesso: NFe Serie da NFCe: 0 Numero da NFCe: 703 Data e Hora de autorização: T11:35:27-02:00 Link do QRCode(somente NFC-e): 15

16 Obs.: Além dos campos mostrados no exemplo é possível existir outro campo contendo a chave de acesso adicional utilizada em casos de rejeição por duplicidade de notas emitidas em contingência. Saiba mais em 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 + codigo retorno processamento do cancelamento + descricao do processamento do cancelamento Cada campo é separado dentro do arquivo pelo caracter pipe ( ). Ex.: Para o registro RP: RP 101 Cancelamento de NF-e homologado Os valores obtidos seriam Cod. Retorno de Processamento: 101 Descrição de Retorno de Processamento: Cancelamento de NFC-e homologado 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: RP + cód. processamento + mensagem processamento + data e hora recebimento da solicitação de processamento + protocolo de processamento 16

17 Cada campo é separado dentro do arquivo pelo caracter pipe ( ). Ex.: Para o registro RP: RP 102 Inutilizacao de numero homologado T18:09: Os valores obtidos seriam Cod. Retorno de Processamento:102 Mensagem de Processamento: Inutilização de Numero Homologado Data e Hora do Recebimento : t18:09:47 Protocolo de Processamento: Obs.: 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 Consulta Situação da NFCe Os arquivos de Consulta de Situação da NFCe 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 + digest value + cod. Retorno + descrição do retorno + chave de acesso + Serie + Numero da Nota Fiscal Cada campo é separado dentro do registro pelo caracter pipe ( ). Ex.: para o registro RP: RP QggaZu/qFPsZJYtvM8ZQR20E7/w= 100 Autorizado o uso da NFC-e NFCe Os valores obtidos seriam: Protocolo de autorização:

18 Digest Value: QggaZu/qFPsZJYtvM8ZQR20E7/w= Código do Retorno: 100 Descrição do Retorno: Autorizado o uso da NF-e Chave de Acesso: NFCe Serie da NFCe: 0 Numero da NFCe: 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: Java Delphi VB.NET Shell ( C:\NSNFCe\OperacoesNFCe.exe ) Process p = Runtime.getRuntime().exec("C:\\NSNFCe\\OperacoesNFCe.exe"); WinExec ('C:\NSNFCe\OperacoesNFCe.exe', 1); Dim p as Process = new Process() p.startinfo.filename = C:\NSNFCe\NFCe.exe p.start(); 4.5 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 OperacoesNFCe.exe. 18

19 Sempre que aberto, este executável carrega a lista a lista de todas as notas que foram emitidas através do emissor NS NFC-e. Exemplo de execução do arquivo (levando em conta que o sistema tenha sido instalado no diretório C:\NSNFCe): Visual Basic 6 e VB.NET: Shell ( C:\NSNFCe\OperacoesNFCe.exe ) Java Process p = Runtime.getRuntime().exec("C:\\NSNFCe\\OperacoesNFCe.exe"); Delphi WinExec ('C:\NSNFe\OperacoesNFCe.exe', 1); VB.NET Dim p as Process = new Process() p.startinfo.filename = C:\NSNFCe\OperacoesNFCe.exe p.start(); 19