A Kobana fornece um sistema de variáveis de substituição para facilitar, por exemplo, a criação de modelos de boletos e notificações. As Variáveis são campos padrão que serão substituídos pelas informações cadastradas do seu cliente ou de uma operação, como um boleto. Assim, você consegue personalizar cada notificação enviada, sem perder tempo escrevendo e enviando um a um manualmente.
As variáveis colocadas no texto serão substituídas automaticamente pelos valores correspondes no momento em que a operação for criada ou uma notificação for enviada, como incluir a variável do nome de um cliente em uma notificação sem a necessidade de escrever uma por uma.
Na Kobana, todo dado poderá se tornar variável. O melhor local para consultar esses dados é a documentação técnica da Kobana: https://developers.kobana.com.br/.
Caso você utilize a integração da Kobana com o eNotas, você pode incluir variáveis das suas notas fiscais e até mesmo a própria nota fiscal nas suas notificações. Saiba mais: Como enviar a Nota Fiscal e outras informações dela ao meu cliente?
Como usar variáveis nas notificações?
Você pode adicionar as variáveis com facilidade na hora de criar uma notificação. Por exemplo, na notificação de e-mail, tanto no campo do assunto, como no da mensagem, você consegue clicar no bloco de variáveis e incluir as que você preferir.
No exemplo da imagem acima, utilizamos as variáveis do nome do cliente, a data de vencimento e o link do boleto. Repare que utilizamos o nome do cliente no assunto e na mensagem.
Para você, ela vai aparecer como o código: {{ customer.person_name }}, porém, quando o e-mail for enviado, esse código será substituído pelo nome de cada cliente.
No SMS, não existe o campo de assunto, porém você poderá adicionar qualquer variável no corpo da mensagem.
Atenção! O SMS é tarifado a cada 160 caracteres. No caso da variável, essa contagem é feita no resultado da substituição. Recomendamos sempre deixar uma margem grande de caracteres para que a mensagem não exceda o limite e sua empresa seja cobrada a mais por isso.
Exemplos de variáveis de boletos
Nas tabelas abaixo, listamos exemplos das variáveis mais utilizadas pelos nossos clientes:
Variável | Informação substituta |
{{ bank_billet.amount | prepend: "R$ " }} | Valor do boleto iniciando com o prefixo "R$" |
{{ bank_billet.expire_at }} | Data de vencimento do boleto |
{{ bank_billet.customer_person_name }} | Nome ou razão social do cliente |
{{ bank_billet.customer_contact_person }} | Nome do contato da empresa cliente |
{{ bank_billet.guarantor_name }} | Nome ou razão social do beneficiário final (sacador/avalista) |
{{ bank_billet.description }} | Texto do demonstrativo do boleto |
{{ bank_billet.document_number }} | Número de documento do boleto |
{{ bank_billet.custom_data.exemplo }} | Dado de exemplo inserido no custom_data através de importação de CSV ou API |
{{ bank_billet.paid_amount | money | prepend: "R$ " }} | Valor total pago no boleto |
{{ bank_billet.url }} | Link de acesso do boleto |
{{ bank_billet.customer_nickname }} | Nome fantasia da empresa |
Formatos das Variáveis
Dentro da própria variável, você consegue ajustar o formato a ser mostrado, como por exemplo, para uma data não mostrar o ano ou mostrar apenas as três primeiras letras do mês.
Variável | Exemplo de informação substituta |
{{ bank_billet.expire_at | date: "%m/%d/%Y" }} | 13/06/2023 |
{{ bank_billet.expire_at | date: "%d/%m" }} | 13/06 |
{{ bank_billet.expire_at | date: "%d/%b" }} | 13/Jun |
Para ajustes de formatos, você pode se basear neste link: https://devhints.io/datetime