2017
Envio de e-mail via Web Service
20 de outubro de 2017Existe a possibilidade de solicitar o envio de e-mails via Web Service, com o objetivo de permitir que o próprio usuário, via ERP por exemplo, solicite o envio de e-mail de determinados documentos, ou de todos os documentos emitidos em determinada data.
O processo de envio dos e-mails sempre será agendado, independentemente da quantidade de documentos que foram solicitados.
É possível solicitar o envio de e-mails via Web Service de 4 formas, destacando que deve-se escolher apenas uma das opções:
– Solicitar o envio do e-mail de apenas um único documento: deve-se informar a chave de acesso específica do documento e um endereço de e-mail. Será agendado um processo para executar o envio do e-mail posteriormente. Confira um exemplo desse layout de envio na imagem abaixo.
Ao informar um endereço de e-mail, somente este será o destinatário, independentemente do que estiver configurado no documento.
Caso nenhum endereço seja informado, o e-mail será enviado para o e-mail do destinatário informado no documento. Caso o destinatário do documento não possua um e-mail informado, o usuário receberá como retorno o código 113 – Documento [Chave de Acesso] não possui e-mail para envio, e nenhum e-mail será enviado.
Caso o envio do e-mail seja executado com sucesso, o retorno será o seguinte: 100 – E-mail enviado com sucesso.
Para facilitar seu entendimento disponibilizamos um exemplo do layout enviado que está representado na imagem acima, clique aqui para fazer o download.
– Solicitar o envio do e-mail de vários documentos: pode-se informar um conjunto de chaves de acesso com seu respectivo e-mail. Será agendado um processo para executar o envio dos e-mails posteriormente. Confira um exemplo desse layout de envio na imagem a seguir.
Da mesma forma, ao informar um endereço de e-mail somente este será o destinatário. Caso nenhum endereço seja informado, o e-mail será enviado para o e-mail do destinatário informado no documento. E caso o destinatário do documento não possua um e-mail configurado, nenhum e-mail será enviado.
Caso o envio do e-mail seja executado com sucesso, o retorno será o seguinte: 100 – Envio de e-mail agendado com sucesso.
Para facilitar seu entendimento disponibilizamos um exemplo do layout enviado que está representado na imagem acima, clique aqui para fazer o download.
– Solicitar o envio do e-mail de documentos emitidos em um determinado período: pode-se informar um conjunto de datas (de emissão do documento) com seu respectivo e-mail. Da mesma forma, será agendado um processo para executar o envio dos e-mails posteriormente. Confira um exemplo desse layout de envio na imagem abaixo.
Seguindo a lógica dos exemplos anteriores, ao informar um e-mail todos os documentos emitidos naquela data serão enviados para o endereço informado. Caso não informar nenhum endereço, os documentos serão enviados para o e-mail do destinatário de cada documento. E caso o destinatário do documento não possua um e-mail configurado, não receberá nenhum e-mail.
Caso o envio do e-mail seja executado com sucesso, o retorno será o seguinte: 100 – Envio de e-mail agendado com sucesso.
Para facilitar seu entendimento disponibilizamos um exemplo do layout enviado que está representado na imagem acima, clique aqui para fazer o download.
– Solicitar o envio de e-mail por número do RPS (exclusivo para RPS) – para os prestadores de serviço, disponibilizamos o envio de e-mails por numeração de RPS, onde o cliente pode informar um único documento ou uma faixa de numeração para que o InvoiCy realize o envio dos e-mails para o endereço informado. Para utilizar essa opção é preciso enviar para o InvoiCy algumas informações, conforme mostra a imagem a seguir.
Disponibilizamos um arquivo XML de exemplo, para realizar o download clique aqui.
Os possíveis retornos para o cliente, ao solicitar o envio de e-mail via Web Service são:
100 – E-mail enviado com sucesso
100 – Envio de e-mail agendado com sucesso
111 – Falha no envio de e-mail [DESCRIÇÃO DA FALHA]
112 – Documento [CHAVE DE ACESSO] não foi localizado na base de dados
113 – Documento [CHAVE DE ACESSO] não possui e-mail para envio
114 – Não foi localizado nenhum documento emitido na data [DATA DE EMISS]
115 – O e-mail informado é inválido
116 – Chave de acesso inválida
118 – Solicitação ultrapassou o limite de [LIMITE] dias
118 – Solicitação ultrapassou o limite de [LIMITE] documentos
119 – Data inválida
120 – Documento [CHAVE DE ACESSO] não possui um status final da SEFAZ e não será enviado.
É possível ainda configurar se os e-mails que serão enviados irão anexar os arquivos do documento, enviar apenas o link para download dos mesmos, ou não enviar essa informação. A tela de configurações dos e-mails pode ser acessada através do ‘Painel de Controle’, e no módulo desejado clicar sobre a opção ‘Configurações dos e-mails’, conforme demonstra a imagem a seguir.
Na tela de configurações dos e-mails existem os campos “Enviar PDF” e “Enviar XML”, com as opções: ‘Em anexo’, ‘Link para download’ e ‘Não enviar’. Nessa mesma tela também pode-se configurar o texto dos e-mails que serão enviados pela aplicação.
Ao selecionar a opção ‘Em anexo’ para ambos os campos, os arquivos PDF e XML serão anexados junto ao e-mail. Selecionando a opção ‘Link para download’, um link será enviado junto ao texto do e-mail. E marcando a opção ‘Não enviar’, o destinatário do e-mail não receberá os documentos XML e PDF do documento.