Configuração

Web service para configurar o AgenteNFCe.

Principais configurações:

Para acessar o XSD clique aqui.

Configuração do emissor

Configura as informações do emissor que irá emitir os documentos e o tipo de ambiente.

 <Configuracao versao="1">
     <CNPJ>447041000120</CNPJ>
     <IE>1234567</IE>
     <Ambiente>2</Ambiente>
     ...
 </Configuracao>
xPath Descrição
Configuracao Grupo base com informações de configuração
Configuracao/CNPJ CNPJ do emitente
Configuracao/IE Inscrição Estadual do emitente
Configuracao/Ambiente

Tipo do ambiente:

  • 1 - Producao
  • 2 - Homologacao

Configuração da Retaguarda Inventti

O AgenteNFCe se comunica com as seguintes Retaguardas da Inventti:

  • NFePack - Responsável pela emissão de NF-e
  • NFCePack - Responsável pela emissão de NFC-e/CF-e

A configuração deve ser realizada conforme a necessidade do cliente podendo ser utilizada apenas uma das retaguardas ou ambas de acordo com os documentos emitidos pela aplicação.

Os dados das retaguardas devem ser configurados conforme configuração de tipo de ambiente.

 <Configuracao versao="1">
     ...
     <NFePack>
         <Serie>109</Serie>
         <NaturezaOperacao>VENDA DENTRO DO SC</NaturezaOperacao>
         <ControleNumeracao>10</ControleNumeracao>
         <WebService>
             <Endereco>http://hom.inventti.com.br/nfe</Endereco>
             <TokenAutenticacao>80i64hf3fgc856fnglbedai5j6jl6djj13h9</TokenAutenticacao>
         </WebService>
     </NFePack>
     <NFCePack>
         <Serie>109</Serie>
         <SerieContingencia>709</SerieContingencia>
         <NaturezaOperacao>VENDA DENTRO DO SC</NaturezaOperacao>
         <SequenciaAutorizacao>NFC-e;NFC-e OffLine</SequenciaAutorizacao>
         <ControleNumeracao>20</ControleNumeracao>
         <ContingenciaAutomaticaDeRejeicao>1</ContingenciaAutomaticaDeRejeicao>
         <WebService>
             <Endereco>http://hom.inventti.com.br/nfce</Endereco>
             <TokenAutenticacao>80i64hf3fgc856fnglbedai5j6jl6djj13h9</TokenAutenticacao>
         </WebService>
         ...
     </NFCePack>
 </Configuracao>
xPath Descrição
Configuracao/NFePack Grupo com informações específicas para a retaguarda NFePack
Configuracao/NFePack/Serie Série utilizada pelo PDV para NF-e
Configuracao/NFePack/NaturezaOperacao Natureza de operação que será utilizada para NF-e
Configuracao/NFePack/ControleNumeracao

Tipo de controle da numeração da NF-e:

  • 10 - Automatico - Gerada automaticamente pelo AgenteNFCe
  • 20 - Manual - Fornecida pelo PDV
Configuracao/NFePack/WebService Grupo com informações de endereço e autenticação com a retaguarda NFePack
Configuracao/NFePack/WebService/Endereco Endereço da retaguarda NFePack conforme tipo de ambiente configurado (Homologação/Produção)
Configuracao/NFePack/WebService/TokenAutenticacao Token para autenticação com a retaguarda. Token definido na configuração do emissor na retaguarda.
Configuracao/NFCePack Grupo com informações específicas para a retaguarda NFCePack
Configuracao/NFCePack/Serie Série utilizada pelo PDV para NFC-e
Configuracao/NFCePack/SerieContingencia Série de contingência utilizada pelo PDV para NFC-e
Configuracao/NFCePack/SequenciaAutorizacao

Fluxo de emissão da venda. Os valores possíveis podem ser:

  • NFC-e: Emissão de NFC-e sem controle de contingência
  • SAT: Emissão de CF-e
  • NFC-e OffLine: Emissão de NFC-e em contingência, utilizar apenas em casos de problemas técnicos
  • NFC-e;NFC-e OffLine: Emissão de NFC-e com controle de contingência automática NFC-e Offline
  • NFC-e;SAT: Emissão de NFC-e com controle de contingência automática S@T
  • MF-e: Emissão de MF-e (CF-e) utilizando o integrador fiscal da Sefaz CE
Configuracao/NFCePack/NaturezaOperacao Natureza de operação que será utilizada para NFC-e
Configuracao/NFCePack/ControleNumeracao

Tipo de controle da numeração da NFC-e:

  • 10 - Automatico - Gerada automaticamente pelo AgenteNFCe
  • 20 - Manual - Fornecida pelo PDV
Configuracao/NFCePack/ContingenciaAutomaticaDeRejeicao

Indica se o sistema irá emitir automaticamente em contingência caso a NFC-e seja rejeitada:

  • 1 - Sim
  • 0 - Não

Verificar recomendação de uso da tag ContingenciaAutomaticaDeRejeicao do NFCePack abaixo.

Configuracao/NFCePack/WebService Grupo com informações de endereço e autenticação com a retaguarda NFCePack
Configuracao/NFCePack/WebService/Endereco Endereço da retaguarda NFePack conforme tipo de ambiente configurado (Homologação/Produção)
Configuracao/NFCePack/WebService/TokenAutenticacao Token para autenticação com a retaguarda. Token definido na configuração do emissor na retaguarda.

Recomendação de uso da tag ContingenciaAutomaticaDeRejeicao do NFCePack

Esta configuração aplica-se somente para emissão de NFC-e ou SAT CF-e quando configurado para sequência de emissão “NFC-e;NFC-e OffLine;” e “NFC-e;SAT;”

Quando este parâmetro não for informado ele assumirá por padrão o valor 1 (Sim) onde que qualquer rejeição que ocorrer a aplicação emitirá em contingência respeitando a sequência de opções informada no parâmetro SequenciaAutorizacao.

Cenários:
  • Configurado 0 (Não Emitir em Contingência):
    • Será emitido em contingência para rejeições da SEFAZ com os seguintes cStat:
      • 108 - Serviço Paralisado Momentaneamente (curto prazo)
      • 109 - Serviço Paralisado sem Previsão
      • 999 - Rejeição: Erro não catalogado
      • Para demais cStat não sera emitido em contingência.
    • Não será emitido em contingência para códigos de erro Inventti:
      • 20108 - CNPJ não cadastrado no NFePack
      • 20153 - CNPJ não licenciado
      • 20132 - Critica de Integração por duplicidade de nota no NFePack
      • 20212 - Token Autenticação do Web Service do NFePack não confere com o cadastrado para o CNPJ emissor
      • 70018 - Certificado inválido. O emissor não possui certificado ou o certificado esta vencido
      • Para demais códigos de erros da Inventti sera emitido em contingência.
  • Configurado 1 (Emitir em contingência):
    • Não será emitido em contingência para códigos de erro Inventti:
      • 20108 - CNPJ não cadastrado no NFePack
      • 20153 - CNPJ não licenciado
      • 20212 - Token Autenticação do Web Service do NFePack não confere com o cadastrado para o CNPJ emissor
      • Demais códigos de erro Inventti e todos os cStat SEFAZ serão emitidos em contingência

Configuração do S@T

O AgenteNFCe não é responsável pela instalação e ativação do equipamento S@T.

A instalação varia de acordo com o fabricante do equipamento, consultar a documentação disponibilizada pelo fabricante para este processo.

Após o processo de instalação e ativação do equipamento S@T, é necessário informar os dados de comunicação para o AgenteNFCe.

Estas informações são determinadas pela SEFAZ conforme a Documentação padrão do projeto S@T.

 <Configuracao versao="1">
     ...
     <NFCePack>
         ...
         <SAT>
             <CNPJAC>22222222222222</CNPJAC>
             <SignAC>SGR-SAT SISTEMA DE GESTAO E RETAGUARDA DO SAT</SignAC>
             <VersaoDadosEntrada>0.06</VersaoDadosEntrada>
             <CodigoAtivacao>00000000000</CodigoAtivacao>
             <CaminhoDLLSat>c:\sat\sat.dll</CaminhoDLLSat>
         </SAT>
         ...
     </NFCePack>
     ...
 </Configuracao>
xPath Descrição
Configuracao/NFCePack/SAT Grupo de informações de configuração do equipamento S@T
Configuracao/NFCePack/SAT/CNPJAC CNPJ da Software House do PDV (AC)
Configuracao/NFCePack/SAT/SignAC Assinatura gerada pela Software House do PDV (AC), consultar Documentação padrão do projeto S@T
Configuracao/NFCePack/SAT/VersaoDadosEntrada Versão do leiaute do CF-e
Configuracao/NFCePack/SAT/CodigoAtivacao Senha definida pelo contribuinte no Software de ativação do equipamento S@T
Configuracao/NFCePack/SAT/CaminhoDLLSat Caminho completo da DLL de comunicação do equipamento S@T, disponibilizada pelo fabricante

Configuração do MF-e

Configura os dados necessários para a integração com o Integrador Fiscal MF-e, esta configuração é válida somente para o grupo NFCePack.

Para os dados do equipamento MF-e utilizar o grupo Configurações do S@T.

O Endereço e porta para o ConectorMFe devem ser informados se o mesmo for utilizado.

 <Configuracao versao="1">
     ...
     <NFCePack>
         ...
         <MFe>
             <DiretorioIntegracaoIntegradorFiscalInput>c:\Integrador\input</DiretorioIntegracaoIntegradorFiscalInput>
             <DiretorioIntegracaoIntegradorFiscalOutput>c:\Integrador\output</DiretorioIntegracaoIntegradorFiscalOutput>
             <ChaveAcessoValidadorIntegradorFiscal>12345678</ChaveAcessoValidadorIntegradorFiscal>
             <EnderecoConectorMFe>10.0.0.1</EnderecoConectorMFe>
             <PortaConectorMFe>1234</PortaConectorMFe>
             <QuantidadeTentativasObterDadosPagamento>5</QuantidadeTentativasObterDadosPagamento>
             <IntervaloExcecucaoServicoIntegracaoVFPe>10</IntervaloExcecucaoServicoIntegracaoVFPe>
         </MFe>
     </NFCePack>
     ...
 </Configuracao>
xPath Descrição  
Configuracao/NFCePack/MFe Grupo de informações de configuração do MF-e  
Configuracao/NFCePack/MFe/DiretorioIntegracaoIntegradorFiscalInput Diretório input utilizado pelo Integrador Fiscal MF-e  
Configuracao/NFCePack/MFe/DiretorioIntegracaoIntegradorFiscalOutput Diretório output utilizado pelo Integrador Fiscal MF-e  
Configuracao/NFCePack/MFe/ChaveAcessoValidadorIntegradorFiscal Chave de acesso do Integrador Fiscal MF-e.  
Configuracao/NFCePack/MFe/EnderecoConectorMFe Endereço do ConectorMFe  
Configuracao/NFCePack/MFe/PortaConectorMFe Porta do ConectorMFe  
Configuracao/NFCePack/MFe/QuantidadeTentativasObterDadosPagamento Quantidade de vezes que o serviço de integração do VFP-e no AgenteNFCe irá tentar obter os dados pagamento.  
Configuracao/NFCePack/MFe/IntervaloExcecucaoServicoIntegracaoVFPe Intervalo de tempo que o serviço de integração do VFP-e no AgenteNFCe irá executar.  

Configuração de Impressão

Configura os dados necessários para impressão das vendas (NFC-e/CF-e), essa configuração é valida somente para o grupo NFCePack.

Recomendação de uso

  • Recomendado que o PDV implemente a impressão térmica (NFCe/CFe) para evitar problemas de concorrência de uso da impressora. O PDV imprime relatórios gerenciais e comprovantes de pagamento via cartão (Não Utilizar este método para NFCe/CFe)
  • Pode ser utilizado para reimpressão de NFe. Após a autorização a NFe é impressa automaticamente pela retaguarda Inventti.
 <Configuracao versao="1">
     ...
     <NFCePack>
         ...
         <Impressao>
             <Comunicacao>8</Comunicacao>
             <QtdCaracteresLinhaImpressao>60</QtdCaracteresLinhaImpressao>
             <ImprimirLogoNFCe>1</ImprimirLogoNFCe>
             <CaminhoLogoContribuinte>c:\temp\logo.jpg</CaminhoLogoContribuinte>
             <!-- Serial e SerialNetFramework -->
             <Serial>
                 <Porta>COM4</Porta>
                 <Atraso>0</Atraso>
             </Serial>
             <!-- DLL -->
             <DLL>
                 <Porta>COM4</Porta>
                 <Fabricante>3</Fabricante>
                 <CaminhoDLL>C:\temp\sweda.dll</CaminhoDLL>
             </DLL>
             <!-- Rede -->
             <Rede>
                 <Endereco>192.168.0.123:9100</Endereco>
                 <Atraso>25</Atraso>
             </Rede>
         </Impressao>
     </NFCePack>
     ...
 </Configuracao>
xPath Descrição
Configuracao/NFCePack/Impressao Grupo de informações de configuração para impressão em impressora térmica
Configuracao/NFCePack/Impressao/Comunicacao

Tipo de Comunicação utilizada pelo AgenteNFCe para se comunicar com a impressora térmica:

  • 1 - Serial - Comunicação direta com a porta COM (Windows)
  • 6 - SerialNetFramework - Comunicação direta com a porta COM (Linux)
  • 8 - DLL - Comunicação através da DLL disponibilizada pelo fabricante da impressora (Recomendada, consultar Impressão)
  • 9 - Rede - Comunicação através da rede
Configuracao/NFCePack/Impressao/QtdCaracteresLinhaImpressao Quantidade de caracteres que a impressora permite por linha de impressão
Configuracao/NFCePack/Impressao/ImprimirLogoNFCe

Indica se deve ou não imprimir o logo da NFCe:

  • 1 - Sim
  • 2 - Não
Configuracao/NFCePack/Impressao/CaminhoLogoContribuinte Caminho da imagem do logo do contribuinte
Configuracao/NFCePack/Impressao/Serial Grupo de informações necessário para impressoras utilizando a forma de comunicação 1 (Serial) ou 6 (SerialNetFramework)
Configuracao/NFCePack/Impressao/Serial/Porta Porta onde a impressora esta conectada
Configuracao/NFCePack/Impressao/Serial/Atraso Tempo de atraso em milisegundos para cada linha enviada à impressora.
Configuracao/NFCePack/Impressao/DLL Grupo de informações necessário para impressoras utilizando a forma de comunicação 8 (DLL)
Configuracao/NFCePack/Impressao/DLL/Porta Porta onde a impressora esta conectada
Configuracao/NFCePack/Impressao/DLL/Fabricante

Fabricante da impressora:

  • 0 - Nenhum
  • 1 - Bematech
  • 2 - Elgin
  • 3 - Sweda
Configuracao/NFCePack/Impressao/DLL/CaminhoDLL Nome completo do caminho e arquivo da DLL da impressora quando comunicação for via DLL. Para mais informações sobre as DLLs das impressoras, veja o Guia de Impressão eDocs Inventti
Configuracao/NFCePack/Impressao/Rede Grupo de informações necessário para impressoras utilizando a forma de comunicação 9 (Rede)
Configuracao/NFCePack/Impressao/Rede/Endereco Endereço de rede da impressora ethernet
Configuracao/NFCePack/Impressao/Rede/Atraso Tempo de atraso em milisegundos para cada linha enviada à impressora.

Configuração do Proxy da Rede

Utilizar este grupo somente quando houver necessidade da configuração do Proxy de rede para a comunicação entre o AgenteNFCe e as retaguardas Inventti.

 <Configuracao versao="1">
     ...
     <Proxy>
         <Servidor>http://meu.proxy.com.br:9090</Servidor>
         <Usuario>inventti</Usuario>
         <Senha>inventti</Senha>
     </Proxy>
     ...
 </Configuracao>
xPath Descrição
Configuracao/Proxy Grupo de informações para configuração de Proxy
Configuracao/Proxy/Servidor Endereço do servidor de Proxy
Configuracao/Proxy/Usuario Usuário para o uso do Proxy
Configuracao/Proxy/Senha Senha para o uso do Proxy

Exemplo completo

# POST
http://localhost:6679/api/configuracao
<Configuracao versao="1">
    <CNPJ>00447041000120</CNPJ>
    <Ambiente>2</Ambiente>
    <NFCePack>
        <Serie>709</Serie>
        <NaturezaOperacao>VENDA DENTRO DO SC</NaturezaOperacao>
        <SequenciaAutorizacao>NFC-e;NFC-e OffLine</SequenciaAutorizacao>
        <ControleNumeracao>10</ControleNumeracao>
        <ContingenciaAutomaticaDeRejeicao>0</ContingenciaAutomaticaDeRejeicao>
        <WebService>
            <Endereco>http://hom.inventti.com.br/nfce</Endereco>
            <TokenAutenticacao>80i64hf3fgc856fnglbedai5j6jl6djj13h9</TokenAutenticacao>
        </WebService>
        <SAT>
            <CNPJAC>22222222222222</CNPJAC>
            <SignAC>SGR-SAT SISTEMA DE GESTAO E RETAGUARDA DO SAT</SignAC>
            <VersaoDadosEntrada>0.06</VersaoDadosEntrada>
            <CodigoAtivacao>00000000000</CodigoAtivacao>
            <CaminhoDLLSat>c:\sat\sat.dll</CaminhoDLLSat>
        </SAT>
        <MFe>
            <DiretorioIntegracaoIntegradorFiscal>c:\Integrador</DiretorioIntegracaoIntegradorFiscal>
            <ChaveAcessoValidadorIntegradorFiscal>12345678</ChaveAcessoValidadorIntegradorFiscal>
            <EnderecoConectorMFe>10.0.0.1</EnderecoConectorMFe>
            <PortaConectorMFe>1234</PortaConectorMFe>
        </MFe>
        <Impressao>
            <Comunicacao>8</Comunicacao>
            <QtdCaracteresLinhaImpressao>60</QtdCaracteresLinhaImpressao>
            <ImprimirLogoNFCe>1</ImprimirLogoNFCe>
            <CaminhoLogoContribuinte>c:\temp\logo.jpg</CaminhoLogoContribuinte>
            <Serial>
                <Porta>COM4</Porta>
            </Serial>
            <DLL>
                <Porta>COM4</Porta>
                <Fabricante>3</Fabricante>
                <CaminhoDLL>C:\temp\sweda.dll</CaminhoDLL>
            </DLL>
            <Rede>
                <Endereco>192.168.0.123:9100</Endereco>
            </Rede>
        </Impressao>
    </NFCePack>
    <NFePack>
        <Serie>709</Serie>
        <NaturezaOperacao>VENDA DENTRO DO SC</NaturezaOperacao>
        <ControleNumeracao>20</ControleNumeracao>
        <WebService>
            <Endereco>http://hom.inventti.com.br/nfe</Endereco>
            <TokenAutenticacao>80i64hf3fgc856fnglbedai5j6jl6djj13h9</TokenAutenticacao>
        </WebService>
    </NFePack>
    <Proxy>
        <Servidor>meu.proxy.com.br:9090</Servidor>
        <Usuario>inventti</Usuario>
        <Senha>inventti</Senha>
    </Proxy>
</Configuracao>

Resposta

Estrutura do xml de resposta.

Resposta de Erro

<ConfiguracaoResposta>
    <SituacaoOperacao>2</SituacaoOperacao>
    <Erro>
        <Codigo>10105</Codigo>
        <Descricao>Problemas de configuração do AGENTE. Dados de configuração do NFePACK incompletos: </Descricao>
    </Erro>
</ConfiguracaoResposta>

Resposta de Sucesso

<ConfiguracaoResposta>
    <SituacaoOperacao>1</SituacaoOperacao>
</ConfiguracaoResposta>
xPath Descrição
ConfiguracaoResposta Grupo com informações da resposta da Configuração
ConfiguracaoResposta/SituacaoOperacao

Situação da operação

  • 1- Sucesso
  • 2 - Erro
ConfiguracaoResposta/Erro Grupo de erro
ConfiguracaoResposta/Erro/Codigo Código de erro
ConfiguracaoResposta/Erro/Descricao Descrição do erro