Pular para conteúdo

Configurações do GNRE via APIs

Antes de realizar a geração e emissão das guias, é necessário configurar informações relacionadas às diferentes opções de tributação para cada UF. Com a possibilidade de cadastrar essas configurações via APIs, o processo se torna mais prático, principalmente para quem utiliza a extensão InvoiCy GNRE de forma integrada com seu sistema de gestão.

Estas APIs permitem incluir, consultar, editar e excluir informações de configuração de receitas, além da possibilidade de consultar previamente as receitas cadastradas para cada UF.

Na sequência, confira a seguir detalhadamente o funcionamento das APIs, que estão disponíveis via Web Service e API REST.

Consultar Receitas

Inicialmente, realize esta consulta para verificar quais os códigos de receita que cada UF aceita para um determinado imposto, com a finalidade informar os dados corretamente no momento de realizar a configuração das guias para cada UF e tpo de imposto. Esta consulta pode ser realizada enviando a seguinte estrutura:

<soapenv:Envelope xmlns:soapenv="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>8e1f33a3a9c68d9a576d4ce8a7d339e3</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.

Para visualizar um exemplo de envio JSON da consulta de receitas, clique aqui.

Na estrutura de envio, os campos CNPJEmpresa e UF são obrigatórios. Entretanto, o campo TipoImposto é opcional, e nele podem ser informados os valores: "DIFAL", "ICMSST", "FCP" ou "ICMS Transporte".

O resultado dessa consulta será uma lista com as informações das receitas utilizadas na UF informada na consulta. Caso informado o campo TipoImposto o retorno irá apresentar somente as receitas conforme o imposto consultado.

Principais Configurações

Abaixo, apresentamos as especificações técnicas para gerenciar o ciclo de vida das suas configurações de guias. Você encontrará o detalhamento dos campos, parâmetros e exemplos necessários para realizar as operações de Incluir, Consultar, Editar e Excluir configurações, permitindo o controle total das regras de tributação diretamente pelo seu sistema.

  • Incluir Configurações: Inicialmente, é necessário utilizar esta funcionalidade para cadastrar informações específicas para cada UF e tipo de imposto, para que seja possível gerar as Guias GNRE pelo InvoiCy.

Para incluir configurações deverão ser enviados dados do CNPJ da empresa, UF, tipo de imposto, inscrição estadual da UF de destino, código da receita, código do produto, convênio e as informações complementares (se for o caso) e o tipo de operação como "I".

Somente poderão ser incluídas configurações que correspondam ao tipo de imposto e receita disponibilizados pela SEFAZ para cada UF. Para saber quais receitas estão disponíveis para determinada UF, pode ser utilizada a funcionalidade "Consultar Receitas", descrita anteriormente.

  • Consultar Configurações: Também está disponível a possibilidade de realizar uma consulta para obter as configurações de impostos e receitas já cadastradas no InvoiCy. O valor informado no campo obrigatório Operacao deve ser "C" para consultar.

  • Editar Configurações: Utilize esta opção, caso seja necessário alterar as configurações inseridas anteriormente no InvoiCy. O valor informado no campo obrigatório Operacao deve ser "A" para editar.

  • Excluir Configurações: Esta funcionalidade permite excluir uma configuração de imposto e receita. O valor informado no campo obrigatório Operacao deve ser "E" para excluir.

Para facilitar a implementação em seu sistema, disponibilizamos abaixo os modelos de integração para as operações detalhadas anteriormente. Você encontrará exemplos das estruturas de envio nos formatos XML e JSON, que contemplam a estrutura necessária para cada tipo de ação:

<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>0cc175b9c0f1b6a831c399e269772661</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.
<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>92eb5ffee6ae2fec3ad71c777531578f</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.
<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>4a8a08f09d37b73795649038408b5f33</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.
<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>827ccb0eea8a706c4c34a16891f84e7b</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.

Para facilitar a sua integração, disponibilizamos também uma documentação completa de exemplos no Postman com a estrutura JSON necessária para as configurações de GNRE. Explore os modelos de envio para cada operação através dos links abaixo:

Após finalizar o processo de configuração das guias, será possível realizar a emissão das guias via tela, automática ou via APIs, conforme descrito nos seguintes artigos: InvoiCy GNRE e Emissão de Guias via APIs.