Extensão InvoiCy Tax Template

Índice

1. Índice

Estamos disponibilizando uma nova extensão no InvoiCy, o InvoiCy Tax Template. Essa nova extensão foi desenvolvida com objetivo de facilitar a busca de informações essenciais para emissão de Notas Fiscais de Serviços. Por meio dela é possível obter informações como Particularidades dos Padrões, Naturezas de Operação, Códigos de Tributação do Município (TributMunicipio), Itens da Lista de Serviços (IteListServico), Descrições dos Serviços, Alíquotas, Observações das Alíquotas, Retenção de ISS e INSS, Domicílio do ISS (local de pagamento), Data de Início de Vigência da Lei, Fonte da Base Legal das Informações, Formato do Item da Lista de Serviços e Observações de cada município.

Importante: As informações retornadas pela extensão InvoiCy Tax Template dependem dos dados disponibilizados pelas prefeituras. Portanto, a Migrate se resguarda em não retornar dados de um município, caso estes não estejam disponíveis.

Ativação da Extensão

Para utilização dos serviços apresentados a seguir é necessária a ativação da Extensão InvoiCy Tax Template e dos municípios que o parceiro deseja consultar as informações.

No InvoiCy, a nova extensão pode ser acessada através do menu de Extensões, por meio do ícone correspondente ao InvoiCy Tax Template.

Ao clicar no ícone será aberta a tela com as informações da extensão.

A ativação dos municípios para realizar a consulta dos dados para emissão é realizada na aba ‘Ativação’, marcando a opção ‘Ativar’ e confirmando a ação na janela que será apresentada.

Nessa tela é possível realizar a ativação de um município individualmente ou de todos os municípios disponíveis na extensão. A busca por municípios poderá ser realizada por meio do código IBGE e Nome, sendo possível filtrar ainda por UF e status.

Para os municípios que constam na lista como “Não habilitados” será possível realizar a solicitação de mapeamento das informações. Para solicitar a habilitação de um município deve ser marcada a opção na coluna “Solicitar”. Essa solicitação será enviada para a Migrate, que dará início ao levantamento das informações e atualização dos dados no InvoiCy. Após esse processo será possível consultar os dados via integração e via tela no sistema.

Ativação via web service

A ativação da extensão também pode ser realizada no momento do cadastro da empresa, para empresas novas, ou por meio da atualização das informações de uma empresa já cadastrada no InvoiCy.

Em ambos os casos, é preciso adicionar o grupo de informações referentes a nova extensão no layout de cadastro de empresas, conforme exemplos a seguir.

Para integração via SOAP

TipoExtensao – Código da extensão que será ativada. Para InvoiCy Tax Template informar ‘10’.

Módulo – Módulo para o qual a extensão será ativada. Informar ‘NFSe’.

MunicipiosAtivar – Informar o código do IBGE do município que deseja ativar para consultar as informações. Podem ser informados vários códigos usando o separador ‘;’ ou a palavra ‘Todos’, ativando assim todos os municípios habilitados na extensão. Para ativar um município também é necessário informar o campo Ativar como ‘S’.

Somente serão retornadas informações dos municípios já habilitados na extensão e que foram ativados pelo parceiro na extensão InvoiCy Tax Template.

MunicipiosDesativar – Informar o código do IBGE do município que deseja desativar na extensão. Podem ser informados vários códigos usando o separador ‘;’ ou a palavra ‘Todos’, desativando assim todos os municípios ativos para o parceiro na extensão. Para desativar um município também é necessário informar o campo Ativar como ‘N’.

Ativar – Informar ‘S’ para Ativar a extensão e municípios e ‘N’ para Desativar a extensão e municípios.

Baixe o nosso layout de cadastro de empresas, já atualizado com todas as informações.

Consultar Serviços do Município (REST)

Por meio dessa consulta é possível obter uma listagem de todos os serviços e as naturezas de operação cadastrados em determinado município.

Essa 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, conforme descrito a seguir.

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 no link: https://desenvolvedores.migrate.info/2020/06/10/integracao-via-api-rest-para-emissao-de-documentos/

Exemplos das requisições para consultar a lista de serviços do município podem ser encontrados neste link: https://documenter.getpostman.com/view/9193875/TVzLnKfu#67002792-cb7f-4a1b-8643-f22823963341

Consultar Serviços do Município (SOAP)

Clientes que utilizam integração via SOAP com o InvoiCy podem realizar a busca pelos serviços dos municípios por meio do web service ‘arecepcao.aspx’, o mesmo utilizado para envio de documentos. Para essa consulta é preciso enviar a estrutura a seguir com as informações e os parâmetros desejados.

Faça download do exemplo clicando aqui.

Onde:

Modelo Documento – Disponível apenas para NFSe

CNPJEmissor – CNPJ da empresa cadastrada no InvoiCy

Versão – 1.0 (fixo)

tpAmb – Ambiente de emissão, sendo 1 – Produção e 2 – Homologação

CodMunicipio – Código IBGE do município que deseja consultar as informações

RetornaListaServiço – Retornar a lista de serviços do município, sendo S – Sim e N- Não

RetornaNaturezaOp – Retornar a lista de naturezas de operação do município, sendo S – Sim e N – Não.

Consulta Particularidades dos Padrões

Atualmente a consulta das particularidades de cada padrão de NFS-e integrado com o InvoiCy encontra-se disponível em nosso Portal dos Desenvolvedores, em forma de artigos onde são listadas as características próprias de cada um. Com a nova extensão do InvoiCy, catalogamos todas as particularidades de cada padrão integrado e disponibilizamos para consulta por meio de uma API.

A consulta de particularidades dos municípios foi adicionada à Consulta de Municípios Integrados já disponibilizada pelo InvoiCy, que a partir de agora passa a retornar informações mais completas para aqueles parceiros que tenham o município ativado na extensão InvoiCy Tax Template. Caso o município não esteja ativo, o retorno da consulta de municípios integrados permanece da forma atual, retornando dados básicos.

Para obter as informações completas sobre as particularidades, a consulta deverá ser realizada pelo código IBGE do município.

Informações sobre a consulta de municípios integrados podem ser obtidas no link a seguir: https://desenvolvedores.migrate.info/2016/05/05/consulta-de-municipios-integrados/

Para os parceiros com o município ativado na extensão, o retorno da consulta terá as seguintes informações, além daquelas que já retornam atualmente.

Ainda no Painel de Controle do InvoiCy, é possível acessar uma Lista de Serviços dos municípios. Para isso, adicionamos um novo ícone no grupo de informações de NFS-e, chamado “Lista Serviços Municípios”, por meio dele é 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. Conforme mostra a imagem a seguir.

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

Nessa tela é possível localizar os serviços disponíveis em um determinado município, buscando por meio do 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.

Oferecemos também a possibilidade de exportar as informações listadas em tela para um arquivo .csv, clicando sobre o botão conforme mostra a imagem a seguir.

Ao clicar no ícone “Visualizar” , na última coluna da tela, é possível consultar detalhes de um determinado serviço, como mostra a imagem a seguir.