Configuração do WebHook para NFS-e

Neste artigo veremos as configurações do cadastro do WebHook específico para os módulos de NFS-e. Para saber mais sobre a nova tela de cadastro do WebHook, sugerimos que acesse o manual “Cadastro de WebHook via tela“.

Ao realizar a configuração do WebHook via tela para o módulo NFS-e, serão disponibilizados as seguintes opções de notificações:

Atualização de status – No fluxo síncrono, o RPS é recebido do ERP no InvoiCy e já 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, como autorizado ou rejeitado, por exemplo, o ERP precisa efetuar consultas para obter o status do processamento do documento.

Já 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.

Desta forma, qualquer alteração de status do documento diferente de 105, será enviado uma notificação via WebHook para o ERP atualizar o documento.

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 vento.

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 de NFS-e.

Caso o parâmetro “XML InvoiCy no retorno da requisição” estiver parametrizado como “Nao”, o campo “DocCompleto” será alimentado com o Layout InvoiCy. Clique aqui para visualizar um exemplo da estrutura que será enviada para o WebHook, constando o retorno do XML no campo DocCompleto. Lembrando que para realizar a importação de documentos no InvoiCy, é necessário ativar a Extensão Importação de Documentos.

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.”

Ao finalizar a consulta mencionada acima o Webhook tem a possibilidade de mais duas notificações, são elas:

Novo Documento não encontrado – Aqui é retornada uma notificação assim que a consulta finalizar e não encontrar nenhum documento emitido contra o cliente.

Novo documento encontrado – Notificação retornada quando a consulta finalizar e encontrar documentos NFS-e emitidos contra o cliente que não foram importadas da prefeitura. Um detalhe importante é que essa notificação apenas avisa a quantidade de documentos, não faz a importação dos mesmos, essa ação deve ser realizada pelo fluxo de importação que o cliente já utiliza.

Atenção! 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.