Configurações

Este artigo detalha as configurações de Webhooks para modelos fiscais específicos: NF-e, NFC-e, NFS-e, Certificado Digital e GNRE. Para instruções completas sobre o preenchimento da tela de cadastro de Webhooks, consulte o manual: Cadastro de Webhook via tela.

Nota Fiscal Eletrônica

Para configurar o Webhook via tela para a NF-e, acesse o ícone do mesmo no "Painel de Controle", onde as seguintes notificações estarão disponíveis:

Evento: Assim que um evento de cancelamento é realizado e autorizado, o Webhook enviará uma notificação contendo no JSON o Base64 e o link do XML de evento protocolado. No caso de NF-e, também é retornado o DANFE cancelado.
Documento Recebido: Caso o cliente opte por utilizar essa funcionalidade, o Webhook irá notificar as NF-es de entrada que estiverem com o status de autorizada e cancelada. Serão enviados os dados principais do documento com o PDF e XMLs respeitando a configuração estabelecida nas configurações para emissão da NF-e. Esta funcionalidade se aplica para todos os tipos de importação.
Atualização de Dados: O Webhook irá notificar quando for realizada a importação de um documento recebido já existente.
Documento Inutilizado: Quando uma NF-e for inutilizada, o Webhook irá retornar no JSON o base64 e o link do XML da respectiva inutilização.
Documento Autorizado na SEFAZ: Quando um documento for autorizado, o InvoiCy enviará uma notificação ao endereço cadastrado. O conteúdo da notificação será igual ao retorno de uma consulta de documento e irá respeitar o que estiver configurado na tela de "Configurações para Emissão".

Exemplos de notificações do Webhook para NF-e.

Nota Fiscal de Consumidor

Para configurar o Webhook via tela para a NFC-e, acesse o ícone do mesmo no "Painel de Controle", onde as seguintes notificações estarão disponíveis:

Evento: Assim que um evento de cancelamento é realizado e autorizado, o Webhook enviará uma notificação contendo no JSON o Base64 e link do XML de evento protocolado.
Documento Inutilizado: No momento que uma NFC-e for inutilizada o Webhook irá retornar no JSON o base64 e o link do XML da respectiva inutilização.
Documento Autorizado na SEFAZ: Quando ocorrer a autorização de um documento, o InvoiCy irá enviar uma notificação ao endereço cadastrado. O conteúdo da notificação será igual ao retorno de uma consulta de documento e irá respeitar o que estiver configurado na tela de "Configurações para Emissão" nos campos "Forma de retorno do PDF na integração" e "Forma de retorno do XML na integração".

A NFC-e oferece a possibilidade de configurar o tipo de emissão do documento, podendo ser realizada de forma normal ou em contingência offline. Vale destacar que essa configuração está disponível exclusivamente para a notificação de "Documento Autorizado na SEFAZ".

Após realizar as configurações, basta "Salvar" e as informações ficarão salvas na tela de Webhook da empresa. Esse também pode ser editado ou excluído por completo.

Exemplos de notificações do Webhook para NFC-e.

Nota Fiscal de Serviço

Para configurar o Webhook via tela para a NFS-e, acesse o ícone do mesmo no "Painel de Controle", onde as seguintes notificações estarão disponíveis:

Atualização de Status: Nesta opção, em qualquer alteração de status do documento diferente de 105, será enviado uma notificação via Webhook para o ERP atualizar o documento.

No fluxo síncrono, o RPS é recebido do ERP no InvoiCy e transmitido imediatamente para a prefeitura, devolvendo o retorno ao ERP na mesma conexão. O retorno pode ser autorizado, rejeitado ou até mesmo pendente e em processamento, pois nem todas as prefeituras processam o RPS de forma síncrona também. Caso o RPS não retorne um status definitivo, o ERP precisa efetuar consultas para obter o status do processamento do documento.

No fluxo assíncrono, o InvoiCy recebe o RPS do ERP e apenas devolve o código 105 – pendente. Neste caso, o InvoiCy armazena o RPS em uma fila para transmitir posteriormente à prefeitura, restando ao ERP realizar consultas para obter o status deste processamento.

Evento e Documento Inutilizado: A notificação via Webhook será enviada também quando houver alteração de um Status final para outros Status Final, como, por exemplo, Rejeitado para Autorizado, Autorizado para Cancelado ou Rejeitado para Inutilizado. Além disso, será enviada notificação quando ocorrer a emissão de evento.
Atualização de Dados: Atualização de informações que podem incluir também a atualização de status.
Documento Recebido: Quando uma nota for importada no InvoiCy via tela, via Web Service – Importação de documentos via Web Service, via leitura de caixa de e-mail ou através da consulta automática, será enviada a notificação no formato padrão para o Webhook configurado para o módulo NFS-e.

Na notificação de NFS-e recebida, será enviado também o XML do documento no campo DocCompleto, o formato do XML enviado neste campo será conforme a opção parametrizada no parâmetro "XML InvoiCy no retorno da requisição" na tela de configurações para emissão da NFS-e. No entanto, se este campo estiver parametrizado como "Não", o campo DocCompleto será alimentado com o Layout InvoiCy.

Inclusão na Fila para Consulta: Como alternativa para os clientes que desejam ter um maior controle das NFS-e recebidas, foi criado essa notificação que alerta o cliente sempre que a empresa for adicionada à fila de consulta na prefeitura. A mensagem retornada é a seguinte: "O CNPJ 99999999999999 foi incluído na fila para consulta na prefeitura".
Novo Documento não Encontrado: Será retornada uma notificação assim que a consulta na fila de consulta da prefeitura for finalizada e não localizar nenhum documento emitido contra o cliente.
Novo documento Encontrado: Notificação retornada quando a consulta na fila de consulta da prefeitura for finalizada e encontrar documentos emitidos contra o cliente que não foram importadas da prefeitura. Um detalhe importante é que essa notificação apenas avisa a quantidade de documentos, e não realiza a importação dos mesmos, pois essa ação deve ser feita pelo fluxo de importação que o cliente já utiliza.

Tanto a Inclusão na fila para consulta, novo Documento não encontrado e novo documento encontrado não retornam estrutura de documentos, apenas mensagens de notificação.

Emissão Parada: É enviada quando um documento não pode ser inserido na fila de emissão devido a pendências em documentos anteriores, situação comum em prefeituras que exigem sequência obrigatória de RPS. Quando algum RPS anterior apresenta falhas, rejeições ou inconsistências, o fluxo de emissão é interrompido e os demais documentos não seguem para processamento. O objetivo desse WebHook é informar a paralisação, permitindo a identificação e correção dos RPS que estão impedindo a continuidade da emissão.

Exemplos de notificações do Webhook para NFS-e.

Certificado Digital

Para configurar o Webhook via tela para o certificado digital, acesse o ícone do mesmo no "Painel de Controle", onde a seguinte notificação estará disponível:

Vencimento Certificado: Enviará uma notificação para o Webhook cadastrado informando a necessidade de importar um novo certificado, por conta do atual estar vencido. Junto a isso, serão informados os dados da empresa em questão.

Exemplos de notificações do Webhook para Certificado Digital.

Guia Nacional de Recolhimento de Tributos Estaduais

Para configurar o Webhook via tela para o GNRE, acesse o ícone do mesmo no "Painel de Controle", onde a seguinte notificação estará disponível:

Emissão do Documento: Para os clientes e parceiros que possuem a Extensão InvoiCy GNRE ativada, ao ocorrer a geração de uma guia, GNRE, DARE ou DUA, seja de forma automática ou manual, o InvoiCy irá enviar uma notificação ao Webhook cadastrado contendo informações sobre a guia gerada.

Exemplos de notificações do Webhook para GNRE.