Como Ativar e Desativar Notificações por E-mail
Primeiro demonstraremos quais são os IDs para realizar a ativação e desativação das notificações através do link abaixo, onde você será direcionado para a nossa documentação:
https://nfe.io/docs/desenvolvedores/rest-api/nota-fiscal-de-servico-v1/
Após acessar o link você irá rolar a tela para baixo até localizar o botão de “Authorize”:
Em “Authorize” você irá inserir a sua chave de apiKey para realizar o processo de autenticação da sua conta. Em seguida, após realizar a autenticação da sua conta, desça mais um pouco a tela até localizar a URL de “EventTypes” e clique em cima do endpoint para expandi-lo.
Seleciona o botão de “Try it out”, depois o botão “Execute”:
Após selecionar o botão de “Execute” a API irá listar todos os eventos da sua conta que por regra já estarão ativos:
Para realizar a ativação ou desativação das notificações de e-mail para os seus tomadores, será necessário anotar dois IDs relacionados às notificações, e são eles:
Agora que já sabemos quais são os IDs que correspondem às Notas Emitidas e Notas Canceladas, vamos ao próximo passo.
Rolando a sua tela um pouco mais para cima, iremos encontrar as URLs de “CompaniesNotifications”.
Selecione a URL de indicada como “POST” para expandi-la e em seguida selecione o botão “Try it out”:
No campo setado como “ID da empresa”, informe o ID da sua empresa.
Em “Dados de Notificações”, você irá ativar ou desativar as notificações.
Exemplo:
Para desativar uma notificação o json ficará com o seguinte formato:
Feito os passos acima, basta selecionar o botão “Execute” e as notificações que os tomadores recebem estarão ativadas. Para desativar a notificação é só mudar o status de “Active” para “Inactive” e selecionar o botão “Execute”.
Caso considere necessário validar as notificações que você modificou basta listar as notificações de uma empresa utilizando a URL abaixo e informando o ID da sua Empresa:
A URL listará todas as notificações que foram ativadas, ou desativadas por você. Ressaltando que todas as notificações já estão ativadas por padrão, então na chamada acima só serão exibidas as notificações que você personalizou manualmente.