# Variáveis de E-mail para Envio Manual de Cobranças Pix

## Introdução
O envio de mensagens por E-mail de cobranças Pix é uma ferramenta essencial no sistema que permite a personalização e gerenciamento eficiente da comunicação com os clientes.

>[!TIP] O que são variáveis?
>As variáveis são valores que podem ser substituídos quando existe a variação de uma informação. É possível incluir variáveis para que, no ato do envio da mensagem para mais de um cliente, a informação da variável seja preenchida individualmente para cada envio, com a respectiva informação para cada cliente.

O uso de variáveis nas mensagens de e-mail possibilita a criação de conteúdos personalizados para múltiplos clientes a partir de um único template. Desta forma, o sistema permite que informações específicas de cada cliente, boleto e empresa sejam automaticamente inseridas nos locais apropriados do e-mail, resultando em mensagens individualizadas e adaptadas às necessidades particulares de cada situação, sem a necessidade de criar um modelo separado para cada envio.

- Este documento descreve as variáveis disponíveis para uso nos templates de e-mail do sistema;
- As variáveis permitem a inserção automática de informações específicas do cliente, boleto, serviço e empresa nas mensagens de e-mail.

> [!NOTA] **Acesso às Variáveis**
> **Caminho:** Configurações > Integrações > E-mail SMTP > Mensagem > Variáveis

### Requisitos de Uso
Para que as variáveis de Pix operem corretamente, é necessário que a cobrança gerada seja do tipo Pix ou então proveniente da emissão de um boleto híbrido. 

>[!EXAMPLE] Carteiras de cobrança compatíveis para o envio de pix:
>**Carteiras de pix instantâneo:**
>- Efí Bank;
>- modobank; 
>
>**Carteiras de boleto híbrido (boleto com QRCode Pix):**
>- API Banco do Brasil;
>- API Santander;
>- API Sicoob;
>- API Sicredi;
>- Wide Pay;
>- Iugu;
>- Efí Bank (Gerencianet);
>- Cel_cash (Galaxpay).

## Entrega de Valor
- Personalização eficiente de e-mails;
- Comunicação clara e detalhada sobre boletos e dados financeiros;
- Redução de dúvidas e chamados relacionados a cobranças.

## Estrutura da Funcionalidade
Para utilizar as variáveis em mensagens de e-mail com informações Pix, é necessário configurar previamente:
- Configuração e integração de um [[e-mail smtp|E-mail SMTP]] e definição do conteúdo da mensagem relacionada ao SMTP;
- Parametrização do campo **Servidor de e-mail pix** [[parametros financeiro|Parâmetros Financeiro]] para envio através do relatório de [[emissao de boletos|Emissão de Boletos]] e financeiro do cliente;

## Variáveis de E-mail
A seguir, consta a listagem das variáveis de e-mail disponíveis para os seguintes tipos de envio:
- [[envio de boleto por e-mail pelo cadastro do cliente|Envio de Boleto por E-mail pelo Cadastro do Cliente]]
- [[envio de boletos por e-mail pelo relatorio de emissao de boletos|Envio de Boletos por E-mail pelo Relatório de Emissão de Boletos]]

>[!INFO] **Informação:**
>Os envios realizados pelos meios citados possuem ligação direta com o financeiro do cliente e alguns dados cadastrais, portanto, variáveis com este cunho podem ser utilizadas neste tipo de envio.

### Variáveis de informações Pix
As variáveis de pagamento Pix são aplicadas quando o método de recebimento Pix está configurado na fatura. Estas informações serão exibidas no corpo da mensagem em três situações:

-  Quando um boleto exclusivamente do tipo Pix é emitido ([[modobank - pix avulso|modobank - Pix Avulso]] e [[efi - pix avulso|Efí - Pix Avulso]]);
- Em caso de boleto híbrido (tradicional + Pix);
-  Quando há configuração de pagamento alternativo via modobank, em que o código de Pix é gerado no boleto.

Veja abaixo as variáveis disponíveis para incluir informações Pix em suas mensagens:

| Variável           | Conceito                                                                                                                                                                                                                                   | Caminho                              |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ |
| `#pix_copia_cola#` | Imprime o código pix do boleto quando o boleto o possuir, permitindo que o cliente copie facilmente os dados para realizar o pagamento.                                                                                                    | Contas a receber > Copiar código pix |
| `#pix_qr_code#`    | Adiciona a imagem do QR Code do Pix no corpo do e-mail, possibilitando que o cliente efetue o pagamento através da leitura do código pelo aplicativo do banco. **Disponível ao utilizar [[modelos padrao e-mail smtp|Modelos Padrão E-mail SMTP]]**. | Contas a receber > Imprimir boleto   |
>[!CAUTION] Atenção:
>O envio de cobranças Pix através da carteira Efí - Pix Avulso está disponível exclusivamente pela função [[envio de boleto por e-mail pelo cadastro do cliente|Envio de Boleto por E-mail pelo Cadastro do Cliente]].

### Variáveis financeiras e cadastrais
As variáveis financeiras e cadastrais são complementares ao envio de informações Pix. Embora opcionais, elas enriquecem a comunicação ao exibir dados importantes como detalhes da fatura, informações da filial e dados do cliente. Ao incluir estas variáveis junto ao código Pix e QR Code, sua empresa oferece uma comunicação mais completa e transparente para o cliente.

Confira as variáveis que podem ser utilizadas para adicionar informações financeiras e cadastrais em suas mensagens:

| **Variável**                 | **Conceito**                                                                                                                                                                                            | Caminho                                                            |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| `#areceber_data_emissao#`    | Data de emissão do boleto.                                                                                                                                                                              | Contas a receber > Data da emissão                                 |
| `#areceber_data_vencimento#` | Data de vencimento do boleto.                                                                                                                                                                           | Contas a receber > Data do vencimento                              |
| `#areceber_numero#`          | Informação respectiva ao ID do boleto no IXC.                                                                                                                                                           | Contas a receber > ID                                              |
| `#areceber_valor#`           | Informação respectiva ao valor do boleto.                                                                                                                                                               | Contas a receber > Valor                                           |
| `#areceber_valor_atual#`     | Informação respectiva ao valor total em aberto, acrescido de juros e multa.                                                                                                                             | Contas a receber > Histórico boleto > Valor atual                  |
| `#cliente_cnpj_cpf#`         | Informação respectiva ao CPF/CNPJ do cliente, definido no campo CNPJ/CPF no cadastro do Cliente.                                                                                                        | Sistema > Cadastros > Clientes > CNPJ/CPF                          |
| `#cliente_razao#`            | Informação respectiva à razão social, definido no campo Razão social/nome no cadastro do Cliente.                                                                                                       | Sistema > Cadastros > Clientes > Razão social/nome                 |
| `#filial_cidade#`            | Informa a cidade registrada no campo Cidade, no cadastro da filial.                                                                                                                                     | Configurações > Empresa > Filiais > aba Filial > Endereço > Cidade |
| `#filial_email#`             | Informa o e-mail registrado no campo E-mail, no cadastro da filial.                                                                                                                                     | Configurações > Empresa > Filiais > aba Filial > E-mail            |
| `#filial_fantasia#`          | Informa o nome fantasia registrado no campo Nome Fantasia, no cadastro da filial.                                                                                                                       | Configurações > Empresa > Filiais > aba Filial > Nome fantasia     |
| `#filial_razao#`             | Informa a razão social da filial, registrada no campo Razão Social, no cadastro da filial.                                                                                                              | Configurações > Empresa > Filiais > aba Filial > Razão social      |
| `#filial_site#`              | Informa o site da filial, registrado no campo Site, no cadastro da filial.                                                                                                                              | Configurações > Empresa > Filiais > aba Filial > Site              |
| `#filial_telefone#`          | Informa o telefone da filial, registrado no campo Telefone, no cadastro da filial.                                                                                                                      | Configurações > Empresa > Filiais > aba Endereço > campo Telefone  |
| `#imprimir_produtos_fatura#` | É apresentada uma tabela com os principais dados relacionados ao produto do qual o boleto foi gerado, como ID, descrição do produto, quantidade, valores unitários e gerais, acréscimo e valor líquido. | Sistema > Cadastros > Contratos > Vendas > aba Produtos            |
| `#linha_digitavel#`          | Quando o boleto possui código de barras, preencherá a linha digitável. Respectiva ao campo de linha digitável nas informações do boleto.                                                                | Contas a receber > aba Informações > Linha digitável               |
| `#link_boleto_gerencianet#`  | Quando o boleto é gerado para a carteira de cobrança Gerencianet e estiver comunicado, irá gerar o link gateway para a Gerencianet. Esta variável é específica para este Gateway de Pagamento.          | Contas a receber > aba Informações > Link gateway                  |
| `#link_gateway#`             | Quando a carteira de cobrança é do tipo Gateway, e gera link gateway, preencherá esta informação. Depende do campo link gateway preenchido nas informações do boleto.                                   | Contas a receber > aba Informações > Link gateway                  |
| `#obs_boleto#`               | Imprime o valor de _Período de prestação_ do boleto que foi enviado.                                                                                                                                    | Contas a receber > Período de prestação                            |
| `#valor_aberto_atrasado#`    | Informação respectiva ao valor em aberto do boleto enviado.                                                                                                                                             | Contas a receber > Valor                                           |

>[!TIP] Guia instrutivo:
>Para saber como configurar o envio de mensagens de e-mail para Pix, consulte nosso manual detalhado em:
>- [[envio de pix por e-mail|Envio de Pix por E-mail]]

## Fluxo de Trabalho
```mermaid
flowchart TD
    A[Início] --> B[Integração de uma conta de e-mail SMTP]
    B --> C[Cadastro da mensagem de e-mail]
    C --> D[Inserção das variáveis no corpo da mensagem]
    D --> E[Parametrização da mensagem padrão nos parâmetros financeiros]
    E --> F[Envio através do relatório de emissão de boletos]
    F --> G[Registro de log nos logs de e-mail]
    G --> H[Fim]
```

## Considerações Finais
O uso adequado das variáveis de e-mail para o **relatório de emissão de boletos** permite uma comunicação clara e eficiente com os clientes. Certifique-se de testar todos os modelos de e-mail antes de implementá-los em produção para garantir que as variáveis estejam sendo substituídas corretamente.

## Etiquetas
#Email #Boletos #Cobranca #EmissaoDeBoletos

## Leia Também
- [[integracoes|Integrações]]
- [[e-mail smtp|E-mail SMTP]]
- [[financeiro|Financeiro]]
- [[contas a receber|Contas a Receber]]
- [[emissao de boletos|Emissão de Boletos]]
- [[integracoes bancarias - carteira de cobranca|Integrações Bancárias - Carteira de Cobrança]]
- [[integracoes bancarias - gateway|Integrações Bancárias - Gateway]]
- [[integracoes bancarias - api|Integrações Bancárias - API]]
- [[integracoes bancarias - pix avulso|Integrações Bancárias - Pix Avulso]]