Mudanças entre as edições de "Régua de Cobrança"
(→Visão Geral) |
|||
Linha 1: | Linha 1: | ||
===Índice=== | ===Índice=== | ||
====Visão Geral==== | ====Visão Geral==== | ||
+ | |||
+ | :Essa ferramenta permite o disparo de emails avisando aos Condôminos, Proprietários e Inquilinos 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="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;width:100px;"| [[Imagem:Atencao.png|center]] | ||
Linha 10: | Linha 13: | ||
|} | |} | ||
− | |||
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. | 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. | ||
Linha 49: | Linha 51: | ||
[[:Categoria:Tutoriais Base Condomínio|Funcionalidades Base Condomínio]] | [[:Categoria:Tutoriais Base Condomínio|Funcionalidades Base Condomínio]] | ||
+ | |||
+ | |||
+ | Detalhe | ||
+ | Caminho: Financeiro>Contas a receber>Régua de Cobrança | ||
+ | |||
+ | Criar uma tela com abas permitindo que sejam feitos cadastros das mensagens e da configuração de aplicação dos disparos das mesmas. | ||
+ | |||
+ | 1 - Aba de cadastro de mensagens | ||
+ | Nessa aba deve ser possível cadastrar as mensagens que serão disparadas. e filtrar as mesmas | ||
+ | Inicialmente a tela deverá conter um filtro por Descrição. Mais abaixo, A tela deverá ser 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 da mesma no sistema(análogo ao campo "Descrição critério de cobrança") | ||
+ | b) Variáveis do sistema - Combo onde devem ser listadas as "Tags" que farão referencia aos respectivos dados do sistema que poderão ser inseridos no corpo e/ou título da mensagem. Foram apuradas as seguintes variáveis: | ||
+ | Obs: O campo "Titulo" deve vir antes do campo "Variáveis do sistema" | ||
+ | |||
+ | #Data_Vencimento_boleto#: Data de vencimento do boleto padrão "DD/MM/AAAA" | ||
+ | #Data_Vencimento_extenso#: Data do vencimento por extenso. Ex: "Sexta-feira, 20 de março de 2020" | ||
+ | #Mês_Vencimento_Boleto# - Exibe o mês de vencimento do boleto no padrão MM/AAAA | ||
+ | #Mês_Vencimento_Extenso# - Exibe o mês de vencimento do boleto por extenso. Ex: Março de 2020 | ||
+ | #Dias_vencimento_boleto#: Exibe a quantidade de dias que faltam para o vencimento do boleto. Obs: Deve ser calculado a partir do dia que é enviada a mensagem. | ||
+ | #Data_emissão_Boleto#: Exibe a data da emissão do boleto. Obs: Discutir se será realmente a data de emissão ou a data de registro do mesmo. | ||
+ | #Data_corrente#: Exibe a data de disparo do email. | ||
+ | #Linha_Digitável#: Exibe a linha digitável referente ao boleto. | ||
+ | #Valor_Boleto#: Deve ser exibido o valor do boleto para pagamento considerando a data do envio da mensagem | ||
+ | #Itens_Boleto#: Exibe os itens que compõe o boleto (análogo com é feito no Base Filtro) | ||
+ | #Link_Boleto#: Exibe o link do boleto quando este estiver disponível no Icondo. Ou seja, o sistema deve verificar se o boleto está constando como enviado e diante disso acionar uma API(ver com o Simone) que devolve o link de acesso ao do arquivo do boleto. Caso este não esteja disponível o campo vai em branco. | ||
+ | #Numero_Boleto#: Exibe o numero do recibo. | ||
+ | #E-mail_unidade#: E-mail pego do cadastro da unidade. Caso na unidade não existam emails cadastrados deve ser mantida a regra de pegar o endereço de e-mail principal cadastrado no condômino | ||
+ | #E-mail_condômino#: Endereço de e-mail principal cadastrado no condômino. | ||
+ | #Endereço_condomínio#: Endereço do Condomínio | ||
+ | #Nome_Condomínio#:Exibe o nome do condomínio referente a unidade | ||
+ | #Nome_Condômino#:Exibe o nome do condômino que está ligado à unidade. | ||
+ | #Razão_social_condomínio#: Exibe a razão social do condomínio | ||
+ | #Endereço_Unidade#: Endereço da unidade, o mesmo que é pego considerando as mesmas regras de montagem do endereço do boleto emitido pelo sistema. | ||
+ | #Nome_Filial#:Exibe o nome da Filial que é pego do cadastro de Filiais(Tabelas gerais>principais>Filial). Nesse caso, o sistema deve inserir o nome da filial vinculada ao cadastro do condomínio. | ||
+ | #Endereço_Filial#:Exibe o endereço da Filial que é pego do cadastro de Filiais(Tabelas gerais>principais>Filial). Nesse caso, o sistema deve inserir o endereço da filial vinculada ao cadastro do condomínio. | ||
+ | #Telefone Filial#: Exibe o telefone da Filial atrelada ao condomínio. | ||
+ | #Nome_Gerente#: Exibe o nome do regente do condomínio (Obs: Verificar se entidade que e o gerente está ativo!) | ||
+ | #CNPJ_Filial#:Exibe o CNPJ da Filial que é pego do cadastro de Filiais(Tabelas gerais>principais>Filial). Nesse caso, o sistema deve inserir o CNPJ da filial vinculada ao cadastro do condomínio. | ||
+ | |||
+ | A listagem da TAG no combo será com o nome amigável, porém ao inserir no texto, aparecerá com o nome sem acentuação e com o "_"(Underline) como separador | ||
+ | |||
+ | b) Assunto - Aqui deve ser possível cadastrar o texto referente ao assunto da mensagem e este irá como assunto do e-mail quando disparado para o cliente. | ||
+ | c) Mensagem - Campo onde será cadastrado o corpo da menagem. | ||
+ | Esse campo em questão deve ser exibido na tela através do componente enviado pelo Robson que faz a edição de texto nos moldes do parão html. Deverá ainda ser possível visualizar o texto como código fonte onde poderá ser possível formatar a mensagem inserindo um CSS ou Java Script embarcado. | ||
+ | Exemplo: | ||
+ | image.png | ||
+ | |||
+ | |||
+ | Importante: | ||
+ | - Bloquear a exclusão de mensagens que por ventura estejam sendo usadas no cadastro das regras de disparo, Mostrando ao usuário onde a mesma é utilizada(Empresa(mensagem default) ou Condomínio) e respectivas condições. | ||
+ | - Criar mensagens pré-configuradas com template básico para que o usuário apenas ative a régua com configurações default. | ||
+ | - Criar um preview onde o usuário possa verificar como ficará o email antes do disparo. | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | Exemplo de tela | ||
+ | image.png | ||
+ | |||
+ | |||
+ | |||
+ | 2- Cadastro das regras de disparo | ||
+ | Nesta aba, deve ser permitido cadastrar as regras de disparo de mensagens. A filosofia da tela é a mesma usada no cadastro de Serviços Extras do sistema Base Condomínio, ou seja, o usuário poderá listar as mensagens cadastradas e configurar as mesmas para default para a administradora, poder configurar uma específica para um ou mais condomínios ou até mesmo bloquear o envio de mensagens para um ou mais condomínios. | ||
+ | A dele é composta inicialmente por um filtro onde poderá ser possível filtrar a configuração realizada para a empresa ou condomínios e ainda deverá permitir filtrar por código e descrição da mensagem. | ||
+ | Mas abaixo deve estar dispostos os campos para cadastro das regras.São eles: | ||
+ | a)Código do condomínio : Exibe o código do condomínio | ||
+ | b)Nome do condomínio : Exibe o Nome de condomínios ativos e em estágio de operação. Também devem ser listados condomínios sem o campo Estágio configurado. (DISCUTIR SE SERÃO LISTADOS CONDOMÍNIOS EM ESTÁGIO DE DESLIGAMENTO) | ||
+ | c) Código da mensagem : Lista o código das mensagens cadastradas | ||
+ | d) Descrição da mensagem : Lista a descrição das mensagens cadastradas | ||
+ | e) Nível de bloqueio : Combo que deve listar os ´tipo de nível de bloqueio (Não Bloqueado, Bloqueado ). Aqui o usuário pode bloquear uma mensagem (ou a régua de cobrança) para um condomínio específico. Caso o usuário mencione a mensagem, esta ficará bloqueada, porém se houverem outras que não estiverem bloqueadas, deverão passar normalmente pelo condomínio. | ||
+ | f) Notificação Pagamento : Checkbox que se marcado indica que a regra em questão será aplicada a cada baixa de recibo. | ||
+ | Obs: É obrigatório o preenchimento do campo "Dias" | ||
+ | g) Contexto : Combo que lista o tipo de contexto de uma régua. Deverão ser listadas as opções Extra Judicial e Judicial (IMPORTANTE: INICLUIR ESTE CAMPO NA TABELA MAS EXIBIR NA TELA SOMENTE EM UMA FASE POSTERIOR DA IMPLEMENTAÇÃO) | ||
+ | h) 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. | ||
+ | i) Observação : Cadastro de observação sobre a regra específica | ||
+ | |||
+ | Exemplo de tela: | ||
+ | image.png | ||
+ | |||
+ | 3- Logs | ||
+ | Criar uma nova interface com uma grid listando | ||
+ | Condomínio, Unidade, Data do envio, Status e Número do Recibo, Mensagem que foi enviada(corpo do email)*(Fase 2). | ||
+ | Na tela ainda deverá ser criado um filtro pelos seguintes campos: | ||
+ | Condomínio, Unidade, Data do envio, Status e Número do Recibo | ||
+ | |||
+ | Importante 1: Incluir logs de disparo e tratamento do sistema e logs de retorno do mailgun com relação as mensagens. | ||
+ | Impostante 2: O Log consulta o envio das últimas nos últimos 30 dias. | ||
+ | Importante 3: Dentro dos 30 dias que o mailgun armazena os logs, limitar a gravação de logs até o status que sinalize a leitura da mensagem, por exemplo. | ||
+ | Obs: Definir junto ao mailgun qual o status final de uma mensagem. | ||
+ | |||
+ | API - MailGun | ||
+ | Documentação da API: https://documentation.mailgun.com/en/latest/api_reference.html | ||
+ | Obs: Validar com o Robson. | ||
+ | |||
+ | Observações | ||
+ | Documentação | ||
+ | a) Dar ênfase na confecção da documentação sobre desabilitar a notificação de arquivo disponível no icondo quando o usuário habilitar a régua de cobrança | ||
+ | Disparo de mensagens | ||
+ | a) Antes de enviar a mensagem que notifique boleto em aberto ou disponível, verificar se o boleto já está baixado no sistema | ||
+ | b) Criar algum mecanismo que não dispare a régua quando o boleto for baixado, tiver a baixa cancelado e ser baixado novamente em um curto espaço de tempo. |
Edição das 12h58min de 14 de maio de 2020
Índice
Índice
Visão Geral
- Essa ferramenta permite o disparo de emails avisando aos Condôminos, Proprietários e Inquilinos da disponibilização, pagamento ou atraso do vencimento do boleto. Podendo configurar um texto personalizado incluindo o link do boleto disponível no Icondo.
|
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.
Configurações
- Nesse tópico abordaremos as configurações necessárias para o funcionamento da Régua de Cobrança.
Parâmetro
- O Parâmetro
Textos
Regras
Fluxograma
Logs
ATENÇÃO |
DICA |
Funcionalidades Base Condomínio
Detalhe
Caminho: Financeiro>Contas a receber>Régua de Cobrança
Criar uma tela com abas permitindo que sejam feitos cadastros das mensagens e da configuração de aplicação dos disparos das mesmas.
1 - Aba de cadastro de mensagens Nessa aba deve ser possível cadastrar as mensagens que serão disparadas. e filtrar as mesmas Inicialmente a tela deverá conter um filtro por Descrição. Mais abaixo, A tela deverá ser 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 da mesma no sistema(análogo ao campo "Descrição critério de cobrança") b) Variáveis do sistema - Combo onde devem ser listadas as "Tags" que farão referencia aos respectivos dados do sistema que poderão ser inseridos no corpo e/ou título da mensagem. Foram apuradas as seguintes variáveis: Obs: O campo "Titulo" deve vir antes do campo "Variáveis do sistema"
- Data_Vencimento_boleto#: Data de vencimento do boleto padrão "DD/MM/AAAA"
- Data_Vencimento_extenso#: Data do vencimento por extenso. Ex: "Sexta-feira, 20 de março de 2020"
- Mês_Vencimento_Boleto# - Exibe o mês de vencimento do boleto no padrão MM/AAAA
- Mês_Vencimento_Extenso# - Exibe o mês de vencimento do boleto por extenso. Ex: Março de 2020
- Dias_vencimento_boleto#: Exibe a quantidade de dias que faltam para o vencimento do boleto. Obs: Deve ser calculado a partir do dia que é enviada a mensagem.
- Data_emissão_Boleto#: Exibe a data da emissão do boleto. Obs: Discutir se será realmente a data de emissão ou a data de registro do mesmo.
- Data_corrente#: Exibe a data de disparo do email.
- Linha_Digitável#: Exibe a linha digitável referente ao boleto.
- Valor_Boleto#: Deve ser exibido o valor do boleto para pagamento considerando a data do envio da mensagem
- Itens_Boleto#: Exibe os itens que compõe o boleto (análogo com é feito no Base Filtro)
- Link_Boleto#: Exibe o link do boleto quando este estiver disponível no Icondo. Ou seja, o sistema deve verificar se o boleto está constando como enviado e diante disso acionar uma API(ver com o Simone) que devolve o link de acesso ao do arquivo do boleto. Caso este não esteja disponível o campo vai em branco.
- Numero_Boleto#: Exibe o numero do recibo.
- E-mail_unidade#: E-mail pego do cadastro da unidade. Caso na unidade não existam emails cadastrados deve ser mantida a regra de pegar o endereço de e-mail principal cadastrado no condômino
- E-mail_condômino#: Endereço de e-mail principal cadastrado no condômino.
- Endereço_condomínio#: Endereço do Condomínio
- Nome_Condomínio#:Exibe o nome do condomínio referente a unidade
- Nome_Condômino#:Exibe o nome do condômino que está ligado à unidade.
- Razão_social_condomínio#: Exibe a razão social do condomínio
- Endereço_Unidade#: Endereço da unidade, o mesmo que é pego considerando as mesmas regras de montagem do endereço do boleto emitido pelo sistema.
- Nome_Filial#:Exibe o nome da Filial que é pego do cadastro de Filiais(Tabelas gerais>principais>Filial). Nesse caso, o sistema deve inserir o nome da filial vinculada ao cadastro do condomínio.
- Endereço_Filial#:Exibe o endereço da Filial que é pego do cadastro de Filiais(Tabelas gerais>principais>Filial). Nesse caso, o sistema deve inserir o endereço da filial vinculada ao cadastro do condomínio.
- Telefone Filial#: Exibe o telefone da Filial atrelada ao condomínio.
- Nome_Gerente#: Exibe o nome do regente do condomínio (Obs: Verificar se entidade que e o gerente está ativo!)
- CNPJ_Filial#:Exibe o CNPJ da Filial que é pego do cadastro de Filiais(Tabelas gerais>principais>Filial). Nesse caso, o sistema deve inserir o CNPJ da filial vinculada ao cadastro do condomínio.
A listagem da TAG no combo será com o nome amigável, porém ao inserir no texto, aparecerá com o nome sem acentuação e com o "_"(Underline) como separador
b) Assunto - Aqui deve ser possível cadastrar o texto referente ao assunto da mensagem e este irá como assunto do e-mail quando disparado para o cliente. c) Mensagem - Campo onde será cadastrado o corpo da menagem. Esse campo em questão deve ser exibido na tela através do componente enviado pelo Robson que faz a edição de texto nos moldes do parão html. Deverá ainda ser possível visualizar o texto como código fonte onde poderá ser possível formatar a mensagem inserindo um CSS ou Java Script embarcado. Exemplo: image.png
Importante:
- Bloquear a exclusão de mensagens que por ventura estejam sendo usadas no cadastro das regras de disparo, Mostrando ao usuário onde a mesma é utilizada(Empresa(mensagem default) ou Condomínio) e respectivas condições.
- Criar mensagens pré-configuradas com template básico para que o usuário apenas ative a régua com configurações default.
- Criar um preview onde o usuário possa verificar como ficará o email antes do disparo.
Exemplo de tela
image.png
2- Cadastro das regras de disparo Nesta aba, deve ser permitido cadastrar as regras de disparo de mensagens. A filosofia da tela é a mesma usada no cadastro de Serviços Extras do sistema Base Condomínio, ou seja, o usuário poderá listar as mensagens cadastradas e configurar as mesmas para default para a administradora, poder configurar uma específica para um ou mais condomínios ou até mesmo bloquear o envio de mensagens para um ou mais condomínios. A dele é composta inicialmente por um filtro onde poderá ser possível filtrar a configuração realizada para a empresa ou condomínios e ainda deverá permitir filtrar por código e descrição da mensagem. Mas abaixo deve estar dispostos os campos para cadastro das regras.São eles: a)Código do condomínio : Exibe o código do condomínio b)Nome do condomínio : Exibe o Nome de condomínios ativos e em estágio de operação. Também devem ser listados condomínios sem o campo Estágio configurado. (DISCUTIR SE SERÃO LISTADOS CONDOMÍNIOS EM ESTÁGIO DE DESLIGAMENTO) c) Código da mensagem : Lista o código das mensagens cadastradas d) Descrição da mensagem : Lista a descrição das mensagens cadastradas e) Nível de bloqueio : Combo que deve listar os ´tipo de nível de bloqueio (Não Bloqueado, Bloqueado ). Aqui o usuário pode bloquear uma mensagem (ou a régua de cobrança) para um condomínio específico. Caso o usuário mencione a mensagem, esta ficará bloqueada, porém se houverem outras que não estiverem bloqueadas, deverão passar normalmente pelo condomínio. f) Notificação Pagamento : Checkbox que se marcado indica que a regra em questão será aplicada a cada baixa de recibo. Obs: É obrigatório o preenchimento do campo "Dias" g) Contexto : Combo que lista o tipo de contexto de uma régua. Deverão ser listadas as opções Extra Judicial e Judicial (IMPORTANTE: INICLUIR ESTE CAMPO NA TABELA MAS EXIBIR NA TELA SOMENTE EM UMA FASE POSTERIOR DA IMPLEMENTAÇÃO) h) 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. i) Observação : Cadastro de observação sobre a regra específica
Exemplo de tela: image.png
3- Logs Criar uma nova interface com uma grid listando Condomínio, Unidade, Data do envio, Status e Número do Recibo, Mensagem que foi enviada(corpo do email)*(Fase 2). Na tela ainda deverá ser criado um filtro pelos seguintes campos: Condomínio, Unidade, Data do envio, Status e Número do Recibo
Importante 1: Incluir logs de disparo e tratamento do sistema e logs de retorno do mailgun com relação as mensagens. Impostante 2: O Log consulta o envio das últimas nos últimos 30 dias. Importante 3: Dentro dos 30 dias que o mailgun armazena os logs, limitar a gravação de logs até o status que sinalize a leitura da mensagem, por exemplo. Obs: Definir junto ao mailgun qual o status final de uma mensagem.
API - MailGun Documentação da API: https://documentation.mailgun.com/en/latest/api_reference.html Obs: Validar com o Robson.
Observações Documentação a) Dar ênfase na confecção da documentação sobre desabilitar a notificação de arquivo disponível no icondo quando o usuário habilitar a régua de cobrança Disparo de mensagens a) Antes de enviar a mensagem que notifique boleto em aberto ou disponível, verificar se o boleto já está baixado no sistema b) Criar algum mecanismo que não dispare a régua quando o boleto for baixado, tiver a baixa cancelado e ser baixado novamente em um curto espaço de tempo.