Exibir código-fonte para Régua de Cobrança Locação

===Índice===
====Visão Geral====

:Essa ferramenta permite o disparo de emails avisando aos Inquilinos/Locatários da disponibilização, pagamento ou atraso do vencimento do boleto. Podendo configurar um texto personalizado incluindo o link do boleto disponível no Icondo.

{| style="border-spacing:0;width:100%;"
| style="background-color:#F18F8F;border:none;padding:0.097cm;width:100px;"| [[Imagem:Atencao.png|center]]
| style="background-color:#F18F8F;border:none;padding:0.097cm;"| 

*:'''Esse módulo é licenciado a parte. Para mais informações, entre em contato com o Suporte da Base Software.'''

|}


Para acessar a ferramente, será necessário a liberação da tela nas configurações de senha do sistema. Com exceção do usuário master.

Caminho: Financeiro>Contas a receber>Régua de Cobrança

==== Procedimentos ====

:Nesse tópico abordaremos as configurações necessárias para o funcionamento da Régua de Cobrança.

===== Textos =====
:Nessa aba será possível cadastrar as mensagens que serão disparadas, e filtrar as mesmas.

<center>''Modelo''</center>
[[Arquivo:Regua_Texto.JPG|center]]
<center>''Caminho: Financeiro > Contas a Receber > Régua de Cobrança > Textos''</center>


A tela é composta dos seguintes campos:

:A) Descrição: Descrição interna da mensagem. Essa informação não será disparada junto com a mensagem sendo somente um localizador para o sistema.
:B) Variáveis do sistema: Combo onde serão listadas as "Tags" que farão referência aos respectivos dados do sistema que poderão ser inseridos no corpo e/ou título da mensagem.
:C) Assunto: Título do e-mail enviado ao destinatário. 
:D) Mensagem: Campo onde será cadastrado o corpo da mensagem.


As variáveis disponíveis no sistema são:

*<code><#DATA_VENCIMENTO_BOLETO></code> Vencimento do boleto [DD/MM/AAAA]: Data de vencimento do boleto padrão "DD/MM/AAAA".

*<code><#DATA_VENCIMENTO_EXTENSO></code> Vencimento Boleto por extenso: Data do vencimento por extenso. Ex: "Sexta-feira, 20 de março de 2020".

*<code><#MES_VENCIMENTO_BOLETO></code> Mês de vencimento do boleto: Exibe o mês de vencimento do boleto no padrão MM/AAAA. Ex."03/2020".

*<code><#MES_VENCIMENTO_EXTENSO></code> Mês de vencimento do boleto por extenso: Exibe o mês de vencimento do boleto por extenso. Ex: Março de 2020.

*<code><#DATA_EMISSAO_BOLETO></code> Data da emissão do boleto: Exibe a data da emissão do boleto.

*<code><#DATA_CORRENTE></code> Data do disparo do e-mail: Exibe a data de disparo do e-mail.

*<code><#LINHA_DIGITAVEL></code> Linha digitável referente ao boleto: Exibe a linha digitável referente ao boleto.

*<code><#VALOR_BOLETO></code> Valor do boleto: Exibe o valor do boleto para pagamento.

*<code><#ITENS_BOLETO></code> Itens do Boleto: Exibe os itens que compõe o boleto.

*<code><#NUMERO_BOLETO></code> Número Boleto: Exibe o número do boleto.

*<code><#E-MAIL_ENVIO></code> E-mail do Destinatário: E-mail pego do cadastro da entidade do Locatário.

*<code><#NOME_PROPRIETARIO></code> Nome do Proprietário: Exibe o nome do proprietário referente ao imóvel.

*<code><#CPF_PROPRIETARIO></code> CPF do Proprietário: Exibe o CPF do proprietário referente ao imóvel.

*<code><#ENDERECO_IMOVEL></code> Endereço do Imóvel: Endereço informado no cadastro do Imóvel.

*<code><#NOME_LOCATARIO></code> Nome do Locatário: Exibe o nome do locatário que está ligado ao imóvel.

*<code><#CPF_LOCATARIO></code> CPF do Locatário: Exibe o CPF do locatário que está ligado ao imóvel.

*<code><#ENDERECO_LOCATARIO></code> Endereço da Locatário: Exibe o endereço informado no cadastro do locatário.

*<code><#NOME_FILIAL></code> Nome da Filial: Exibe o nome da Filial que é informado no cadastro de Filiais (Tabelas Gerais > Principais > Filial). Nesse caso, o sistema insere o nome da filial vinculada ao cadastro do proprietário.

*<code><#CNPJ_FILIAL></code> CNPJ da Filial: Exibe o CNPJ da Filial que é informado no cadastro de Filiais. Nesse caso, o sistema insere o CNPJ da filial vinculada ao cadastro do proprietário.

*<code><#ENDERECO_FILIAL></code> Endereço da Filial: Exibe o endereço da Filial que é pego do cadastro de Filiais (Tabelas Gerais > Principais > Filial). Nesse caso, o sistema insere o endereço da filial vinculada ao cadastro do proprietário.

*<code><#TELEFONE_FILIAL></code> Telefone da Filial: Exibe o telefone da Filial atrelada ao proprietário.

*<code><#NOME_GERENTE></code> Nome do Gerente: Exibe o nome do regente do proprietário.


{| style="border-spacing:0;width:100%;"
| style="background-color:#96CFF5;border:none;padding:0.097cm;width:100px;"| [[Imagem:Dica.png|center]]
| style="background-color:#96CFF5;border:none;padding:0.097cm;"|

* Não será permitido a exclusão de mensagens que por ventura estejam sendo usadas no cadastro das [[Régua de Cobrança#Regras|Regras]] de disparo.
* Existem mensagens pré-configuradas com template básico, para que o usuário utilize como [[Régua de Cobrança#Importar Modelo Padrão|modelo]] em sua empresa.
* Inserido na barra de formatação das mensagens um botão chamado '''Duplicar Mensagem''', onde o usuário poderá aproveitar um texto pré configurado como base para uma nova mensagem.

|}


====== Hipertexto ======
:Existem duas formas de inserir o Hiperlink em sua mensagem:
1) Ao clicar no botão "Inserir Hipertexto" localizado na barra de formatação da mensagem.

2) Clicando com o botão direito do mouse na mensagem, o pop-up de "Inserir Hipertexto" será demonstrado.

<center>''Modelo''</center>
[[Arquivo:Regua_Hipertexto.JPG|center]]
<center>''Caminho: Financeiro > Contas a Receber > Régua de Cobrança > Textos''</center>


* Caso a opção "Link do boleto" esteja selecionada será incluído o link para o boleto com a tag <#LINK_BOLETO>.
* Caso a opção "Link customizado" esteja selecionado será incluído um link para uma outra página de escolha do usuário.


{| style="border-spacing:0;width:100%;"
| style="background-color:#F18F8F;border:none;padding:0.097cm;width:100px;"| [[Imagem:Atencao.png|center]]
| style="background-color:#F18F8F;border:none;padding:0.097cm;"| 

'''Ao salvar a mensagem, caso não haja a configuração da API do Icondo, o sistema exibirá a tela de configuração de usuário e senha de integração com o Icondo para que o sistema possa recuperar o parceiro na hora do envio do e-mail.'''

|}


<code><#LINK_BOLETO></code>: Exibe o link do boleto quando este estiver disponível no Icondo.

====== Importar Modelo Padrão ======

:Como dito anteriormente, o sistema trará alguns modelos de mensagens pré-configuradas que poderão ser utilizadas pelo usuário. Os arquivos desses modelos se localizam sempre na pasta "Mailgun" dentro do diretório de instalação do sistema. Ex. C:\Base\Mailgun.

<center>''Modelo''</center>
[[Arquivo:Regua_Modelo.JPG|center]]
<center>''Caminho: Financeiro > Contas a Receber > Régua de Cobrança > Textos''</center>


<!--{| style="border-spacing:0;width:100%;"
| style="background-color:#96CFF5;border:none;padding:0.097cm;width:100px;"| [[Imagem:Dica.png|center]]
| style="background-color:#96CFF5;border:none;padding:0.097cm;"|

Caso o usuário crie novos modelos, os mesmos deverão ser guardados no diretório sugerido acima (Pasta Mailgun).

|}-->

===== Regras =====
:Nesta tela, será permitido cadastrar as regras de disparo de mensagens. Nela o usuário poderá listar as mensagens cadastradas e configurar as mesmas para default da administradora.

{| style="border-spacing:0;width:100%;"
| style="background-color:#96CFF5;border:none;padding:0.097cm;width:100px;"| [[Imagem:Dica.png|center]]
| style="background-color:#96CFF5;border:none;padding:0.097cm;"|

O sistema permite cadastrar até 6 regras para a empresa.
|}


<center>''Modelo''</center>
[[Arquivo:LC-Regua_Regras.JPG|center]]
<center>''Caminho: Financeiro > Contas a Receber > Régua de Cobrança > Regras''</center>


:A tela é composta por um filtro onde será possível filtrar a configuração realizada por código e descrição da mensagem. 

Mas abaixo estará dispostos os campos para cadastro das regras. São eles:

* Código da mensagem: Lista o código das mensagens cadastradas.

* Descrição da mensagem: Lista a descrição das mensagens cadastradas.

* Notificação Pagamento: Checkbox que se marcado indica que a regra em questão será aplicada a cada baixa de recibo.

* Quantidade de Dias: Permite o usuário cadastrar a quantidade de dias da régua de cobrança podendo ser cadastrados números negativos para que a mensagem seja disparada dias antes do vencimento. Caso o usuário preencha o valor 0(zero) este fará referência ao dia do vencimento.

* Observação: Cadastro de observação sobre a regra específica.


{| style="border-spacing:0;width:100%;"
| style="background-color:#F18F8F;border:none;padding:0.097cm;width:100px;"| [[Imagem:Atencao.png|center]]
| style="background-color:#F18F8F;border:none;padding:0.097cm;"| 

'''O sistema não permitirá o cadastro de regras semelhantes. Ex. Caso o usuário tenha cadastrado uma Regra com a "Quantidade de Dias" = 0(zero), a mesma não poderá ser repetida. Mesmo que a mensagem seja diferente! A mesma crítica vale para o "Notificação de Pagamento".'''
|}


====== Notificação de Pagamento ======

:O intuito desse checkbox é o envio de mensagens quando os boletos são pagos (baixados) no sistema.

:Atenção: Somente nesse caso a quantidade de dias ficará desabilitada. Essa regra tem por funcionalidade disparar uma mensagem de agradecimento de pagamento do boleto quando o status do mesmo estiver como baixado.


{| style="border-spacing:0;width:100%;"
| style="background-color:#F18F8F;border:none;padding:0.097cm;width:100px;"| [[Imagem:Atencao.png|center]]
| style="background-color:#F18F8F;border:none;padding:0.097cm;"| 

'''Caso um boleto tenha sua baixa cancelada pela administradora, ao ser baixado novamente, o sistema '''NÃO''' enviará novo e-mail de notificação.'''

|}

===== Fluxograma =====

:Tela onde será demonstrado o fluxo das mensagens, ou seja, quais mensagens serão disparadas e seus respectivos dias (Financeiro > Contas a Receber > Régua de Cobrança > Fluxograma).


<center>''Modelo''</center>
[[Arquivo:LC-Regua_Fluxograma.JPG|center]]
<center>''Caminho: Financeiro > Contas a Receber > Régua de Cobrança > Fluxograma''</center>


<!--====== Relatórios ======

[[Arquivo:Regua_Relatorio1.JPG|center]]

[[Arquivo:Regua_Relatorio2.JPG|center]]
-->

===== Logs =====

:Na tela de Logs (Financeiro > Contas a Receber > Régua de Cobrança > Logs) será possível visualizar/filtrar o status de cada disparo de e-mails, de um forma onde o usuário poderá acompanhar de perto o andamento do processo.

<center>''Modelo''</center>
[[Arquivo:LC-Regua_Logs.JPG|center]]
<center>''Caminho: Financeiro > Contas a Receber > Régua de Cobrança > Logs''</center>


Os possíveis Logs atualmente no sistema, são:

* E-mail Enviado: O aplicativo de envio aceitou a solicitação para enviar/encaminhar o e-mail e a mensagem foi colocada na fila.

* E-mail Não Enviado: O aplicativo de envio rejeitou o pedido para enviar/ encaminhar o e-mail.

* E-mail Entregue: O aplicativo de envio enviou o e-mail e foi aceito pelo servidor de e-mail do destinatário.

* E-mail com Falha na Entrega: Ocorre quando uma mensagem não é entregue. Há várias razões pelas quais o aplicativo de envio pare de tentar 
entregar mensagens e as descarta, incluindo: Devoluções, mensagens que atingiram seu limite de novas tentativas, endereços anteriormente não assinados/devolvidos/queixados ou endereços rejeitados por um Spam.

* E-mail Blacklist: O destinatário do e-mail clicou no botão de reclamação de spam em seu cliente de e-mail.


{| style="border-spacing:0;width:100%;"
| style="background-color:#96CFF5;border:none;padding:0.097cm;width:100px;"| [[Imagem:Dica.png|center]]
| style="background-color:#96CFF5;border:none;padding:0.097cm;"|

Desabilitar a notificação de arquivo disponível no Icondo quando o usuário habilitar a régua de cobrança, afim de evitar que o destinatário receba dois alertas de e-mails.

|}

===== Alertas do Sistema =====

:Alertas sobre a falta de execução do aplicativo de envio dos e-mails.

<center>''Modelo''</center>
[[Arquivo:Regua_Sino.JPG|center]]


{| style="border-spacing:0;width:100%;"
| style="background-color:#96CFF5;border:none;padding:0.097cm;width:100px;"| [[Imagem:Dica.png|center]]
| style="background-color:#96CFF5;border:none;padding:0.097cm;"|

Para maiores informações sobre o funcionamento do alerta, acesse a documentação de [[Alertas do Sistema|Alertas do Sistema]].
|}