fev
08
2024

APIs de Configuração GNRE

8 de fevereiro de 2024

Índice

-

A Extensão InvoiCy GNRE continua em evolução. Nesta versão do InvoiCy, estamos liberando novas funcionalidades para tornar ainda mais prático o processo, principalmente para quem utiliza a extensão de forma integrada com seu sistema de gestão.

A partir de agora, estamos disponibilizando novas APIs para incluir, excluir, editar e consultar informações de configuração de receitas, além da possibilidade de consultar as receitas cadastradas para cada UF.

Confira a seguir os detalhes das novas APIs, que estão disponíveis em SOAP e REST.

Consultar Receitas

A consulta de receitas de cada UF poderá ser realizada informando os campos conforme a imagem a seguir.

Clique aqui para visualizar o XML mostrado na imagem. Ou clique aqui para visualizar um exemplo no formato JSON.

Os campos devem ser enviados conforme as especificações a seguir:

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.

Clique aqui para visualizar um exemplo XML contendo as informações retornadas pelo InvoiCy.

Incluir Configurações

Para que seja possível gerar as Guias GNRE pelo InvoiCy, é necessário cadastrar informações específicas para cada UF e tipo de imposto. Antes esse procedimento deveria ser realizado manualmente pela tela do InvoiCy, agora poderá ser integrado ao sistema de gestão, utilizando SOAP ou REST.

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.

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.

Disponibilizamos neste link um exemplo XML com os campos necessários. Para visualizar um exemplo em JSON, clique aqui.

A imagem a seguir apresenta a estrutura XML com as informações para cadastrar no InvoiCy:

Clique aqui para visualizar o XML mostrado na imagem. Ou clique aqui para visualizar um exemplo no formato JSON.

Os campos devem ser enviados conforme as especificações a seguir:

Se as informações estiverem corretas, a configuração será cadastrada no InvoiCy.

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. Para realizar essa consulta é necessário enviar a estrutura conforme mostra a imagem a seguir.

Clique aqui para visualizar o XML mostrado na imagem. Ou clique aqui para visualizar um exemplo no formato JSON.

Os campos devem ser enviados conforme as especificações a seguir.

Editar Configurações

Caso for necessário alterar as configurações já inseridas no InvoiCy, deve ser utilizada a estrutura conforme mostra a imagem a seguir.

Clique aqui para visualizar o XML mostrado na imagem. Ou clique aqui para visualizar um exemplo no formato JSON.

Os campos devem ser enviados conforme as especificações a seguir:

Excluir Configurações

Para excluir uma configuração de imposto e receita, basta enviar ao InvoiCy a estrutura conforme imagem a seguir.

Clique aqui para visualizar o XML mostrado na imagem. Ou clique aqui para visualizar um exemplo no formato JSON.

Os campos devem ser enviados conforme as especificações a seguir.