NE - Como Fazer - NFSe Configurável
A funcionalidade desse manual é apresentar a Nota Fiscal de Serviço Eletrônica.
Índice
- 1 Quais são os municípios atendidos pelo NFS-e?
- 2 Quais são os pré-requisitos para utilizar a NFS-e?
- 3 Quais são os cadastros prévios do NFS-e?
- 4 Como funciona a rotina Grava NFS-e no Gerenciador?
- 5 Quais são as configurações necessárias para o NFS-e?
- 6 Onde está localizado no menu o NFS-e Configurável?
- 7 Como configurar um NFS-e Configurável?
- 8 Quais as opções do Gerenciador NFS-e?
- 9 Como enviar, retornar e anular um NFSe?
- 10 Como enviar e retornar múltiplas Notas Fiscais?
- 11 Como parametrizar a NFSe para atender a Lei 12.741 (Valor aproximado dos tributos)?
- 12 Como realizar a impressão da descrição do Serviço Municipal nas Notas Fiscais de Serviços Eletrônica - NFSe?
- 13 Como será gerada a informação da tag <MunicipioPrestacaoServico>?
- 14 Como utilizar a regra de natureza ‘Conforme Tipo de Operação’ no Gerenciamento NFS-e Configurável?
- 15 Como reenviar NFSe que estão em processamento?
Quais são os municípios atendidos pelo NFS-e?
A finalidade da NFS-e Configurável é possibilitar a configuração de qualquer município para utilização da NFS-e, em princípio foram homologados os padrões ABRASF.
Quais são os pré-requisitos para utilizar a NFS-e?
Para a utilização da NFS-e é necessário instalar e configurar os seguintes aplicativos:
- .Net 3.5.
- WS Enchancement 3.0.
- Certificado Digital ICP-Brasil A1 ou A3.
- Assinador XML, somente para o CIGAM e10 (registro de DLL). É necessário que elas estejam sempre atualizadas.
Como instalar o certificado para autenticação do arquivo XML?
No arquivo .pfx (certificado digital) clique com o botão direito, opção “Instalar pfx”
No assistente de instalação clique em Avançar
Confirme a opção Arquivo a ser importado clicando em Avançar
Informe a senha do certificado
Na tela de Armazenamento de certificados confirme clicando em Avançar
Clique em concluir para finalizar a instalação no certificado na estação
Após a conclusão dos passos acima, a estação estará apta para comunicar com a prefeitura.
Quais são os cadastros prévios do NFS-e?
Cadastro de Últimos ID’s Sequenciais (Utilidades/Diversos - Parâmetros)
Deve estar cadastrado o último ID sequencial para a tabela 275 com o tipo ‘I’,’L’ e ‘S’. Os tipos ‘I’ e ‘L’ são os mesmos que são utilizados para a Nota Fiscal Eletrônica Nacional, portanto não devem ser alterados caso já estejam cadastrados.
Cadastro de Séries (Comercial - Faturamento/Pedidos - Parâmetros)
No cadastro de séries deve ser definido o Tipo de emissão como ‘3 Serviço’ e deve possuir uma série oficial. Este tratamento fará com que logo que a nota for cadastrada ela já seja levada automaticamente para o gerenciador de NFS-e. Caso as notas tenham sido criadas antes de ajustar o tipo de emissão da série, pode ser utilizada a rotina ‘Grava NFS-e no Gerenciador’, conforme será explicado mais a frente.
Importante: não deve existir mais de uma série com a mesma série oficial para a mesma unidade de negócio.
Cadastro de Municípios (Utilidades/Diversos - Cadastros - Municípios)
No cadastro de municípios devem ser cadastrados o código do IBGE.
Cadastro de Empresas (Comercial - Faturamento/Pedidos - Cadastros - Empresas)
No cadastro de empresas deve estar preenchido o campo ‘CNAE Serviço’ com o CNAE de prestação de serviço do município. Caso o CNAE possa variar conforme o serviço prestado, é possível cadastrar um CNAE específico para um determinado serviço através do botão ‘Serviços por material’. Caso o serviço não tenha um CNAE específico será utilizado o CNAE Serviço da empresa da unidade de negócio.
Como funciona a rotina Grava NFS-e no Gerenciador?
A rotina Grava NFS-e no Gerenciador está localizada no menu em: Fiscal > NFe > Rotinas > Grava NFS-e no Gerenciador’.
Essa rotina deverá ser executada caso as notas tenham sido criadas antes de ajustar o ‘Tipo de emissão’ no cadastro da série.
Ao executar a rotina as notas listadas serão enviadas para o Gerenciador NFS-e com o ‘Status’ “Não enviado”.
Quais são as configurações necessárias para o NFS-e?
É preciso que estejam informadas as seguintes configurações:
‘LF - NE - 1812 - Usuário do Proxy para consumo dos WebServices NFe via .Net’ - Informe o usuário da rede para acesso ao Servidor Proxy para o consumo dos WebServices da SEFAZ para a utilização da Nota Fiscal Eletrônica através da tecnologia DLL .Net.
‘LF - NE - 1813 - Senha do Proxy para consumo dos WebServices NFe via .Net’ - Informe a senha da rede para acesso ao Servidor Proxy para o consumo dos WebServices da SEFAZ para a utilização da Nota Fiscal Eletrônica através da tecnologia DLL .Net.
‘LF - NE - 1721 - Nome da empresa no certificado digital’ - Nome completo da empresa registrada para o certificado digital informando ‘CN=’ na frente do nome (Ex. CN=CIGAM).
Ou
‘LF – NE – 2250 - Nome da empresa no certificado digital’ - Nome completo da empresa registrada para o certificado digital informando ‘CN=’ na frente do nome (Ex. CN=CIGAM) sendo possível informar até 200 caracteres.
Caso a máquina estiver configurada com Proxy para acesso a internet, o Proxy deve ser informado nas configurações de ambiente do uniPaaS.
O programa está no menu em Fiscal – Gestão Fiscal Municipal - Movimentos – Gerenciamento NFS-e Configurável
Como configurar um NFS-e Configurável?
O programa está no menu em Fiscal – Gestão Fiscal Municipal - Movimentos – Gerenciamento NFS-e Configurável
Com intuito de atender a Notas Fiscais de Serviço Eletrônicas de maneira mais ágil, foi desenvolvida a NFS-e configurável. Deste modo, o CIGAM deixa de necessitar de desenvolvimento para atender a novas prefeituras e passa a necessitar do serviço de parametrização de ambiente.
Para facilitar o trabalho do consultor que realizará a configuração do ambiente o sistema possui um cadastro que centraliza todas as parametrizações necessárias:
Grupo NFS-e
U.N.: Unidade de Negócio do cadastro. Pode ser deixado em branco para ser considerado em todas as UN’s.
UF: Campo que identifica o layout da NFS-e.
Município: Juntamente com a UF serve como identificação do layout.
Grupo Configurações
Referência de Assinatura: Indica para o sistema como deve ser realizada a assinatura do XML, estão disponíveis duas opções que, devido a facilidade de compreensão, foram nomeadas como ABRASF e GINFES.
Validar INFPS: Indica se o grupo InfRps do XML de envio receberá um tratamento diferenciado (padrão é deixar desmarcado).
Versão: Determina qual é a versão de comunicação que a DLL utilizará, atualmente existem 3 tipos de comunicação para a DLL configurável, versão v1.00 é a mais utilizada, sendo necessário apenas parametrização dos modelos iniciais, versão v2.00 sem modelo complexo, algumas prefeituras requerem toda a informação em um único XML, sendo possível informar todas as parametrizações em apenas um arquivo e a versão v2.00 com modelo complexo, algumas prefeituras aceitam o arquivo XML separado do arquivo que recebem via comunicação, esse tipo requer mais de um modelo de XML de envio. Mais informações sobre as versões estão no documento “Como Fazer - NFSe Configurável 2.0 - Processo de Implementação”.
Guias
As guias foram organizadas conforme as funções que serão utilizadas na NFS-e, por exemplo para poder enviar uma NFS-e é necessário configurar as informações solicitadas na guia de ‘Envio’, porém, para poder usar a funcionalidade de retorno as informações da guia ‘Retorno’ devem estar preenchidas. Na prática, é necessário parametrizar as guias ‘Envio’, ’Retorno’ e ‘Cancelamento’ para utilizar a NFS-e.
Guia Envio
Grupo Envio
Modelo: Deve ser informado o modelo Merge que deverá gerar o XML de envio da NFS-e.
Cabeçalho: Caso o layout da prefeitura exija um cabeçalho deve ser informado um modelo com todos os dados informados de maneira fixa, o modelo de cabeçalho não aceita tags.
Grupo Retorno
Procurar pelo código: caso essa opção seja selecionada, o sistema identifica a resposta do envio por um código específico informado no campo Conteúdo tag Código, deve ser marcado somente se no arquivo XML da resposta de envio, que a prefeitura retorna, não constar a informação do número do RPS (número da nota no CIGAM).
Conteúdo tag código: esse campo será habilitado somente se a opção ‘Procurar pelo código’ estiver marcada, ele indica qual o código o programa deve ler para confirmar a nota fiscal, normalmente as prefeituras disponibilizam o código de RPS no XML do retorno, então as opções ‘Procurar pelo código’ e ‘Conteúdo tag código’ não estariam preenchidas.
Tag do Código: é o caminho da tag que indica o código de erro na resposta do envio da NFS-e.
Tag Mensagem: é o caminho da tag que indica a mensagem de erro na resposta do envio da NFS-e.
Tag Correção: é o caminho da tag que indica o que deve ser alterado para resolver o erro indicado na tag de mensagem, é aconselhável informar pois facilita ao usuário identificar problemas em sua NFS-e.
Tag Protocolo: é o caminho da tag do protocolo da NFS-e, que indica ao sistema que o arquivo de XML de envio está bem formado e foi aceito pela primeira validação realizada pela prefeitura. A informação da tag protocolo será atualizada na coluna protocolo do gerenciador da NFS-e.
Grupo Envio Síncrono
Tag Número: é o caminho da tag de número da NFS-e, que é gerada no retorno de confirmação, mas não é gerada no retorno do erro. Ela identifica que a nota foi confirmada pela prefeitura e altera o status para “3 Confirmado”.
Tag Número NF: é o caminho da tag de número da NFS-e. Se a informação obtida na Tag Número for diferente de zero ou branco, vai confirmar a nota fiscal de serviço e o conteúdo obtido do caminho da Tag Número NF será atualizado no campo ‘Número NFSe’ da nota fiscal no Gerenciador.
Tag Cód Verificação: é o caminho da tag de Código de Verificação. Se a informação obtida na Tag Número for diferente de zero ou branco, vai confirmar a nota fiscal de serviço e o conteúdo obtido do caminho da Tag Cód Verificação será atualizado no campo do Código de Verificação da nota fiscal no Gerenciador.
Botão <Configurações>
Controlar Lote por Série: habilita o controle sequencial do número de Lote RPS, incrementando o valor somente quando a NF é recebida com sucesso no sistema da prefeitura. Dessa forma, não há intervalos de número de Lote inutilizados por NF’s inválidas.
Permitir Enviar Múltiplas Notas: ao selecionar esta opção ao acessar o Gerenciador NFS-e Configurável será permitido selecionar múltiplas notas fiscais para envio à prefeitura, desde que elas estejam com o mesmo status o gerenciador. Caso esteja desmarcada, ao selecionar uma nota fiscal as demais serão desabilitadas para seleção no Gerenciador. Lembrando que caso o município não permita o envio de múltiplas notas será apresentado erro ao tentar enviar. Verificar o tópico “Como enviar e retornar múltiplas Notas Fiscais?”.
Envio Síncrono: é utilizada nos casos onde a confirmação da nota fiscal, no ambiente da prefeitura, é feita no evento de envio da NFS-e, confirmando a nota no CIGAM.
Realizar comunicação WebService via DLL específica: é utilizada para realizar um desvio na comunicação com a prefeitura para utilizar a versão da DLL específica. Existem algumas prefeituras que necessitam dessa opção pois a forma que é realizado a comunicação da DLL da versão específica é diferente da DLL da versão configurável.
CPF ou CNPJ e Senha Prestador: para que sejam parametrizados o CPF ou CNPJ e Senha do usuário responsável, conforme cadastro na prefeitura.
Token: será utilizado por prefeituras que necessitem de uma chave de identificação do XML, como a prefeitura de Limeira - SP, na qual foi realizado o tratamento de inclusão da tag <Integridade> com a codificação desse Token, conforme solicitado pelo provedor.
Botão <Último Lote> Devem ser cadastrados os últimos números de Lote RPS utilizados para cada Série e Unidade de Negócio, de modo a enviar números de Lote sequenciais.
Botão <Natureza> Devem ser cadastradas as opções de natureza de envio da NFS--e que o usuário poderá selecionar ao enviar a nota. Essas opções estão disponíveis no manual de integração disponibilizado pela prefeitura. Estas informações serão apresentadas no campo ‘Natureza Operação’ da guia Configurações do Gerenciamento NFS-e Configurável.
Nesta tela devem ser informados os campos ‘Código’, ‘Descrição’, ‘Incidência ISS’, ‘Local Tributação’ e ‘Isenção’, este último quando necessário. Estas informações serão usadas como critério na busca do código da natureza para a geração do XML de envio. Desta forma, quando no Gerenciamento NFS-e Configurável o campo ‘Natureza Operação’ estiver igual a “Conforme Tipo de Operação” será verificada a regra criada no cadastro da Natureza comparada com as incidências do Tipo de Operação informado na nota, se este possui alíquota e o município do cliente, e então será levado para o XML o código e descrição correspondentes. No modelo do XML de envio devem ser utilizadas as variáveis merge <!$MG_natureza> e <!$MG_descricao_natureza> para apresentar estas informações.
Mais informações no tópico “Como utilizar a regra de natureza ‘Conforme Tipo de Operação’ no Gerenciamento NFS-e Configurável?”.
Botão <Assinatura> Devem ser cadastradas as tags que deverão ser assinadas. Usualmente as prefeituras exigem apenas uma assinatura na tag de LoteRps mas existem casos que a prefeitura pedem uma assinatura por InfRps e uma assinatura por LoteRps, nesses casos deve ser cadastrado as duas tags que devem ser assinadas e a sequência na qual elas serão assinadas (1 para a primeira assinatura, 2 para segunda assinatura e assim por diante). O tags que deverão ser assinadas são determinadas pela prefeitura, consulte o manual da mesma para conferir quais serão necessárias.
Botão <Serviços> Devem ser informados os dados do serviço de envio do XML para a prefeitura.
Como cada prefeitura monta sua própria estrutura de XML, para identificarmos essa estrutura, temos disponível a ferramenta CIGAM WebService Invoker para fazer a montagem de uma estrutura "básica" do XML. Mais informações no tópico “Como utilizar o CGWebServiceInvoker durante a implementação da NFS-e Configurável?”.
Guia Retorno
As informações dessa guia são necessárias para que a função de Retorno das notas funcione corretamente e a NFS-e possa ser confirmada. Na guia Retorno as informações sobre os campos ‘Modelo’, ‘Cabeçalho’, ‘Procurar pelo Código’, ‘Conteúdo tag Código’, ‘<Assinatura>’ e ‘<Serviços>’ são análogas a guia Envio.
Tag do Código: é o caminho da tag que indica o código de erro na resposta do retorno da NFS-e.
Tag Mensagem: é o caminho da tag que indica a mensagem de erro na resposta do retorno da NFS-e.
Tag Correção: é o caminho da tag que indica o que deve ser alterado para resolver o erro indicado na tag de mensagem, é aconselhável informar pois facilita ao usuário identificar problemas em sua NFS-e.
Tag Número NF: nesse campo deve ser informado o caminho da tag que indica o número da NF gerado pela prefeitura, essa informação indica ao sistema que o arquivo de XML de envio está bem formado e foi aceito por todas as validações realizadas pela prefeitura. A informação da tag será atualizada na coluna “Número NFSe” do gerenciador e a NF terá seu status alterado para confirmada.
Tag Cód Verificação: nesse campo deve ser informado o caminho da tag do código de verificação, caso informada atualizará o campo Cód de Verificação do gerenciador.
Tag Série: nesse campo deve ser informado o caminho da tag da série da NFS-e, que será utilizada para identificar a nota que está retornando.
Tag Número RPS: nesse campo deve ser informado o caminho da tag do número da RPS (Número da nota no CIGAM), que será utilizado para identificar a nota que está retornando.
Botão <RPS Não Proc.> Algumas prefeituras demoram alguns minutos para processar o XML de envio, algumas prefeituras optam por enviar um XML vazio como resposta e outras optam por enviar um código específico que indica que o RPS ainda não foi processado. Para o caso da prefeitura que utiliza códigos de RPS não processados, deve ser acessado o botão <RPS Não Proc.> e informado quais são os códigos que a prefeitura envia nesses casos.
No exemplo abaixo a prefeitura responde com o código E92 no XML.
Importante: Nesta tela não deverão ser cadastrados ‘códigos de erro’, pois caso forem, o sistema irá interpretar que tudo é XML não processado, e as Nota Fiscais não terão seu status alterado para a devida situação. Quando é cadastrado um código nesta tela, o CIGAM entende que não é erro, e assim ao solicitar para retornar a Nota Fiscal a mesma tem seu status mantido como ‘Enviada’ e apresentará a mensagem:
Guia Cancelamento
As informações dessa guia são necessárias para que a função de Cancelamento da NFS-e funcione corretamente e a NFS-e possa ser anulada. Na guia Cancelamento as informações sobre os campos ‘Modelo’, ‘Cabeçalho’, ‘Procurar pelo Código’, ‘Conteúdo tag Código’, ‘<Assinatura>’ e ‘<Serviços>’ são análogas a guia Envio.
Tag do Código: é o caminho da tag que indica o código de erro na resposta do cancelamento da NFS-e.
Tag Mensagem: é o caminho da tag que indica a mensagem de erro na resposta do cancelamento da NFS-e.
Tag Correção: é o caminho da tag que indica o que deve ser alterado para resolver o erro da tag de mensagem, é indicado informar pois facilita ao usuário identificar problemas em sua NFS-e.
Tag Número NF: é o caminho da tag que indica o número da NF gerado pela prefeitura, informando o sistema que o arquivo de XML de cancelamento está bem formado e foi aceito por todas as validações realizadas pela prefeitura. A NFS-e terá seu status alterado para cancelado.
‘Este município não permite cancelamento via web service’ – Para realizar o cancelamento de Notas Fiscais de Serviço em municípios que não disponibilizam este recurso via web service, apenas via site, deve ser selecionada esta opção. Importante: quando esta opção for selecionada as tags informadas acima para cancelamento serão desconsideradas e a Nota Fiscal será cancelada apenas no CIGAM, sendo necessário acessar o site da Prefeitura Municipal e realizar o cancelamento manual.
‘Usar NF Substituta’ – Algumas prefeituras não permitem o cancelamento de NFSe, apenas substituição de NFS-e, ao marcar essa opção, estará identificando ao CIGAM que essa prefeitura utiliza substituição ao invés de cancelamento, e o processo mudará.
‘Via Webservice’ e ‘Sem Webservice’ – A opção Via Webservice determina que a substituição da NFS-e terá comunicação com a prefeitura e o cancelamento/confirmação das notas envolvidas será realizado pelo CIGAM simultaneamente com a prefeitura. Sem Webservice determina que a substituição da NFS-e já ocorreu pelo site da prefeitura, deixando de lado a comunicação com a prefeitura e cancelando/confirmando as notas envolvidas apenas no CIGAM. Verificar os tópicos “Cancelamento: Nota Substituída / Substituta via webservice” e “Cancelamento: Nota Substituída / Substituta sem webservice”.
‘Considerar substituição a partir de N horas’ – Há casos de prefeituras que têm disponível tanto cancelamento quanto substituição. Ao informar uma quantidade de horas no campo disponível, o CIGAM interpretará que, depois de confirmada a nota fiscal, o usuário tem N horas para realizar o cancelamento da NFS-e, ao passar esse valor, o único processo disponível será a substituição.
Botão <Motivos> devem ser cadastrados os motivos de cancelamento disponíveis no guia de integração da prefeitura, ao cancelar uma NFS-e o usuário deverá selecionar uma das opções cadastradas nesse botão.
Mais informações sobre o cancelamento no tópico “Cancelamento”.
Botão <Impressão> caso o usuário queira utilizar a funcionalidade de impressão da NFS-e disponibilizada pela prefeitura, deve ser informada a URL da impressão. Normalmente as prefeituras disponibilizam essa funcionalidade através de um HTTP GET, que nada mais é do que uma URL comum que recebe alguns dados como parâmetro para, nesse caso, identificar qual a NFS que deve ser impressa. No exemplo do print abaixo, a url precisa ser completada com as informações de Inscrição Municipal, Código de Verificação e número da NFSe. Codificados respectivamente por @1@, @2@ e @3@.
Botão <Exportar Layout> para facilitar a implementação da NFSe, é possível realizar exportação de toda a configuração realizada. A exportação do layout configurado será realizada em formato .zip pois necessitam ser exportadas as tabelas FANFSECONFIGURACAO, FANFSEFUNCOES, FANFSEOPCOES, FANFSESERVICOS, GERELUSUARIO e os modelos merge configurados no cadastro.
Botão <Importar Layout> para facilitar a implementação da NFS-e, é possível realizar importação de toda a configuração previamente realizada. Para tanto é necessário informar qual a UF e o Município para o qual deseja importar o layout, o diretório no qual serão armazenados os modelos merge e o arquivo zip do layout.
O ‘Arquivo do layout’ é o mesmo arquivo criado pela rotina de exportar layout. Tanto a rotina de importar, como a exportar, estão disponíveis também para o modelo complexo.
Quando o consultor não tiver o arquivo zip do layout em sua máquina local e quiser fazer uma importação diretamente do FTP da Cigam, é possível utilizar essa funcionalidade clicando o botão FTP.
Botão <FTP>: Ao pressionar esse botão o sistema realizará uma consulta no FTP CIGAM exibindo todos os layouts que estão disponíveis para download. Ao selecionar um layout o sistema voltará para a tela anterior com o layout carregado no diretório %TEMP% e desabilitado para edição.
Facilitador para informar caminho das tags
Ao pressionar F5 em qualquer um dos campos que necessitam da informação do caminho de uma determinada Tag, o sistema exibirá uma tela para auxiliar o consultor na tarefa de informar esses caminhos.
Arquivo exemplo XML: nesse campo deve ser informado um arquivo de exemplo do XML que está sendo configurado os caminhos, normalmente a prefeitura disponibiliza alguns exemplos no site, porém é possível obter esses XMLs de resposta a partir do botão carregar no cadastro dos serviços. Após informar um arquivo XML de exemplo o sistema terá um tempo de processamento e deverá exibir um treeview com toda a estrutura do arquivo XML. É importante lembrar que todos as informações não são provenientes de apenas um arquivo, algumas vezes é necessário informar primeiro um arquivo na qual a nota tenha sido aceita e depois um arquivo de retorno de uma NF com erro, assim todas os caminhos poderão ser configurados.
Grupo Caminho das Tags: todas os campos dessa tela são os mesmos disponíveis no Cadastro da NFSe Configurável, porém aqui o consultor tem acesso a estrutura do XML e a algumas possíveis ocorrências do campo que está com foco atualmente. No exemplo do print acima, com foco no campo ‘Número NF’ o sistema identificou uma possível ocorrência dessa informação, para aceitar essa sugestão basta clicar e arrastar a informação da possível ocorrência para o campo Número NF, é possível arrastar também diretamente do treeview caso o consultor identifique que o sistema não conseguiu encontrar a tag necessária.
Guia Consulta Situação
A guia Consulta Situação deverá ser utilizada para configurar o serviço de consulta situação. Neste novo serviço será possível realizar o cancelamento automático da Nota Fiscal de Serviço, quando a web service retornar um código que identifique que a nota está cancelada. Apenas para os municípios que disponibilizarem o serviço de cancelamento via web service.
Importante: para atender os WebServices de prefeituras que esperam receber alguns parâmetros de tipos complexos, foi desenvolvido uma nova versão da NFS-e Configurável v2.00. Nesta nova versão, foi atualizada a DLL responsável pela comunicação e as rotinas para gerar os XMLs. Para maiores informações consultar o tópico “Como tratar a NFS-e Configurável Versão 2.0 com e sem modelo complexo?”.
Quais as opções do Gerenciador NFS-e?
Se no cadastro de séries, a série já estiver configurada corretamente, as notas serão levadas automaticamente para o gerenciador NFS-e, conforme abaixo:
Filtros:
Unidade de Negócio: informe a unidade de negócio das Notas Fiscais de serviço (campo obrigatório).
Série: informe a série das Notas Fiscais de serviço (se ficar em branco busca todas as séries).
Nota Fiscal: informe a faixa de Notas Fiscais de serviço (se ficar zerado busca todas as notas).
Cliente: informe a faixa de clientes (em branco considera todos os clientes).
Data Emissão: informe o período das Notas Fiscais de Serviço que devem ser enviadas.
Status: informe qual o status das notas que serão filtradas. Opções:
- Todos;
- 1 - Não enviado (somente as notas que ainda não foram enviadas);
- 2 - Enviado (somente as notas que já foram enviadas);
- 3 - Confirmada (somente as notas que retornaram sem erro e com número de NFS-e da prefeitura);
- 4 - Erro (somente as notas que retornaram com erro. Deve ser ajustado conforme o erro retornado e enviada novamente);
- 5 - Cancelada (somente as notas que foram canceladas na prefeitura).
Lote: informe a faixa dos valores de lote das notas fiscais.
TG: TG Tipo de Operação com o objetivo de listar somente as Notas Ficais que possuírem os tipos de operações existentes na TG.
Importante: antes de fazer o primeiro envio deve-se configurar o sistema, na guia ‘Configurações’, conforme abaixo:
Guia Configurações
Natureza de operação: serão apresentadas as naturezas cadastradas no Cadastro NFS-e Configurável através do botão ‘Natureza’ da guia ‘Envio’ do município correspondente a Unidade de Negócio. Deve ser informado onde será feita a tributação. As opções apresentadas nessa opção são configuráveis via Cadastro da NFS-e.
Como exemplo de opções a serem cadastrada podemos citar:
- 1 – Tributação no município
- 2 - Tributação fora do município
- 3 - Isenção
- 4 - Imune
- 5 – Exigibilidade suspensa por decisão judicial
- 6 – Exigibilidade suspensa por procedimento Administrativa
Regime Especial: deve ser informado o Código de identificação do regime especial de Tributação, com as opções:
- Nenhum
- 1 – Microempresa municipal
- 2 - Estimativa
- 3 – Sociedade de profissionais
- 4 – Cooperativa
Para o município de Itajaí/SC não deve ser informado o Regime Especial, conforme definição da prefeitura local. Dúvidas entrar em contato com a prefeitura.
Tributa Município Prestador: deve ser informado onde será recolhido o imposto e deve ser preenchida com "0" quando não tributar p/ prestador e "1" quando tributar p/ prestador.
Situação Tributária: este código caracterizará de que forma será cobrado o ISS. Buscará o código informado no cadastro da “atividade da empresa” no campo “Situação Tributária”. Caso não estiver informado será levado o código informado na tela de configurações.
Envio da NFS-e: informar o caminho onde serão salvos os arquivos de envio.
Retorno da NFS-e: informar o caminho onde serão salvos os arquivos de retorno.
Tipo de Ambiente: informe o tipo de ambiente que será emitida a NFS-e, produção ou homologação.
Forma de Envio: informe qual a forma de envio, com as opções:
- Manual: deve ser feito o envio e o retorno manualmente;
- Automática: após enviar já será feito o retorno e a impressão da NFS-e;
- Sem Impressão: após enviar já será feito o retorno, porém não será impresso automaticamente.
Botão <Selecionar Modelo Impressão>: Seleciona o modelo que será utilizado para imprimir a NFS-e. Algumas prefeituras, ao confirmar a nota, disponibilizam o modelo de impressão. Marcando a opção ‘Automático’, se houver o modelo da prefeitura será impresso o da prefeitura, senão será impresso conforme configurado no botão ‘Alterar Modelo’. Se selecionada a opção ‘CIGAM’, sempre será utilizado o modelo selecionado no botão ‘Alterar Modelo’.
Para utilizar o modelo automático deve ser realizada configuração no botão impressão do cadastro da NFS-e.
Botão <Configurações>
No botão ‘Configurações’ foram disponibilizadas as seguintes opções:
‘Enviar email ao confirmar/ cancelar a NFS-e - #1’: quando selecionada será enviado o email após a confirmação da NFS-e, ou após o cancelamento da NFS-e será enviado o XML de cancelamento automaticamente para o email.
Observação: não apresentará na Gerenciador NFS-e a mensagem de email enviado com sucesso quando realizado o envio de várias notas ao mesmo tempo.
‘Considerar alíquota de ISS com 4 casas decimais -#2’: quando esta opção estiver selecionada a tag ‘Aliquota’ será gerada com 4 casas decimais.
Observação: para o município de Canoas/RS deverá estar selecionada esta opção.
‘Não incluir observações do Simples Nacional na descrição do item - #3": quando esta opção estiver selecionada e a Unidade de Negócio for optante pelo Simples Nacional, não serão geradas as observações referentes ao Simples Nacional na tag ‘Discrimacao’.
‘Zerar valor de ISS para empresas optantes pelo Simples Nacional - #4’: quando selecionada esta opção e a Unidade de Negócio for optante pelo Simples Nacional, será zerada a tag ‘ValorIss’.
Devido ao fato de algumas prefeituras municipais não exigirem o Código CNAE ou não possuírem seus cadastros no padrão da CONCLA foram disponibilizadas dentro do botão "Configurações" as seguintes opções:
‘Não gerar a tag referente ao Código CNAE - #5’: quando selecionada não será gerado no xml a tag ‘CodigoCnae’.
‘Não gerar a tag referente ao Código CNAE de serviço - #6’: quando selecionada esta opção não será gerado no xml a tag ‘CodigoTributacaoMunicipio’ referente ao Código CNAE Serviço da Unidade de Negócio.
‘Imprimir descrição detalhada do material no XML - #7’: quando selecionada passa a imprimir a tag ‘Discriminacao’ com a descrição do material no seguinte formato: "1- NOME SERVICO1 QTD: XX.XXXX VLR UNITARIO: XX.XXXX TOTAL: XX,XX. 2- NOME SERVICO2 QTD: XX.XXXX VLR UNITARIO: XX.XXXX TOTAL: XX,XX.".
Exemplo:
‘Utilizar a Série Oficial e Sub Série Oficial concatenadas para compor a tag ‘Serie’ do XML - #8’: quando selecionada o sistema passa a concatenar a Série Oficial e Sub Série Oficial para compor a tag ‘Serie’ do XML de envio.
Ao enviar a Nota Fiscal o XML de envio será criado concatenando as duas na tag ‘Serie’:
‘Adicionar apenas o e-mail do contato zero no XML de envio. - #10’: quando selecionada esta opção o sistema levará para a tag ‘Email’ do XML de envio apenas o e-mail do contato zero do cadastro do cliente.
‘Permite tomador não identificado, conforme regime especial - #12’: para os casos em que o prestador do serviço possui regime especial na Prefeitura Municipal.
‘Limite de caracteres para discriminação – #13’: o tamanho da discriminação do serviço prestado pode variar para cada prefeitura. Poderá informar o tamanho máximo da discriminação no campo disponibilizado. Se a quantidade de caracteres da discriminação for superior à que for informada neste campo, o CIGAM levará para o XML, na variável <!$MG_i_discriminacao>, apenas parte da descrição, conforme limite parametrizado. Caso este valor não seja informado, o CIGAM continua considerando o limite máximo de 5000 caracteres.
Como enviar, retornar e anular um NFSe?
Para utilização do WebService, deve ser configurado o tipo de ambiente para envio em produção ou homologação (opções somente estarão habilitadas quando a DLL estiver instalada).
Para fazer o envio da nota fiscal basta selecionar e utilizar a opção ‘Enviar’.
Será gerado um arquivo temporário com o XML para que este seja assinado com o certificado digital informado na configuração ‘LF - NE - 1721 - Nome da empresa no certificado digital’ ou ‘LF - NE - 2250 - Nome da empresa no certificado digital’ . Este arquivo é gerado na pasta temporária do Windows (%TEMP%) com o nome envioLote.xml.
Após assinado o arquivo será automaticamente enviado conforme configurado os serviços no Cadastro NFSe. Se o envio for realizado com sucesso, o arquivo será copiado para o caminho dos arquivos de envio informado na guia de configurações. O nome do arquivo é o número do lote gerado. Será possível visualizar os arquivos tanto de envio como o de resposta do envio através dos botões ‘XML Envio’ e ‘XML Retorno’.
Caso ocorra erro no envio relacionado a configuração incorreta do ambiente para envio, a DLL acusará erro na forma de mensagem na tela. Exemplo de erro (informado um endereço inválido no web service):
Neste caso a nota permanecerá com o status de ‘Não enviada’ para que seja permitido o reenvio quando configurar o sistema corretamente.
Caso o envio seja feito com sucesso, mas ocorra erro na validação realizada pela prefeitura o status será alterado para erro e será exibido o erro em vermelho logo abaixo do cliente na tela de seleção de notas fiscais.
Através dos botões ‘XML Envio’ e ‘XML Retorno’ será possível visualizar os XML’s enviados e o que a prefeitura retornou como erro.
Caso a prefeitura não encontre erro será retornado um número de protocolo vinculado ao envio do lote. Este número de protocolo será exibido na coluna ‘Protocolo’ e o status da Nota Fiscal será alterado para ‘Enviado’. O botão de selecionar ficará então desabilitado sendo possível posicionar sobre esta nota e clicar em retornar para que seja feita a consulta do protocolo.
Caso não ocorra erro, será gravado o número da NFS-e e o código de verificação, alterando o status para ‘Confirmada’, conforme configurado no Cadastro da NFSe.
Ao retornar a nota, caso a prefeitura ainda não processou a nota, será apresentada a seguinte mensagem:
O usuário deverá aguardar alguns segundos e clicar no botão “retornar” novamente.
Obs.: Se na guia “Configurações” estiver selecionado o modo de envio “Automático” ou “Sem Impressão”, ao enviar a nota já será feito automaticamente a consulta do protocolo alterando o status diretamente para “Erro” ou “Confirmado”, sendo que quando está como “Automático” se houver a confirmação da nota, já fará a impressão automaticamente.
Cancelamento
Se por acaso for preciso fazer o cancelamento da NFS-e Confirmada, será possível anular esta nota junto à prefeitura através do botão ‘Anular’ (o botão somente fica disponível quando a nota estiver confirmada). O cancelamento automático dependerá se a Prefeitura Municipal disponibilizou este serviço via web service. Caso o mesmo não tenha sido disponibilizado será necessário na guia Cancelamento do Cadastro da NFSe Configurável selecionar a opção ‘Este município não permite cancelamento via web service.’
Importante: Com o objetivo de restringir o acesso à opção de anular Notas Fiscais de Serviço Eletrônicas, o Gerenciamento NFS-e Configurável passa a habilitar o acesso ao botão ‘Anular’ somente para os usuários que possuírem os direitos ‘GERENTE FATURAMENTO’ e ‘EXCLUI NOTA FISCAL’. Caso o usuário não possua um dos direitos, não será possível anular a nota. Será necessário possuir ambos os direitos.
Cancelamento via web service:
Para cancelar é preciso informar o motivo do cancelamento da nota. Será exibida uma tela com as possíveis opções de cancelamento. É obrigatório informar uma das opções disponíveis.
Ao confirmar será feita a solicitação de cancelamento junto à prefeitura. Irá alterar o status para ‘Cancelado’ e irá excluir todos os correlatos da nota fiscal.
Também será possível enviar email de Notas Canceladas. Será enviado para o email o XML de cancelamento.
Cancelamento sem web service:
Cancelamento: Nota Substituída / Substituta via webservice
Para atender os municípios que exigem a informação de uma Nota Fiscal Substituta no cancelamento de notas, ao clicar na opção ‘Anular’ do Gerenciamento NFS-e Configurável será apresentada uma tela onde poderá ser informada a Nota Fiscal Substituta (número da nota no CIGAM) antes de informar o motivo do cancelamento. Esta informação será apresentada no XML de envio na tag <MotivoCancelamento> com o texto: “NFSe Substituída pela nota xxxxxx”. A Numeração apresentada no XML será o número da nota junto à Prefeitura Municipal. No cadastro de Notas Fiscais de Saída, a nota substituída deverá ser informada nos campos ‘Nota Referência’ e ‘Série Referência’, da Nota Fiscal Substituta, para que desta forma ao enviar a Nota Fiscal seja apresentado no XML de envio que esta nota está substituindo a Nota Fiscal informada, e também será criada esta informação no botão ‘Observações’ da Nota Fiscal e assim será impresso no DANFE nas 'Informações complementares'.
Para configurar os XMLs de envio e cancelamento foram disponibilizadas as variáveis: <!$MG_nro_nf_substituta_envio>,<!$MG_nro_nf_substituta_canc>, <!$MG_desc_nf_substituta_envio>, <!$MG_desc_nf_substituta_canc>.
Deverá ser selecionada a opção ‘Utiliza NF Substituta’ e ‘Via Webservice’:
Simulação:
Nota a ser cancelada (substituída):
Criar uma nota substituta informando o número da nota que será cancelada (acima):
Nos campos de Nota Referência informar a nota a ser substituída (nota a ser cancelada):
Enviar a Nota Fiscal à Prefeitura:
No XML será apresentado o número da nota na prefeitura:
Ao enviar a nota será criada a observação na nota:
Cancelar a Nota substituída após a confirmação da Nota substituta:
Ao clicar em ‘Anular’ será apresentada tela para informar o número da nota substituta (nº da nota no CIGAM), antes de solicitar o ‘motivo de cancelamento’. Caso não seja informado um número, seguirá o processo atual.
As informações da Nota Substituta serão enviadas no XML de cancelamento.
Importante: É necessário ter um de XML modelo válido pela prefeitura informado no Cadastro NFSe Configurável na guia Cancelamento para realizar o cancelamento da nota.
Existem algumas prefeituras que permitem a confirmação da nota substituta no processo de cancelamento da nota fiscal, dependendo do modelo disponibilizado pela prefeitura, não é necessário fazer a confirmação da nota fiscal substituta antes cancelar a nota que se quer substituir. O CIGAM está preparado para receber essa informação no momento em que é informado a numeração da nota substituta, independente se estiver confirmada ou não, caso o sistema detecte que essa nota não foi confirmada, ao retornar do cancelamento, confirmará a nota substituta.
Cancelamento: Nota Substituída / Substituta sem webservice
Para atender os municípios que exigem a criação de uma Nota Fiscal Substituta no cancelamento de notas, mas que não utilizam serviço de cancelamento via webservice, o usuário deverá realizar o cancelamento/substituição da nota através do site da Prefeitura Municipal. Como não existirá comunicação com o CIGAM através desse processo, então deverá ser selecionada, no Cadastro NFSe na guia Cancelamento, a opção ‘Utiliza NF Substituta’ e também a opção ‘Sem webservice’. Assim, o usuário poderá realizar o cancelamento e confirmação da nota substituta sem realizar a comunicação, mas atualizando os dados para que estejam alinhados nos dois ambientes (site prefeitura e CIGAM).
No Gerenciador, selecionar uma nota e através do botão ‘direito’, selecionar a opção ‘Substituir’. Esta opção ficará habilitada somente quando a opção ‘Sem Webservice’ estiver marcada e o status da Nota Fiscal selecionada for igual a ‘3-Confirmado’. Será apresentada uma tela solicitando as informações da Nota Substituta geradas no site da Prefeitura.
Simulação: Nota substituta que deverá ser informada no processo de cancelamento/substituição:
Importante: o status da Nota Substituta deve ser igual a “Não enviado”.
Nota confirmada que será substituída. Selecionar nota para habilitar a opção ‘Substituir’:
Na tela abaixo deverão ser informados os dados da Nota Substituta. O campos: ‘Código de verificação’, ‘Nº da NF Prefeitura’ e ‘Protocolo’ serão fornecidos no site da prefeitura ao realizar o cancelamento/substituição:
Lembrando que a nota a ser informada nesta tela deverá ter status igual a “Não Enviado”. Caso seja informada uma Nota com status diferente apresentará mensagem:
Ao substituir a nota, a opção ‘Nota Substituída’ será selecionada no gerenciador. A nota terá o status atualizado para ‘Cancelado’ e seus correlatos serão excluídos.
Os correlatos serão excluídos, assim como já ocorre no cancelamento:
E a nota substituta terá seu status alterado para ‘Confirmado’ e atualizará os dados informados. Lembrando que todo o processo será sem comunicação com a prefeitura.
Número NFS-e e Código de Verificação
Nas Notas Fiscais com Status NFe Confirmado, será apresentada as informações de ‘Número NFS-e’ e ‘Código de Verificação’. Na impressão da Nota substituta nas observações apresentará a nota substituída:
Como enviar e retornar múltiplas Notas Fiscais?
Caso haja a necessidade de enviar Notas Fiscais em lote e a Prefeitura Municipal do emitente permita esta situação, será necessário acessar o Cadastro NFSe Configurável e selecionar a opção ‘Permitir Enviar Múltiplas Notas’. Ao selecionar esta opção ao acessar o Gerenciador NFSe Configurável será permitido selecionar múltiplas notas fiscais para envio à Prefeitura. Caso esteja desmarcada, ao selecionar uma nota fiscal as demais serão desabilitadas para seleção no Gerenciador. Lembrando que caso o município não permita o envio de múltiplas notas será apresentado erro ao tentar enviar.
Com a opção marcada permitirá selecionar múltiplas notas para envio:
Caso a opção esteja desmarcada:
Ao selecionar uma nota, as demais ficam desabilitadas para seleção e será apresentada mensagem ao posicionar-se sobre a nota selecionada:
No envio em lote deverão ser selecionadas todas as notas desejadas. O sistema irá enviar todas as notas selecionadas gerando um lote para cada nota.
No Gerenciador NFS-e Configurável, caso não seja selecionada nenhuma nota e seja pressionado o botão ‘Marcar Todas’ a seleção será realizada começando a marcar a primeira nota da tela, e marcará todas com o mesmo status desta nota. Marcando várias notas ao enviá-las o envio será em lote. As notas terão o ‘Status’ alterado para “Enviado”, e após a atualização do status as mesmas serão desmarcadas. Para realizar o retorno em lote, marcar todas as notas com ‘Status’ igual a “Enviado” e pressionar o botão ‘Retornar’ para retornar em lote:
Todas as notas selecionadas serão retornadas com ‘Status’ igual a “Confirmado” ou “Erro”.
Como parametrizar a NFSe para atender a Lei 12.741 (Valor aproximado dos tributos)?
Para atender as obrigações legais referentes a Lei 12.741 (Diário Oficial da União 10/12/12) que instituiu informar nos documentos fiscais de venda a consumidor de mercadorias e serviços o valor correspondente a totalidade dos Tributos Federais, Estaduais e Municipais, conforme a tabela IBPT - Instituto Brasileiro de Planejamento Tributário, disponibilizamos as variáveis: "<!$MG_total_imposto_aproximado>" e “<!$MG_i_total_imposto_aproximado>” para os arquivos XML que consideram os impostos aproximados, seguindo as mesmas regras feitas para a Nota Fiscal Eletrônica na NT 2013/003.
A tag do XML, bem como a variável do DANFE, somente serão impressas se estiver marcada a configuração de Tipo de Operação “Destacar o ‘Valor aproximado dos tributos’ cfe Lei 12.741 (Lei da Transparência)/Nota Técnica 2013/003 #130”, conforme abaixo.
No cadastro do item deverá existir uma NCM e nesta as alíquotas informadas:
1) No campo ‘Origem Mercadoria’ está igual a “0 Nacional”:
E será necessário selecionar no Tipo de Operação no botão ‘Configurações’, na guia ‘Outras’ a opção “Destacar o 'Valor aproximado dos tributos' cfe Lei 12.741 (Lei da Transparência)/Nota Técnica 2013/003.”
Na Nota Fiscal de Serviço os valores aproximados dos tributos destacados nos item e no total da nota serão apresentados na tag de discriminação.
2) Importação:
3) Caso não exista alíquota informada na NCM não será realizada nenhuma validação no sistema, apenas não será gerada a observação no XML da NFSe.
Tributos Municipais
Para calcular os tributos municipais é preciso estar informada a coluna ‘Municipal’ no botão ‘Tributos’ da Classificação Fiscal.
No Cadastro do Material o ‘Tipo’ deve ser igual ‘ “Serviço” e deve estar informado o campo ‘Origem Mercadoria’:
Variáveis para a impressão do tributo municipal:
- <!$MG_i_total_imposto_aproximado> mostra todos os valores.
- <!$MG_i_valor_municipal> tributo municipal item
- <!$MG_total_imposto_municipal> tributo municipal total nota
Também pode ser parametrizado nas observações complementares:
- <!$MG_observacao_pagina_1>
- <!$MG_observacao_pagina_2>
Como realizar a impressão da descrição do Serviço Municipal nas Notas Fiscais de Serviços Eletrônica - NFSe?
Primeiramente é necessário que no Cadastro da Empresa da Unidade de Negócio seja informado através do botão ‘Serv. por Material’ a ‘Descrição do Serviço Municipal’ para o serviço a ser prestado.
Após o cadastro o usuário emitirá a Nota Fiscal desta Unidade de Negócio para o serviço cadastrado.
Enviar a Nota Fiscal à Prefeitura:
Para realizar a impressão da descrição do serviço municipal o modelo deverá possuir as variáveis: <!$MG_desc_servico_municipal> para a Nota Fiscal, e/ou a variável <!$MG_i_desc_servico_municipal> para a descrição por item:
Como será gerada a informação da tag <MunicipioPrestacaoServico>?
Para a geração do arquivo XML de Nota Fiscal Configurável disponibilizamos a variável <!$MGIF_tributacao_fora_municipio>, para identificar pela Natureza da Operação quando a tributação for fora do município do prestador. No Cadastro de NFSe Configurável no botão ‘Natureza’ foi disponibilizada a coluna ‘Local Tributação’ para indicar se a tributação é fora ou dentro do município do prestador.
Dados da empresa prestadora do serviço (Unidade de Negócio). No exemplo, o município é ‘Novo Hamburgo’.
1) Exemplo: cliente fora do município – Porto Alegre:
Nota com prestador: Novo Hamburgo e cliente: Porto ALEGRE
Natureza Operação = “2”:
Como o cliente é fora do município do prestador o código IBGE é do tomador.
2) Cliente fora do município e Natureza Operação = ‘1’
Neste caso, deverá apresentar na tag o código do município prestador: 4313409
3) Exemplo: cliente no mesmo município do prestador
Deverá trazer o código do município prestador: 4313409
Como utilizar a regra de natureza ‘Conforme Tipo de Operação’ no Gerenciamento NFS-e Configurável?
Para o modelo de impressão podem ser utilizadas as variáveis merge <!$MG_natureza_nfse_config> e <!$MG_desc_natureza_nfse_config>.
Exemplos:
Cadastro da Natureza através do Cadastro NFSe Configurável:
imagem 162
imagem 163
Unidade de Negócio:
imagem 164
Cliente da nota:
imagem 165
Tipo de Operação da nota:
imagem 166
imagem 167
imagem 168
imagem 169
imagem 170
Como no Gerenciador está ‘Conforme Tipo Operação’ e o Tipo de Operação da nota tem ISS = Sim e alíquota informada e o cliente é ‘Dentro’ do Município’, no XML na tag de natureza deverá apresentar “1A Tributação no Município” conforme a regra criada na natureza.
imagem 171
imagem 172
Impressão:
imagem 173
imagem 174
imagem 175
imagem 176
imagem 177
iamgem 178
imagem 179
Como no Gerenciador está ‘Conforme Tipo Operação’ e o Tipo de Operação da nota tem ISS = Retenção e alíquota informada e o cliente é ‘Dentro’ do Município’, no XML na tag de natureza deverá apresentar “1B Tributação no Município” conforme a regra criada na natureza.
imagem 180
imagem 181
No próximo exemplo, temos um cliente ‘Fora’ do município e tipo de operação = sim e alíquota informada.
imagem 182
imagem 183
imagem 184
imagem 185
imagem 186
No XML na tag <NaturezaOperação> deve trazer “2A Tributação outro município” conforme a regra cadastrada na natureza.
imagem 187
imagem 188
O seguinte exemplo, mostra como será para a ISENÇÂO. Isenção será quando a ‘Incidência’ de ISS for igual a “Sim”, mas a alíquota for zero.
imagem 189
Nota dentro município:
imagem 190
Na regra da Natureza deverá estar selecionado o check ‘Isenção’:
imagem 191
imagem 192
imagem 193
imagem 194
Importante: Caso no Gerenciamento NFSe Configurável o campo ‘Natureza Operação’ esteja diferente de “Conforme Tipo de Operação” então ao enviar a NFSe o XML será gerado com esta opção, ignorando as regras cadastradas.
Exemplo:
imagem 195
imagem 196
imagem 197
Deverá buscar a Natureza Operação do Gerenciador, ignorando as regras:
imagem 198
imagem 199
imagem 200



































































