O Comunicador Offline Focus NFe é uma aplicação desktop que permite emitir NFCe de forma simplificada. Ele atende especialmente usuários de tecnologias que não permitem acesso à API via Web Services, ou que preferem não programar chamadas HTTP diretamente. Nesses casos, é possível usar o processamento de diretórios para emissão dos documentos fiscais.
A aplicação também disponibiliza uma API local para integrações que precisam de comunicação direta entre sistemas. As especificações desta seção são válidas para a build 3.0.0 e posteriores do executável.
Quando está em execução, o Comunicador Offline Focus NFe consulta o conteúdo dos diretórios criados a partir de um caminho válido configurado pelo usuário. Chamamos esses diretórios de Diretórios de Comunicação.
Dessa forma, basta que um software terceiro crie um arquivo no diretório correto, contendo o JSON com os dados necessários, para iniciar a emissão da nota. O Comunicador Offline Focus NFe processa esse conteúdo e grava o resultado nos demais diretórios descritos abaixo. Quando a comunicação é feita pela API local, apenas a leitura do arquivo no diretório de entrada deixa de fazer parte do processo.
Atenção: os Diretórios de Comunicação são criados a partir de um caminho válido configurado pelo usuário. Esse local deve permitir acesso completo de leitura e escrita no sistema operacional. Recomendamos o diretório
C:\Comunicador\, cuja criação é responsabilidade do usuário.
Diretórios de Comunicação
Veja abaixo a finalidade de cada diretório:
- envios: diretório inicial do processo de envio. O Comunicador Offline Focus NFe procura arquivos com extensão
.nfcepara emissão e.cancpara cancelamento. - enviados: recebe os arquivos lidos no diretório
enviosapós o processamento. - retornos: recebe o resultado do processamento interno do Comunicador, com a resposta formatada.
- xml: armazena o XML gerado pela Sefaz para emissão e cancelamento de NFCe.
- danfe: armazena a DANFE em formato HTML. Não é gerada impressão quando o documento fiscal é cancelado.
- pdf: armazena o PDF da DANFE quando a opção de impressão direta está habilitada na tela de configurações. Não é gerada impressão quando o documento fiscal é cancelado.
Observação: a geração do PDF foi removida do fluxo de autorização de cupons. O PDF só é gerado quando a impressão direta está ativada nas configurações. Na tela de histórico de documentos fiscais, é possível obter individualmente o PDF e o XML dos documentos autorizados. O PDF também pode ser obtido pela API local.
Logs: o diretório de logs do Comunicador Offline Focus NFe é fixo em C:\Users\{{usuário}}\AppData\Roaming\comunicador-focus-nfe, onde {{usuário}} corresponde ao usuário do cliente. O diretório AppData é oculto por padrão no Windows.
Pré-Requisitos Para Emissão De NFCe
Para emitir Nota Fiscal de Consumidor Eletrônica, cumpra as premissas abaixo:
- Possuir Certificado Digital modelo A1.
- Habilitar a emissão de NFCe na Sefaz do estado do emitente.
- Gerar os códigos CSC e ID_TOKEN na Sefaz.
- Realizar o cadastro da empresa emitente em nossa base, pelo Painel da API ou pela API de Empresas.
- Informar os códigos CSC e ID_TOKEN no cadastro do emitente.
- Importar o Certificado Digital pelo Painel da API ou solicitar apoio ao Suporte em [email protected].
Depois de cumprir essas etapas, será possível utilizar o Comunicador Offline Focus NFe. Todas são importantes e, quando não atendidas, impedem a emissão do documento fiscal.
O arquivo com os dados da NFCe deve seguir a estrutura de um arquivo JSON, usando a extensão .nfce para emissão e .canc para cancelamento.
Reimpressão da DANFCe
Para reimprimir a DANFCe, gere o PDF na tela de histórico de documentos fiscais, acesse o diretório onde o arquivo foi salvo e imprima o documento.
Também é possível obter o PDF diretamente pela API local de geração do PDF da NFCe, disponibilizada pelo Comunicador Offline Focus NFe.
API Local v2
Além do sistema de comunicação por diretórios, o Comunicador Offline Focus NFe também disponibiliza uma API local para comunicação direta.
Com a API local, é possível:
- Emitir NFCe.
- Cancelar NFCe.
- Gerar o espelho da NFCe em PDF.
- Gerar o XML da NFCe.
- Consultar NFCe.
Observação: o valor de
PORTAé definido nas configurações do Comunicador Offline Focus NFe. Caso não seja atribuída uma porta válida, será escolhida automaticamente uma porta disponível.
Contingência NFCe
A Contingência NFCe é utilizada quando o estabelecimento não consegue se comunicar com a Sefaz. Isso pode ocorrer por falta de conexão com a internet, indisponibilidade da API ou indisponibilidade da própria Sefaz.
URLs
| Método | URL (recurso) | Ação |
|---|---|---|
| POST | http://localhost:PORTA/v2/fiscal/nfce?ref=REFERENCIA&tipo_contingencia=TIPO | Emite uma NFCe offline (Contingência). |
| PUT | http://localhost:PORTA/v2/fiscal/nfce/REFERENCIA/efetivar | Tenta efetivar uma NFCe emitida em contingência. |
| GET | http://localhost:PORTA/v2/fiscal/nfce/pendentes | Lista todas as NFCes emitidas em contingência que não foram efetivadas. |
Emissão de NFCe em contingência
- O parâmetro TIPO possui o valor possível: offline.
- Caso seja informado offline, será emitida uma NFCe provisória que será enviada posteriormente para efetivação.
- É possível informar o parâmetro forma_emissao=offline na URL de emissão para forçar a contingência. Nesse caso, a NFCe será emitida em contingência mesmo que a emissão normal esteja disponível. Se esse parâmetro não for informado, a contingência ocorrerá apenas nas situações que a exigirem.
Exemplo de uso:
http://localhost:PORTA/v2/fiscal/nfce?ref=REFERENCIA&tipo_contingencia=TIPO&forma_emissao=offlineEfetivação de NFCe emitida em contingência
- Após a NFCe ser emitida em contingência offline, o Comunicador tentará efetivá-la automaticamente quatro vezes, com intervalo de 30 minutos entre cada tentativa.
- Se as quatro tentativas forem esgotadas e a NFCe ainda não puder ser efetivada, seja por falta de conexão da máquina com a internet, indisponibilidade da API ou indisponibilidade da Sefaz, o usuário poderá tentar a efetivação manualmente pela API local, usando a URL apresentada anteriormente.
- A efetivação manual pode ser tentada a qualquer momento pela API local. Não é necessário aguardar o fim das tentativas automáticas do Comunicador.
Download
Para ter acesso ao instalador do Comunicador Offline Focus NFe e ao código de ativação, entre em contato com nossa equipe pelo email [email protected].
