Consulta de Municípios Integrados

Recebemos através de nossos parceiros a sugestão de uma funcionalidade que permita realizar consultas em tempo real dos municípios emissores de NFS-e atendidos pelo InvoiCy. De imediato compreendemos a necessidade deste recurso e também acreditamos ser de grande utilidade para muitos dos nossos parceiros.

Disponibilizamos então através do mesmo Web Service de recepção de notas do InvoiCy um layout de consulta de municípios integrados. A estrutura do xml de entrada encontra-se aqui.

A imagem abaixo representa a estrutura XML do envio de uma consulta.

Os campos ModeloDocumento e Versao são de preenchimento obrigatório. O CnpjEmissor deverá obrigatoriamente ser o CNPJ de uma empresa emissora de NFS-e ativa no InvoiCy, para que possamos controlar eventuais usos excessivos do Web Service.

ATENÇÃO! Somente preencher os campos que informar valor, as demais tags não devem ser informadas.

A estrutura de retorno é a seguinte:

Clique aqui para fazer download do arquivo.

Os filtros possíveis de serem realizados são:

1. Municípios por UF

Permite uma listagem completa de municípios de determinada unidade federativa do Brasil.

No exemplo acima serão retornados todos os municípios do Rio Grande do Sul integrados no InvoiCy. Para baixar o arquivo de envio clique aqui. Veja o exemplo de Retorno (apenas alguns municípios) clicando aqui.

2. Ambiente de emissão

É possível também obter uma listagem apenas dos municípios que possuem determinado ambiente (0-Todos, 1-Produção, 2-Homologação). Para obter os municípios que permitem homologação, por exemplo:

O resultado desta consulta são apenas municípios que possuem ambiente de homologação. Para baixar o arquivo de envio clique aqui. Para visualizar parte do retorno dessa consulta clique aqui.

Porém, pode ser útil ao parceiro verificar se um município específico possui ambiente de homologação. Uma forma de realizar esta consulta seria informar o código do município e não informar o ambiente, verificando no retorno se existe homologação na tag possuiHomolog. O próximo item descreve como proceder.

3. Código IBGE do município

Para verificar se um município específico está integrado no InvoiCy basta preencher o campo codMunicipio.

Para baixar o arquivo de envio clique aqui. Para visualizar o retorno da consulta clique aqui.

4. Tipo de Ambiente

Outra forma de realizar a mesma consulta é especificando na tag de ambiente que gostaria apenas retornar o município se ele tiver homologação.

Para baixar o arquivo de envio clique aqui. Se o município tiver apenas ambiente de produção, será retornada a seguinte mensagem.

5. Data de Inicialização

Este campo é utilizado para verificar todos os municípios que foram integrados a partir de determinada data informada. Quando este campo for informado, os demais campos (UF, codMunicipio e tpAmb) NÃO deverão ser preenchidos, pois iriam interferir no resultado da consulta.

Para baixar o arquivo de envio clique aqui. Para visualizar o retorno da consulta clique aqui.

Importante!

Cada município pode exigir o preenchimento de diferentes campos durante a consulta de notas recebidas. Desta forma, em alguns deles é possível consultar apenas se a sua empresa possuir inscrição municipal na prefeitura, em outros casos será necessário informar previamente de quais prestadores desse município você deseja consultar notas.

Sendo assim, no retorno da consulta a tag ‘importaNotasRecebidas’ poderá conter uma das seguintes opções, de acordo com a particularidade de cada município.

-Web Service: Consulta automática de notas que foram emitidas neste município contra o seu CPF/CNPJ, mesmo que sua empresa não resida nele.

-Web Service (1): Para consultar as notas que recebeu neste município é necessário que tenha uma Inscrição Municipal registrada nele. Sendo a mesma cidade da sua empresa, utilizamos a IM já informada em ‘dados da empresa’, do contrário, será necessário informar em ‘Outros Endereços’.

-Web Service (2): Para consultar as notas que recebeu neste município é necessário informar de quais prestadores você contrata serviços na tela “Prestadores para busca de NFS-e recebidas”. O InvoiCy precisará consultar individualmente para cada fornecedor cadastrado.

-Web Service (3):  É obrigatório preencher os campos “usuário” e “senha” de autenticação da prefeitura nas configurações para a emissão de NFSe.

-ADN:  Município está sincronizando notas com o Ambiente Nacional. Consulta automaticamente por NSU as notas em que o seu CPF/CNPJ é prestador/tomador.

6. Erros

Quando pesquisado um código de município que não existe, a mensagem retornada será a seguinte.

Quando consultado um código de município existente, porém ele ainda não está integrado no InvoiCy, receberá como retorno a seguinte mensagem.

Se possível, poderá ser utilizado uma tabela para exibir os erros informados
ErroCodigo ErroDesc

301 [#inv0301] – O código do município informado não existe ou não foi encontrado.
302 [#inv0302] – Este município ainda não está preparado para emitir NFS-e! Entre em Contato com o Suporte.
303 [#inv0302] – O município informado não possui ambiente de homologação!
304 [#inv0302] – O campo de UF não corresponde a um valor válido.
305 [#inv0302] – Consulta por Data de Inicialização – Para utilizar esta condição utilize APENAS o campo [DataInicializacao].