Consulta de Municípios Integrados

Última atualização em: 09 de maio, 2016

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.

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:

<ConsultaMunicipiosRetorno>

<listaMunicipios>

<municipio>

<codMunicipio>4300406</codMunicipio>

<nomeMunicipio>ALEGRETE</nomeMunicipio>

 <UF>RS</UF>

<padNome>DB NFSE</padNome>

<tipoIntegracao>Web Service</tipoIntegracao>

<possuiHomolog>S</possuiHomolog>

</municipio>

</listaMunicipios>

<erros/>

</ConsultaMunicipiosRetorno>

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.

<ConsultaMunicipios>

       <ModeloDocumento>NFSe</ModeloDocumento>

       <Versao>1.0</Versao>

       <CNPJEmissor>00000000000000</CNPJEmissor>

       <UF>RS</UF>

</ConsultaMunicipios>

No exemplo acima serão retornados todos os municípios do Rio Grande do Sul integrados no InvoiCy. 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:

 <ConsultaMunicipios>

         <ModeloDocumento>NFSe</ModeloDocumento>

         <Versao>1.0</Versao>

         <CNPJEmissor>00000000000000</CNPJEmissor>

         <tpAmb>2</tpAmb>

</ConsultaMunicipios>

O resultado desta consulta são apenas municípios que possuem ambiente de homologação. 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.

<ConsultaMunicipios>

       <ModeloDocumento>NFSe</ModeloDocumento>

       <Versao>1.0</Versao>

       <CNPJEmissor>00000000000000</CNPJEmissor>

       <codMunicipio>3550308</codMunicipio>

</ConsultaMunicipios>

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.

<ConsultaMunicipios>

       <ModeloDocumento>NFSe</ModeloDocumento>

       <Versao>1.0</Versao>

       <CNPJEmissor>00000000000000</CNPJEmissor>

       <codMunicipio>3550308</codMunicipio>

       <tpAmb>2</tpAmb>

</ConsultaMunicipios>

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.

<ConsultaMunicipios>

       <ModeloDocumento>NFSe</ModeloDocumento>

       <Versao>1.0</Versao>

       <CNPJEmissor>00000000000000</CNPJEmissor>

       <DataInicializacao>2016-01-01</DataInicializacao>

</ConsultaMunicipios>

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

Deixe um comentário

Preencha os seus dados abaixo ou clique em um ícone para log in:

Logotipo do WordPress.com

Você está comentando utilizando sua conta WordPress.com. Sair / Alterar )

Imagem do Twitter

Você está comentando utilizando sua conta Twitter. Sair / Alterar )

Foto do Facebook

Você está comentando utilizando sua conta Facebook. Sair / Alterar )

Foto do Google+

Você está comentando utilizando sua conta Google+. Sair / Alterar )

Conectando a %s