A GNRE (Guia Nacional de Recolhimento de Tributos Estaduais) é a guia usada para recolher ICMS e FCP devidos a outra UF. É gerada no Portal GNRE e paga no banco ou via PIX.
Casos de uso
- DIFAL em venda interestadual para consumidor final não contribuinte (receita 100102), quando o emitente não tem inscrição estadual de substituto tributário (IE-ST) na UF de destino.
- ICMS-ST por operação (receita 100099) em venda interestadual com substituição tributária.
- FCP e as demais receitas que a UF favorecida aceita.
Como funciona
- Consulte as regras da UF em Consultar Configuração da UF: as receitas aceitas e os campos que cada uma exige.
- Envie a guia em Gerar GNRE. O portal processa em segundo plano: a resposta volta com
status3 (processando) e oIdda guia. - Uns 30 segundos depois, use Consultar GNRE ou o webhook
gnre.processadapara obter a linha digitável, o PIX copia e cola e o PDF oficial.
Emitente e certificado
- O emitente é a empresa do token: identificado pela inscrição estadual quando ela é inscrita na UF favorecida (IE ou IE-ST cadastrada no painel), senão pelo CNPJ com o endereço.
- O Portal GNRE só aceita transmissões de CNPJ liberado por ele (rejeição 102). Por padrão vai o certificado da empresa, cujo CNPJ precisa ser liberado no portal (Automação > Solicitar acesso ao Web Service, separado para produção e homologação). Em Configurações > Serviços, no painel, a empresa pode transmitir pelo certificado da Brasil NFe, que já é liberado.
Nota: guias geradas em homologação não devem ser pagas.
Gerar GNRE
Envia a GNRE ao Portal GNRE.
Quando usar
Sempre que for preciso recolher ICMS ou FCP para outra UF em guia: DIFAL de venda a não contribuinte, ICMS-ST por operação e as demais receitas que a UF aceita. Os campos de cada receita mudam por UF: consulte antes Consultar Configuração da UF.
Como funciona na API
- Validação dos dados e do XML no schema oficial do Portal GNRE (leiaute 2.00).
- Transmissão do lote com uma guia, com o certificado da empresa ou o da Brasil NFe (ver a visão geral da seção).
- Retorno com
status3 (processando) e oIdda guia. Se o portal recusar o lote na recepção, o retorno vem comstatus2 e o motivo emerros.
O resultado sai uns 30 segundos depois em Consultar GNRE ou no webhook gnre.processada. A Brasil NFe também consulta sozinha as guias em processamento a cada minuto.
Nota: com a verificação do identificador interno ligada, uma guia gerada ou em processamento bloqueia outra com o mesmo IdentificadorInterno; a rejeitada não bloqueia.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, GNRE, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
Gerar GNRE › Request Body
TipoAmbienteTipo de ambiente.
Valores Possíveis:
1: Produção
2: Homologação
UfFavorecidaSigla da UF que recebe o recolhimento (normalmente a UF de destino da mercadoria).
Itens da guia. Um item gera uma GNRE simples; vários itens da mesma receita, uma guia de múltiplos documentos de origem; receitas diferentes, uma guia de múltiplas receitas (cada UF define quais tipos aceita).
IdentificadorInternoCódigo de controle do seu sistema, para achar a guia depois em Consultar GNRE. Com a verificação do identificador interno ligada no painel, é obrigatório e não pode repetir o de uma guia gerada ou em processamento.
DataPagamentoData prevista de pagamento. Não pode ser anterior a hoje nem posterior ao vencimento. Se não for informada, vai a data de hoje.
Gerar GNRE › Responses
Successful operation
IdId da guia na Brasil NFe, usado em Consultar GNRE.
IdentificadorInternoIdentificador interno enviado.
TipoAmbienteAmbiente da guia (Produção ou Homologação).
SituacaoSituação por extenso: Gerada, Rejeitada ou Processando no Portal GNRE.
NumeroReciboRecibo do lote no Portal GNRE.
UfFavorecidaUF favorecida.
ValorValor da guia (o devolvido pelo portal, quando gerada).
DataVencimentoData de vencimento.
DataLimitePagamentoÚltimo dia em que o banco recebe a guia.
LinhaDigitavelLinha digitável (48 dígitos).
CodigoBarrasCódigo de barras (44 dígitos).
PixCopiaEColaPIX copia e cola, quando a UF e a receita aceitam pagamento via PIX.
NossoNumeroNúmero interno da guia gerado pela UF.
NumeroControleNúmero de controle da guia na UF.
Base64PdfPDF oficial da guia gerado pelo Portal GNRE, em Base64. Vem em Consultar GNRE com IncluirPdf quando a guia está gerada.
Lista de erros retornados.
avisosLista de avisos retornados.
statusStatus do retorno.
Consultar GNRE
Consulta uma GNRE pelo Id ou pelo IdentificadorInterno.
Como funciona na API
- Guia ainda processando: a API consulta o Portal GNRE (no máximo uma vez a cada 15 segundos e só 30 segundos depois do envio, como pede o manual do portal) e devolve a situação atualizada.
- Guia gerada (
status1): vêm a linha digitável, o código de barras, o PIX copia e cola (quando a UF aceita) e, comIncluirPdf, o PDF oficial emBase64Pdf. - Guia rejeitada (
status2): o motivo do portal ou da UF vem emerros.
Se o portal estiver fora do ar, a guia continua processando e o problema vem em avisos.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, GNRE, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
Consultar GNRE › Request Body
IdId da guia devolvido em Gerar GNRE.
IdentificadorInternoIdentificador interno da guia, quando o Id não for informado. Se houver mais de uma guia com ele, vem a mais recente.
TipoAmbienteTipo de ambiente. Usado na busca pelo identificador interno.
Valores Possíveis:
1: Produção
2: Homologação
IncluirPdfDevolve o PDF oficial da guia em Base64Pdf quando ela já foi gerada.
Consultar GNRE › Responses
Successful operation
IdId da guia na Brasil NFe, usado em Consultar GNRE.
IdentificadorInternoIdentificador interno enviado.
TipoAmbienteAmbiente da guia (Produção ou Homologação).
SituacaoSituação por extenso: Gerada, Rejeitada ou Processando no Portal GNRE.
NumeroReciboRecibo do lote no Portal GNRE.
UfFavorecidaUF favorecida.
ValorValor da guia (o devolvido pelo portal, quando gerada).
DataVencimentoData de vencimento.
DataLimitePagamentoÚltimo dia em que o banco recebe a guia.
LinhaDigitavelLinha digitável (48 dígitos).
CodigoBarrasCódigo de barras (44 dígitos).
PixCopiaEColaPIX copia e cola, quando a UF e a receita aceitam pagamento via PIX.
NossoNumeroNúmero interno da guia gerado pela UF.
NumeroControleNúmero de controle da guia na UF.
Base64PdfPDF oficial da guia gerado pelo Portal GNRE, em Base64. Vem em Consultar GNRE com IncluirPdf quando a guia está gerada.
Lista de erros retornados.
avisosLista de avisos retornados.
statusStatus do retorno.
Consultar Configuração da UF
Devolve as regras que a UF cadastrou no Portal GNRE: as receitas aceitas e, para cada uma, os campos obrigatórios, as listas de códigos (detalhamentos, produtos, períodos e tipos de documento de origem), os campos adicionais e se aceita PIX.
Quando usar
Antes de montar a guia, para saber o que informar em cada item. O código do tipo de documento de origem, por exemplo, muda de uma UF para outra.
Nota: as regras vêm do portal e valem para todas as empresas; a resposta fica em cache por 6 horas.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, GNRE, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
Consultar Configuração da UF › Request Body
TipoAmbienteTipo de ambiente.
Valores Possíveis:
1: Produção
2: Homologação
UfSigla da UF favorecida.
ReceitaOpcional: devolve só a regra desta receita.
Consultar Configuração da UF › Responses
Successful operation
UfUF consultada.
ExigeEnderecoEmitenteO endereço do emitente é obrigatório quando ele é identificado pelo CNPJ.
Receitas da UF.
Lista de erros retornados.
avisosLista de avisos retornados.
statusStatus do retorno.