Pular para conteúdo

Consulta de Serviços do Município

Esta consulta tem como intuito retornar informações importantes sobre determinado município, como por exemplo a lista de serviços disponíveis e a lista das naturezas da operação. A consulta pode ser realizada via tela, Web Service ou API REST, variando conforme a necessidade.

Consulta via Tela

Para realizar a consulta de serviços do município via tela, acesse o "Painel de Controle" do InvoiCy, localize o grupo NFS-e e clique no ícone "Lista Serviços Municípios", conforme evidenciado abaixo:

alt text

Por meio deste ícone, é possível consultar os serviços disponíveis em cada um dos municípios que o parceiro tiver ativado na extensão "InvoiCy Tax Template".

Vale destacar, que esta opção está disponível para usuários do tipo parceiro, porém, este poderá disponibilizar ao seu cliente final o acesso à essa opção. Para isso, é necessário alterar as permissões no cadastro do usuário que terá acesso à essas informações.

Também é possível localizar os serviços disponíveis em um determinado município, através dos filtros pelo código IBGE do mesmo, pelo nome do município, código de tributação, código do item da lista de serviços ou pela descrição do serviço.

alt text

Mais informações sobre esta tela podem ser obtidas, consultando o artigo: InvoiCy Tax Template.

Consulta via Web Service

Para realizar a consulta de serviços do município via SOAP, é necessário estabelecer uma comunicação com o Web Service apropriado. Primeiramente, visualize a estrutura WSDL do mesmo:

Em seguida, será preciso realizar o consumo do Web Service para efetuar a integração.

Inicialmente, preencha o XML de envio com as informações necessárias para realizar o envio da consulta. Em seguida, é realizada a geração do hash MD5, conforme orientações do artigo de referência. Além disso, o XML deve ser linearizado, convertido para texto e enviado dentro da tag <inv:Documento> na estrutura SOAP, conforme demonstrado a seguir:

<soapenv:Envelope xmlns:soapenv="[http://schemas.xmlsoap.org/soap/envelope/](http://schemas.xmlsoap.org/soap/envelope/)" xmlns:inv="InvoiCy">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:recepcao.Execute>
         <inv:Invoicyrecepcao>
            <inv:Cabecalho>
               <inv:EmpPK>ABCabcCBAcbaA+CabcCBAc==</inv:EmpPK>
               <inv:EmpCK>a897927ff50396c83052e1a846129c38</inv:EmpCK>
               <inv:EmpCO></inv:EmpCO>
            </inv:Cabecalho>
            <inv:Informacoes>
               <inv:Texto></inv:Texto>
            </inv:Informacoes>
            <inv:Dados>
               <inv:DadosItem>
                  <inv:Documento><!-- (1) --></inv:Documento>
                  <inv:Parametros></inv:Parametros>
               </inv:DadosItem>
            </inv:Dados>
         </inv:Invoicyrecepcao>
      </inv:recepcao.Execute>
   </soapenv:Body>
</soapenv:Envelope>
  1. Neste campo, informe o XML de envio. Para visualizar um exemplo de envio, clique aqui.

No caso de sucesso na emissão, podem ser retornados a lista de serviços e a lista das naturezas da operação do município, juntamente com o código de retorno "100" e a mensagem "Consulta processada com sucesso!". No entanto, se ocorrer alguma falha na emissão, a mesma será retornada e poderá ser corrigida pelo usuário.

Consulta via REST

Por meio da consulta de serviços do município via REST, é possível obter uma listagem de todos os serviços e as naturezas de operação cadastrados em determinado município. Esta consulta é destinada a usuários parceiros, portanto, para a realização da mesma é necessário a geração de um token com os dados da chave de parceiro.

Para geração do token do parceiro deve ser enviada a chave de parceiro no parâmetro "sub", e o parâmetro "partnerKey" não deve ser informado. Os demais campos seguem a mesma estrutura da geração de token para empresas.

Mais informações sobre a geração do token podem ser conferidas, clicando aqui. Enquanto que os exemplos das requisições para consultar a lista de serviços do município podem ser encontrados aqui.