2024
Configuração do WebHook para NF-e e NFC-e
12 de agosto de 2024Neste artigo veremos as configurações do cadastro do WebHook específico para os módulos de NFe e NFCe. 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 os módulos NF-e serão disponibilizados as seguintes opções de notificações:
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 e no caso da NF-e o DANFE cancelado.
Documento Recebido – Esta opção é exclusiva do módulo NF-e, não irá aparecer quando for selecionada a opção de NFC-e ao cadastrar o WebHook.
Caso o cliente opte por utilizar essa funcionalidade, o WebHook irá notificar as NF-e de entrada que estiverem com o status de autorizada e cancelada, será enviado os dados principais do documento (identificação, status, resumo e eventos) junto com o PDF e XMLs respeitando a configuração destes últimos nas Configurações para emissão da NF-e.
Vale ressaltar que essa funcionalidade se aplica para todos os tipos de importação, seja automática pelo NSU, caixa de e-mail, via tela no InvoiCy, InvoiCy conector ou pela chave de acesso.
Atualização de dados – Esta opção também é exclusiva do módulo NF-e. O WebHook irá notificar quando for realizada a importação de um documento recebido já existente.
Documento Inutilizado – No momento que uma NF-e ou 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”.
Ao realizar a configuração do WebHook via tela para o módulo NFC-e serão disponibilizadas as seguintes opções de notificações:
Além de contar com as mesmas notificações já presentes na NF-e, 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.
Arquivos adicionais: Em nossa documentação, disponibilizamos exemplos de retornos das notificações para o módulo de NFS-e. Esses exemplos incluem a estrutura completa, com a descrição detalhada de cada tag retornada durante o processo de notificação.