Este documento apresenta todas as variáveis disponíveis para personalização de mensagens na régua de cobrança. Estas variáveis permitem a automatização e personalização das comunicações com clientes.
Catálogo de Variáveis
Dados de Acesso
Variável
Descrição
#cliente_login_central#
Informação respectiva ao login de acesso à Central do Assinante, definido no campo Contato do cadastro do cliente
#cliente_senha_central#
Informação respectiva a senha de acesso à Central do Assinante, definida no campo Contato do cadastro do cliente
Dados do Cliente
Variável
Descrição
#cliente_razao#
Informação respectiva à razão social, definida no campo Razão social/nome no cadastro do Cliente
#cliente_fantasia#
Informação respectiva ao nome fantasia do cliente, definido no campo Nome Fantasia no cadastro do Cliente
#cliente_cnpj_cpf#
Informação respectiva ao CPF/CNPJ do cliente, definida no campo CNPJ/CPF no cadastro do Cliente
#cliente_email#
Informação respectiva ao e-mail do cliente, definida no campo E-mail principal no cadastro do Cliente
#cliente_fone#
Informação respectiva ao telefone do cliente, definida no campo Telefone celular no cadastro do Cliente
#cliente_contrato_id#
Informação respectiva ao ID do contrato do cliente
Dados do Contrato
Variável
Descrição
#contrato_descricao#
Informações a descrição do plano do contrato
#contrato_data_de_ativacao#
Informações sobre dados de ativação do contrato
Dados da Filial
Variável
Descrição
#filial_email#
Informa a cidade registrada no campo E-mail, no cadastro da filial
#filial_cidade#
Informa a cidade registrada no campo Cidade, no cadastro da filial
#filial_site#
Informa o site da filial, registrado no campo Site, no cadastro da filial
#filial_telefone#
Informa o telefone da filial, registrado no campo Telefone, no cadastro da filial
#filial_razao#
Informa a razão social da filial, registrada no campo Razão Social, no cadastro da filial
#filial_fantasia#
Informa a cidade registrada no campo Nome Fantasia, no cadastro da filial
Dados de Cobrança
Variável
Descrição
#numero_parcela_recorrente#
Informa o número da parcela recorrente das contas a receber, quando avulso informa 0
#areceber_data_emissao#
Informar a data de emissão do boleto
#areceber_data_vencimento#
Informa a Data de vencimento do boleto
#areceber_valor#
Informação respectiva ao valor do boleto
#areceber_valor_aberto#
Informação respectiva ao valor total em aberto
#cobranca_lista_areceber#
É uma tabela que reúne automaticamente todos os boletos em aberto do contrato
#cobranca_data#
Referente aos dados de cobrança, dia em que a mensagem está sendo enviada ao cliente
#etapa_cobranca#
Informa qual passo da cobrança o boleto está no momento
#linha_digitavel#
Quando o boleto possuir código de barras, preencherá a linha digitável
#link_gateway#
Quando a carteira de cobrança é do tipo Gateway, e gera link gateway
Dados PIX
Variável
Descrição
#pix_copia_cola#
Código pix do boleto quando o boleto o possui
#pix_qr_code#
Qr code quando o boleto o possui
Dados de Dados
Variável
Descrição
#data_atual_extenso#
Insere a data atual por extenso (ex: “9 de abril de 2025”). Refere-se ao dia em que o e-mail foi enviado.
Exemplos de uso
Template de Cobrança Básica
Prezado(a) #cliente_razao#,Informamos que sua fatura com vencimento em #areceber_data_vencimento# no valor de R$ #areceber_valor# está disponível para pagamento.Dados para pagamento:Linha Digitável: #linha_digitavel#PIX Copia e Cola: #pix_copia_cola#Atenciosamente,#filial_razao#, #data_atual_extenso#
Considerações Finais
Todas as variáveis devem ser utilizadas entre caracteres#.
Verifique se os dados estão corretamente cadastrados antes de utilizar as variáveis.
Teste as mensagens antes de implementar em produção.
