# Variáveis de SMS para Envio Manual de Cobranças Pix

## Introdução
O envio de mensagens por SMS 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 SMS 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 SMS, 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 SMS 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 SMS.

> [!NOTA] **Acesso às Variáveis**
> **Caminho:** Sistema > CRM > Mensagens > Mensagem de SMS

### 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).
>  
>**Carteiras de cobrança com configuração alternativa de pagamento com:**
>- Efí Bank (não gera QR Code no boleto);
>- modobank; 

- Para garantir o envio completo de informações extensas como linha digitável ou código **Pix Copia e Cola**, é essencial utilizar um [[gateway sms|Gateway SMS]] que comporte **mais de 140 caracteres**. Esta integração assegura que todas as informações de pagamento sejam transmitidas corretamente ao cliente.
  
## Entrega de Valor
- Personalização eficiente de SMSs;
- 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 SMS com informações Pix, é necessário configurar previamente:
- Configuração e integração de um [[gateway sms|Gateway SMS]];
- [[cadastro de mensagem de sms|Cadastro de Mensagem de SMS]] para o envio;
- Parametrização do campo **SMS para envio de boletos** nos [[parametros financeiro|Parâmetros Financeiro]] para envio através do relatório de [[emissao de boletos|Emissão de Boletos]] e financeiro do cliente;
- Boletos emitidos corretamente com o código pix.

## Variáveis de SMS
A seguir, consta a listagem das variáveis de SMS disponíveis para o envio de cobranças pix nos seguintes métodos:
- [[envio de boletos por sms pelo financeiro do cliente|Envio de Boletos por SMS pelo Financeiro do Cliente]];
- [[envio de boletos por sms pelo relatorio de emissao de boletos|Envio de Boletos por SMS 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 ([[configuracoes alternativas de pagamento|Configurações Alternativas de Pagamento]]), 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 |
>[!DANGER] Atenção!
>A variável de QR Code não é suportada para envios de SMS ao utilizar um Gateway SMS.

>[!CAUTION] Atenção:
>Verifique com seu provedor de [[gateway sms|Gateway SMS]] se o serviço permite o envio de mensagens com mais de 140 caracteres, garantindo assim a transmissão completa de dados extensos.

### 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_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               |
| `#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_fantasia#`         | Informação respectiva ao Nome Fantasia do cliente, definido no campo Nome Fantasia no cadastro do Cliente.                                                           | Sistema > Cadastros > Clientes > Nome Fantasia                     |
| `#cliente_nome#`             | Informação respectiva ao primeiro nome do cliente, definido no campo Razão social/nome no cadastro do Cliente.                                                       | Sistema > Cadastros > Clientes > Razão social/Nome                 |
| `#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 (primeiro nome) |
| `#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                  |

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

## Casos de Uso

### Envio Através do Financeiro do Cliente
O envio de cobranças Pix pode ser realizado através do **Financeiro do Cliente**, permitindo um disparo individual e direcionado a um cliente específico, conforme a necessidade da empresa e do cliente. Para realizar este envio, siga os passos a seguir:

>[!CAUTION] Importante:
>Lembre-se de realizar o **[[cadastro de mensagem de sms|Cadastro de Mensagem de SMS]]** e configurar sua parametrização adequadamente, para que as mensagens sejam enviadas corretamente através do **Financeiro do Cliente**. A correta configuração do envio de SMS garantirá que as notificações financeiras sejam entregues de forma eficiente e conforme a necessidade do cliente.

1. Acesse o **[[formulario cliente|Formulário Cliente]]** ou através do caminho: Sistema > Cadastros > Clientes ou então acesse o **[[formulario contrato do cliente|Contrato do Cliente]]** através do caminho: Sistema > Cadastros > Contratos;
2. Selecione o cadastro/contrato do cliente do qual deseja realizar o envio das mensagens e clique em **Editar**;
3. No cadastro do cliente, acesse a aba **Financeiro;**
4. Identifique um boleto do qual deseja realizar o envio, selecione-o e clique em **Imprimir boletos**;
5. Marque os filtros que se aplicam ao tipo de envio que deseja realizar:
	  - **Todos em aberto do cliente:** ao marcar este campo, todos os boletos em aberto relacionados ao **cadastro do cliente** serão enviados, desde que sejam da mesma carteira de cobrança do boleto selecionado;
	   - **Todos em aberto do contrato:** ao marcar este campo, todos os boletos em aberto relacionados ao **contrato do cliente** serão enviados, desde que sejam da mesma carteira de cobrança do boleto selecionado;
     
6. Clique em **Enviar SMS** para realizar o envio.  

### Envio Através do Relatório de [[emissao de boletos|Emissão de Boletos]]
O envio de cobranças Pix pode ser realizado através do relatório de emissão de boletos, filtrando pela carteira de cobrança desejada e aplicando demais filtros, afim de segmentar os clientes que receberão a mensagem. Para realizar este envio, siga os passos a seguir:

>[!DANGER] Atenção:
>Ao utilizar a carteira de cobrança **[[efi - pix avulso|Efí - Pix Avulso]]**, o sistema não realizará o disparo automático através do **Relatório de Emissão de Boletos**. Para enviar o boleto, é necessário acessar o **cadastro do cliente** e proceder com o envio manual do boleto, garantindo que as informações de pagamento sejam enviadas corretamente ao cliente.

>[!CAUTION] Importante:
>Lembre-se de realizar o **[[cadastro de mensagem de sms|Cadastro de Mensagem de SMS]]** e configurar sua parametrização adequadamente, para que as mensagens sejam enviadas corretamente através do **Relatório de Emissão de Boletos**. A correta configuração do envio de SMS garantirá que as notificações financeiras sejam entregues de forma eficiente e conforme a necessidade do cliente.

1. Acesse o **Relatório de [[emissao de boletos|Emissão de Boletos]]** através do caminho: Relatórios > Relatórios financeiros > Relatórios de Saída > Emissão de boletos;
2. Na aba **Filtros**, aplique os filtros necessários;
	
	**Campos principais:**
	- **Carteira de cobrança:** clique na lupa e selecione a carteira de cobrança da qual os boletos que deseja enviar estão gerados;
	- **Data emissão inicial e final:** o sistema permite inserir a data de emissão dos boletos. Se necessário, filtre por **período** de emissão preenchendo a data inicial e a data final de emissão;
	- **Data vencimento inicial e final:** filtre pela data de vencimento inicial e final para o sistema considerar os boletos com data de emissão no período filtrado;
	- **Status dos títulos:** indique o status dos títulos que deseja enviar a mensagem. Caso sejam boletos em aberto, filtre pelo status **Abertos.**
	  
3. Com os filtros aplicados, clique em **Listar faturas > Padrão** para visualizar quais clientes serão indicados na listagem;
4. Na sequência, após conferir os clientes listados, clique em **Enviar por SMS** para efetivar os disparos.
5. Após realizar a requisição de envio, o sistema apresentará um relatório apresentando os clientes que receberão estas mensagens. Confira em [[log sms|Log SMS]] os disparos que foram realizados e estão registrados no sistema.

>[!TIP] Dica:
>Para mais informações sobre o envio de boletos por SMS, acesse os materiais disponíveis:
>- [[envio de pix por sms|Envio de Pix por SMS]];
>- [[envio de boletos por sms pelo financeiro do cliente|Envio de Boletos por SMS pelo Financeiro do Cliente]]
>- [[envio de boletos por sms pelo relatorio de emissao de boletos|Envio de Boletos por SMS pelo Relatório de Emissão de Boletos]]
>  
>  Esses recursos fornecerão detalhes completos sobre como configurar e utilizar o envio de boletos via SMS de forma eficaz.

## Fluxo de Trabalho
```mermaid
flowchart TD
    A[Início] --> B[Integração de uma conta de Gateway SMS]
    B --> C[Cadastro da mensagem de SMS]
    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]
    E --> I[Envio através do financeiro do cliente]
    F --> G[Registro de log nos logs de SMS]
    I --> G[Registro de log nos logs de SMS]
    G --> H[Fim]
```

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

## Etiquetas
#Integracoes #IntegracaoGatewaySMS #Boletos #Cobranca #EmissaoDeBoletos #Pix #PixAvulso 

## Leia Também
- [[integracoes|Integrações]]
- [[gateway sms|Gateway SMS]]
- [[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]]