NS NFCe

  1. Inicio
  2. Documentos
  3. NS NFCe
  4. NS NFCe Cloud
  5. Padrões de Arquivos, Pastas e Utilização do sistema (NFCe Cloud)

Padrões de Arquivos, Pastas e Utilização do sistema (NFCe Cloud)

Padrões de Arquivos
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: https://documentacao.nstecnologia.com.br/docs/ns-nfce/manuais-de-integracao-nfce/layout-do-arquivo-de-emissao-nfce-4-00/

O arquivo deve ser gerado dentro da pasta remessas (vide capitulo 3.1):

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. Veja o material Impressoras NFC-e Cloud

 2- Impressão via DLL: Descrição na página 10 do manual de Utilização. Veja o material Impressoras NFC-e Cloud

3- 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.

OBS: caso passe a linha IMPRESSAO poderá ser utilizada as formas de impressão tanto pelo modo Spooler ou porta COM, caso seja por Porta COM deixe o campo caminho da impressão vazio e configure apenas o numero de cópias e o tipo de impressão.

Abaixo um exemplo de como ficaria um arquivo de impressão de nota fictício: 

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

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:

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: https://documentacao.nstecnologia.com.br/docs/ns-nfce/eventos-de-nfce/cancelamento-de-nfce/

O arquivo de cancelamento é composto cinco 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 “EVENTO|1|”;
  • A segunda linha possui os dados de versão e definição do evento da NFC-e com os seguintes valores:

A + 1.00 + CANCELAMENTO

  • A Terceira linha possui os dados de identificação do Cancelamento propriamente dita com os seguintes valores:

B + cod. estado + ambiente + chave de acesso + data de emissão do cancelamento  + hora de emissão do cancelamento + UTC + tipo de evento da nfe + Numero sequencial do evento

  • A quarta linha possui os dados do emitente do Cancelamento com os seguintes valores:

C02 + CNPJ do emitente do cancelamento

  • A quinta linha possui os dados do cancelamento

D + Descricao do Evento + Número do Protocolo de autorização da NFC-e + Motivo do Cancelamento

Abaixo um exemplo de como ficaria um arquivo de Cancelamento de nota fictício:

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:

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 + Chave da NFe + cod. estado + ambiente

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. 

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:

Documentos

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.

Arquivos PDF

PDFs

Sempre que uma nota é processada 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.

Obs: Esta pasta só será gerada caso esteja configurado no emsisor aba Impressão/Avançado a opção de Salvar PDF.

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.

Processados/nsConcluido

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.

Utilização do Sistema
Atualização do Sistema
Arquivo updating.ns

Após o download dos arquivos para atualizar, o emissor é encerrado automaticamente e começa o processo de atualização. Durante este processo, é criado um arquivo temporário na pasta raiz do emissor, chamado updating.ns. Ex: “C:\NSNFCe\updating.ns”.

Este arquivo existirá enquanto o processo de atualização estiver em andamento, e ao término, sendo a atualização bem sucedida ou não, o arquivo será excluído e o emissor aberto novamente.

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 NFCeClient.Jar

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.

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

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.

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|143120002060179|QggaZu/qFPsZJYtvM8ZQR20E7/w=|100|Autorizado o uso da NFC-e|NFCe43120607364617000135550000000007031000007034|0|703 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 NFCe: 0
  • Numero da NFCe: 703

 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

Cada campo é separado dentro do arquivo pelo caracter pipe (“|”).

Ex.: Para o registro RP:

RP|102|Inutilizacao de numero homologado|2010-08-30T18:09:47|

143200001624655|

Os valores obtidos seriam

  • Cod. Retorno de Processamento:102
  • Mensagem de Processamento: Inutilização de Numero Homologado
  • Data e Hora do Recebimento : 2010-08-30t18:09:47
  • Protocolo de Processamento: 143200001624655

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|143120002060179|QggaZu/qFPsZJYtvM8ZQR20E7/w=|100|Autorizado o uso da NFC-e|NFCe43120607364617000135550000000007031000007034|0|703 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:

NFCe43120607364617000135550000000007031000007034

  • Serie da NFCe: 0
  • Numero da NFCe: 703

Continue acompanhando: Gerar TXT básico para a emissão (NFC-e) e saiba mais sobre os tópicos apresentados.

Como podemos ajudar?