>[!TIP] Atenção!  
>Este material inclui informações da **versão [[clientes beta ixc soft|Beta]]** do sistema.  
>Alguns recursos descritos aqui estarão disponíveis na **versão Estável** a partir de abril de 2025.
# Variáveis de Modelo de Contrato

## Introdução
O **Modelo de Contrato do Cliente** é uma funcionalidade essencial do sistema que permite a personalização e gerenciamento eficiente de documentos de contrato. Esta ferramenta oferece recursos para adaptar documentos contratuais às necessidades específicas de cada organização, como a utilização de variáveis.

>[!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, na impressão do documento para mais de um cliente, a informação da variável seja preenchida individualmente para cada cliente, com as respectivas informações contratuais e cadastrais.

O uso de variáveis no [[modelo de contrato do cliente|Modelo de Contrato do Cliente]] possibilita a criação de documentos personalizados para múltiplos clientes a partir de um único documento base (template). Desta forma, o sistema permite que informações específicas de cada cliente sejam automaticamente inseridas nos locais apropriados do contrato, resultando em documentos individualizados e adaptados às necessidades particulares de cada cliente, sem a necessidade de criar um modelo separado para cada um.

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

> [!NOTA] **Acesso à Funcionalidade**
> **Caminho:** Menu Sistema > Cadastros > Contratos > Modelos de contrato de cliente > Variáveis

## Entrega de Valor
- Personaliza automaticamente os contratos para cada cliente, adaptando as informações específicas sem necessidade de edição manual;
- Reduz erros de preenchimento manual;
- Aumenta a eficiência na geração de documentos contratuais;
- Permite maior flexibilidade na customização de contratos.

## Estrutura das Variáveis
As **variáveis** no sistema são espaços reservados que permitem a inserção automática de informações específicas para cada cliente. Estes campos são identificados por marcadores especiais, que consistem em um termo descritivo entre símbolos de cerquilha (`#`). Por exemplo, `#cliente_razao#` poderia ser uma destas variáveis. Quando o documento é gerado, o sistema substitui automaticamente esses marcadores pelas informações correspondentes de cada cliente, que foram previamente definidas. Isso permite que um único modelo de documento seja personalizado para múltiplos clientes de forma rápida e precisa.

Estas variáveis utilizam de informações já cadastradas no sistema e são divididas em categorias para facilitar a organização e o uso:

1. Informações da Filial;
2. Informações do Cliente;
3. Informações de Plano de Venda;
4. Informações do Contrato do Cliente;
6. Informações de Endereço do Contrato;
7. Informações de Login;
8. Informações Financeiras (boletos);
10. Informações Condições de Pagamento;
11. Informações dos Produtos.

Nas tabelas a seguir, você encontrará uma lista detalhada dessas variáveis, incluindo:
1. O nome da variável;
2. Uma breve descrição de seu propósito;
3. O caminho no sistema onde a informação correspondente está armazenada.

>[!TIP] **Dica:**
>Utilize esta referência para entender melhor como cada variável funciona e onde localizar ou atualizar as informações que ela representa no sistema.
### Variáveis da Filial
As variáveis de filial são elementos dinâmicos que representam informações específicas da filial registrada no sistema. Quando incluídas no [[modelo de contrato do cliente|Modelo de Contrato do Cliente]], estas variáveis são automaticamente substituídas pelos dados reais da filial durante a geração do contrato.
Confira, a seguir, a variável, o conceito de utilização e onde a informação está armazenada no sistema.

| **Variável**                                   | **Conceito**                                                         | **Caminho**                                                                      |
| ---------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `#filial_ato_anatel#`                          | Número do ato anatel (autorização da ANATEL).                        | Cadastros> Contratos > F3 Filial > campo Ato Anatel                              |
| `#filial_bairro#`                              | Bairro da filial.                                                    | Cadastros > Contratos > F3 Filial > aba Endereço > campo Bairro                  |
| `#filial_cep#`                                 | CEP da filial.                                                       | Cadastros > Contratos > F3 Filial > aba Endereço > Cep                           |
| `#filial_cidade#`                              | Cidade da filial.                                                    | Cadastros > Contratos > F3 Filial > aba Endereço > campo Cidade                  |
| `#filial_CNAE_fiscal#`                         | CNAE fiscal da filial.                                               | Cadastros > Contratos > F3 Filial > campo CNAE fiscal                            |
| `#filial_cnpj#`                                | CNPJ da filial.                                                      | Cadastros > Contratos > F3 Filial > campo CNPJ/CPF                               |
| `#filial_complemento#`                         | Complemento do endereço da filial.                                   | Cadastros > Contratos > F3 Filial > aba Endereço > campo Complemento             |
| `#filial_email#`                               | E-mail da filial.                                                    | Cadastros > Contratos > F3 Filial > campo E-mail                                 |
| `#filial_endereco#`                            | Endereço da filial.                                                  | Cadastros > Contratos > F3 Filial > aba Endereço > campo Endereço                |
| `#filial_fantasia#`                            | Nome fantasia da filial.                                             | Cadastros > Contratos > F3 Filial > campo Nome fantasia                          |
| `#filial_fax#`                                 | Telefone fax da filial.                                              | Cadastros > Contratos > F3 Filial > aba Endereço > campo Fax                     |
| `#filial_ie#`                                  | Número da inscrição estadual da filial.                              | Cadastros > Contratos > F3 Filial > campo Inscrição Estadual                     |
| `#filial_inscricao_municipal#`                 | Número da inscrição municipal da filial.                             | Menu configurações > Empresa > Filiais > campo Inscrição Municipal.              |
| `#filial_numero#`                              | Número do endereço da filial.                                        | Cadastros > Contratos > F3 Filial > aba Endereço > campo Número                  |
| `#filial_ramal#`                               | Número do ramal do telefone da filial.                               | Cadastros > Contratos > F3 Filial > aba Endereço > campo Ramal                   |
| `#filial_razao#`                               | Razão da filial a qual o cliente pertence.                           | Cadastros > Contratos > F3 Filial > campo Razão social                           |
| `#filial_regime_tributario#`                   | Regime tributário da filial.                                         | Cadastros > Contratos > F3 Filial > campo Regime tributário                      |
| `#filial_sici_numero_fistel#`                  | Número do Fistel (utilizado para geração do arquivo SICI) da filial. | Cadastros > Contratos > F3 Filial > campo Número fistel                          |
| `#filial_site#`                                | Site da filial.                                                      | Cadastros > Contratos > F3 Filial > campo Site                                   |
| `#filial_substituicao_tributaria#`             | Número da inscrição estadual de substituição tributária da filial.   | Cadastros > Contratos > F3 Filial > campo Inscrição Estadual (Subst. Tributário) |
| `#filial_telefone#`                            | Telefone da filial.                                                  | Cadastros > Contratos > F3 Filial > aba Endereço > campo Telefone                |
| `#filial_telefone_sac#` e `#filial_telefone1#` | Ambas trazem a informação do telefone SAC da filial.                 | Cadastros > Contratos > F3 Filial > aba Endereço > campo Telefone SAC            |
| `#filial_tipo_pessoa#`                         | Tipo de pessoa mencionado no campo.                                  | Cadastros > Contratos > F3 Filial > campo Tipo pessoa                            |
| `#filial_uf#`                                  | Estado da filial.                                                    | Cadastros > Contratos > F3 Filial > aba Endereço > F3 Cidade > campo UF          |


### Variáveis do [[formulario cliente|Formulário Cliente]]
As variáveis de Cadastro do Cliente são elementos dinâmicos que representam informações específicas do cadastro do cliente registrado no sistema. Quando incluídas no [[modelo de contrato do cliente|Modelo de Contrato do Cliente]], estas variáveis são automaticamente substituídas pelos dados reais do cliente durante a geração do contrato.
Confira, a seguir, a variável, o conceito de utilização e onde a informação está armazenada no sistema.

| **Variável**                                       | **Conceito**                                                                                                                                                         | **Caminho**                                                                                                |
| -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `#cliente_apartamento#`                            | Número do apartamento do cliente.                                                                                                                                    | Cadastros > Clientes > aba Endereço > campo Apartamento                                                    |
| `#cliente_bairro#`                                 | Bairro do cliente.                                                                                                                                                   | Cadastros > Clientes > aba Endereço > campo Bairro                                                         |
| `#cliente_bairro_cobranca#`                        | Bairro do cliente em endereço de cobrança.                                                                                                                           | Cadastros > Clientes > aba Endereço > campo Bairro cob.                                                    |
| `#cliente_bloco#`                                  | Bloco do endereço do cliente.                                                                                                                                        | Cadastros > Clientes > aba Endereço > campo Bloco                                                          |
| `#cliente_celular#`                                | Número do telefone celular do cliente.                                                                                                                               | Cadastros > Clientes > aba Contato > campo Telefone celular                                                |
| `#cliente_cep#`                                    | CEP do endereço do cliente.                                                                                                                                          | Cadastros > Clientes > aba Endereço > campo CEP                                                            |
| `#cliente_cep_cobranca#`                           | CEP do endereço de cobrança do cliente.                                                                                                                              | Cadastros > Clientes > aba Endereço > campo CEP cob.                                                       |
| `#cliente_cidade#`                                 | Cidade do endereço do cliente.                                                                                                                                       | Cadastros > Clientes > aba Endereço > campo Cidade                                                         |
| `#cliente_cidade_cobranca#`                        | Cidade do endereço de cobrança do cliente.                                                                                                                           | Cadastros > Clientes > aba Endereço > campo Cidade cob.                                                    |
| `#cliente_CNPJ_CPF#`                               | CPF/CNPJ do cadastro do cliente.                                                                                                                                     | Cadastros > Clientes > campo CNPJ/CPF                                                                      |
| `#cliente_codigo#` e `#cliente_id#`                | Ambas trazem a informação do ID do cliente cadastrado no sistema.                                                                                                    | Cadastros > Clientes > campo ID                                                                            |
| `#cliente_complemento#`                            | Complemento do endereço do cliente.                                                                                                                                  | Cadastros > Clientes > aba Endereço > campo Complemento                                                    |
| `#cliente_complemento_cobranca#`                   | Complemento do endereço de cobrança do cliente.                                                                                                                      | Cadastros > Clientes > aba Endereço > campo Complemento cob.                                               |
| `#cliente_condominio#`                             | Nome do condomínio do cliente.                                                                                                                                       | Cadastros > Clientes > aba Endereço > campo Condomínio                                                     |
| `#cliente_contato#`                                | Contato do cliente.                                                                                                                                                  | Cadastros > Clientes > aba Contato > campo Contato                                                         |
| `#cliente_contrato_taxa_improdutiva#`              | Valor informado na taxa de serviço improdutivo.                                                                                                                      | Cadastros > Contratos > aba Taxas ativação > campo Taxa de serviço improdutivo (R$)                        |
| `#cliente_contrato_taxa_instalacao#`               | Valor informado na taxa de instalação.                                                                                                                               | Cadastros > Contratos > aba Taxas ativação > campo Taxa de instalação (R$)                                 |
| `#cliente_cpf_mae#`                                | CPF da mãe do cliente.                                                                                                                                               | Cadastros > Clientes > aba Inf. > campo CPF mãe                                                            |
| `#cliente_cpf_pai#`                                | CPF do pai do cliente.                                                                                                                                               | Cadastros > Clientes > aba Inf. > campo CPF pai                                                            |
| `#cliente_data_nascimento#`                        | Data de nascimento do cliente.                                                                                                                                       | Cadastros > Clientes > campo Data de nascimento                                                            |
| `#cliente_email#`                                  | E-mail do cliente.                                                                                                                                                   | Cadastros > Clientes > aba Contato > campo E-mail principal                                                |
| `#cliente_endereco#`                               | Endereço do cliente.                                                                                                                                                 | Cadastros > Clientes > aba Endereço > campo Endereço                                                       |
| `#cliente_endereco_cobranca#`                      | Endereço de cobrança do cliente.                                                                                                                                     | Cadastros > Clientes > aba Endereço > campo Endereço cob.                                                  |
| `#cliente_contrato_valor_ate_vencimento_produtos#` | Valor até o vencimento.                                                                                                                                              | Cadastros > Contratos > aba Produtos > soma dos valores da coluna 'Valor até vencimento'                   |
| `#cliente_estado#`                                 | Estado do endereço do cliente.                                                                                                                                       | Cadastros > Clientes > aba Endereço > Cidade > UF                                                          |
| `#cliente_estado_civil#`                           | Estado civil do cliente.                                                                                                                                             | Cadastros > Clientes > campo Estado civil                                                                  |
| `#cliente_estado_cobranca#`                        | Estado do endereço de cobrança do cliente.                                                                                                                           | Cadastros > Clientes > aba Endereço > Cidade cob. > UF                                                     |
| `#cliente_fantasia#`                               | Nome fantasia do cliente.                                                                                                                                            | Cadastros > Clientes > campo Nome fantasia                                                                 |
| `#cliente_fone#`                                   | Número do telefone do cliente.                                                                                                                                       | Cadastros > Clientes > aba Contato > campo Telefone residencial                                            |
| `#cliente_fone_comercial#`                         | Número do telefone comercial do cliente.                                                                                                                             | Cadastros > Clientes > aba Contato > campo Telefone comercial                                              |
| `#cliente_hotsite_email#`                          | E-mail de acesso a central do assinante.                                                                                                                             | Cadastros > Clientes > aba Contato > campo Login                                                           |
| `#cliente_hotsite_senha#`                          | Senha de acesso a central do assinante.                                                                                                                              | Cadastros > Clientes > aba Contato > campo Senha                                                           |
| `#cliente_mesmo_endereco#`                         | Para casos em que o cliente possui o endereço de cobrança igual ao endereço padrão, irá trazer o valor vazio, e caso for distintos, irá trazer o valor "X".          | Cadastros > Contratos > aba Endereço                                                                       |
| `#cliente_nacionalidade#`                          | Nacionalidade do cliente.                                                                                                                                            | Cadastros > Clientes > campo Nacionalidade                                                                 |
| `#cliente_naturalidade#`                           | Naturalidade do cliente de dentro do cadastro do cliente.                                                                                                            | Cadastros > Clientes > campo Naturalidade                                                                  |
| `#cliente_nascimento_mae#`                         | Data de nascimento da mãe do cliente.                                                                                                                                | Cadastros > Clientes > aba Inf. > campo Data nascimento mãe                                                |
| `#cliente_nascimento_pai#`                         | Data de nascimento do pai do cliente.                                                                                                                                | Cadastros > Clientes > aba Inf. > campo Data nascimento pai                                                |
| `#cliente_nome_mae#`                               | Nome da mãe do cliente.                                                                                                                                              | Cadastros > Clientes > aba Inf. > campo Nome mãe                                                           |
| `#cliente_nome_pai#`                               | Nome do pai do cliente.                                                                                                                                              | Cadastros > Clientes > aba Inf. > campo Nome pai                                                           |
| `#cliente_nome_conjuge#`                           | Nome do cônjuge do cliente.                                                                                                                                          | Cadastros > Clientes > aba Inf. > campo Nome cônjuge                                                       |
| `#cliente_nome_representante_1#`                   | Nome do primeiro representante legal (contrato social) no caso do cliente ser pessoa jurídica.                                                                       | Cadastros > Clientes > aba Inf. > campo Nome representante legal 1                                         |
| `#cliente_nome_representante_2#`                   | Nome do segundo representante legal (contrato social) no caso do cliente ser pessoa jurídica.                                                                        | Cadastros > Clientes > aba Inf. > campo Nome representante legal 2                                         |
| `#cliente_cpf_representante_1#`                    | CPF do primeiro representante legal.                                                                                                                                 | Cadastros > Clientes > aba Inf. > campo CPF representante legal 1                                          |
| `#cliente_cpf_representante_2#`                    | CPF do segundo representante legal.                                                                                                                                  | Cadastros > Clientes > aba Inf. > campo CPF representante legal 2                                          |
| `#cliente_identidade_representante_1#`             | Número da identidade (RG) do primeiro representante legal.                                                                                                           | Cadastros > Clientes > aba Inf. > campo RG representante legal 1                                           |
| `#cliente_identidade_representante_2#`             | Número da identidade (RG) do segundo representante legal.                                                                                                            | Cadastros > Clientes > aba Inf. > campo RG representante legal 2                                           |
| `#cliente_deb_agencia#`                            | Número da agência do débito em conta (quando o cliente opta pelo pagamento por débito em conta, as informações são preenchidas na aba Outros do cadastro do cliente. | Cadastros > Clientes > aba Outros > campo Agência para débito                                              |
| `#cliente_deb_conta#`                              | Número da conta do débito em conta (quando o cliente opta pelo pagamento por débito em conta, as informações são preenchidas na aba Outros do cadastro do cliente.   | Cadastros > Clientes > aba Outros > campo Conta para débito                                                |
| `#cliente_inscricao_municipal#`                    | Número da inscrição municipal do cliente.                                                                                                                            | Cadastros > Clientes > aba Cliente > campo Inscrição Municipal                                             |
| `#cliente_numero#`                                 | Número do endereço do cliente, dependendo se no contrato estiver para puxar o endereço padrão do cliente ou do contrato.                                             | Cadastros > Clientes > aba Endereço > campo Número OU Cadastros > Contratos > aba Endereço > campo Número. |
| `#cliente_numero_padrao#`                          | Número de endereço do cliente, independente se tiver preenchido o número de endereço no contrato.                                                                    | Cadastros > Clientes > aba Endereço > campo Número                                                         |
| `#cliente_numero_cobranca#`                        | Número do endereço de cobrança do cliente.                                                                                                                           | Cadastros > Clientes > aba Endereço > campo Número cob.                                                    |
| `#cliente_obs#`                                    | Traz a informação inserida na aba Obs. no cadastro do cliente.                                                                                                       | Cadastros > Clientes > aba Obs. > campo Obs                                                                |
| `#cliente_profissao#`                              | Profissão do cliente.                                                                                                                                                | Cadastros > Clientes > campo Profissão                                                                     |
| `#cliente_razao#`                                  | Nome ou razão social do cliente.                                                                                                                                     | Cadastros > Clientes > campo Razão social/Nome                                                             |
| `#cliente_referencia#`                             | Referência do endereço do cliente.                                                                                                                                   | Cadastros > Clientes > aba Endereço > campo Referência                                                     |
| `#cliente_referencia_cob#`                         | Referência do endereço de cobrança do cliente.                                                                                                                       | Cadastros > Clientes > aba Endereço > campo Referência cob.                                                |
| `#cliente_RG_IE#`                                  | Número do RG ou inscrição estadual do cliente.                                                                                                                       | Cadastros > Clientes > campo IE/RG                                                                         |
| `#cliente_rg_mae#`                                 | Número do RG da mãe do cliente.                                                                                                                                      | Cadastros > Clientes > aba Inf. > campo RG mãe                                                             |
| `#cliente_rg_orgao_emissor#`                       | Órgão emissor do RG do cliente.                                                                                                                                      | Cadastros > Clientes > campo RG órgão emissor                                                              |
| `#cliente_rg_pai#`                                 | Número do RG do pai do cliente.                                                                                                                                      | Cadastros > Clientes > aba Inf. > campo RG pai                                                             |
| `#cliente_tipo#`                                   | Tipo de cliente informado no cadastro do cliente.                                                                                                                    | Cadastros > Clientes > campo Tipo cliente                                                                  |
| `#cliente_tipo_assinante#`                         | Tipo do assinante do cadastro do cliente (Ex.: Residencial/pessoa física ou Comercial/Industrial).                                                                   | Cadastros > Clientes > campo Tipo de assinante                                                             |
| `#cliente_uf#`                                     | Estado do endereço do cliente.                                                                                                                                       | Cadastros > Clientes > aba Endereço > F3 Cidade > UF                                                       |
| `#cliente_uf_cobranca#`                            | Estado do endereço de cobrança do cliente.                                                                                                                           | Cadastros > Clientes > aba Endereço > F3 Cidade cob. > UF                                                  |

### Variáveis de [[formulario planos de venda|Formulário Planos de Venda]]
As variáveis de Planos de Venda são elementos dinâmicos que representam informações específicas do cadastro do plano de venda registrado no sistema, associado ao contrato do cliente. Quando incluídas no [[modelo de contrato do cliente|Modelo de Contrato do Cliente]], estas variáveis são automaticamente substituídas pelos dados reais do plano de venda do contrato, durante a geração do contrato.
Confira, a seguir, a variável, o conceito de utilização e onde a informação está armazenada no sistema.

| Variável                                            | Conceito                                                                                                                                | Caminho                                                                                                                                                                                       |
| --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `#contrato_desc_aux_plano_venda#`                   | Descrição auxiliar do plano vinculado ao contrato.                                                                                      | Cadastros > Contratos > campo Descrição auxiliar do plano                                                                                                                                     |
| `#contrato_valor#` e `#contrato_valor_mensalidade#` | Ambas trazem a soma de valores dos produtos vinculados ao plano de venda por login do contrato.                                         | Cadastros > Contratos > F3 Plano de venda > campo Valor contrato                                                                                                                              |
| `#contrato_valor_bruto#`                            | Soma do valor total do produto antes dos descontos planos de venda.                                                                     | Cadastros > Contratos > aba Produtos > coluna Val. bruto                                                                                                                                      |
| `#contrato_valor_extenso#`                          | Informação descrita referente ao valor do produto do plano de venda.                                                                    | Cadastros > Contratos > aba Produtos > coluna Val. bruto                                                                                                                                      |
| `#contrato_valor_liquido#`                          | Informação do valor total do produto após os descontos do plano de venda.                                                               | Cadastros > Contratos > aba Produtos > coluna Val líquido.                                                                                                                                    |
| `#contrato_valor_liquido_desconto_por_meses#`       | Valor do plano com a soma dos descontos do plano de venda. Será descontado caso haja desconto dentro dos planos vinculados ao contrato. | Cadastros > Contrato > aba Produtos > coluna Val. Líquido > soma total. Aplica o desconto do plano de venda: Contrato > F3 Plano de venda > aba Planos > campo Valor do desconto > soma total |
| `#contrato_valor_liquido_extenso#`                  | Informação descrita do valor total do produto após os descontos do plano de venda.                                                      | Cadastros > Contratos > aba Produtos > coluna Val líquido. Puxa o desconto de: editar Produto > aba Descontos                                                                                 |
| `#franquia_mensal#`                                 | Limite mensal de consumo de cada cliente.                                                                                               | Cadastros > Contratos > aba Produtos > editar > F3 Plano > aba Redução de velocidade > campo Franquia mensal (Giga Bytes)                                                                     |
| `#upload_franquia_reduzida#`                        | Controle upload de banda reduzida informado dentro do plano vinculado ao contrato.                                                      | Cadastros > Contrato > F3 Plano de venda > aba Planos > F3 Plano > aba Controle de banda reduzido > campo Upload                                                                              |
| `#plano_valor_bruto#`                               | Essa variável deve ser responsável por validar o valor bruto associado ao plano de venda.                                               | Cadastros > Contratos>Plano de venda                                                                                                                                                          |
| `#plano_valor_liquido#`                             | Essa variável deve ser responsável por validar o valor liquido associado ao plano de venda.                                             | Cadastros > Contratos>Plano de venda                                                                                                                                                          |

### Variáveis de [[formulario contrato do cliente|Contrato do Cliente]]
As variáveis de Contrato são elementos dinâmicos que representam informações específicas do contrato do cliente. Quando incluídas no [[modelo de contrato do cliente|Modelo de Contrato do Cliente]], estas variáveis são automaticamente substituídas pelos dados reais do contrato, durante a geração do documento de contrato.
Confira, a seguir, a variável, o conceito de utilização e onde a informação está armazenada no sistema.

| Variável                                                | Conceito                                                                                                                                                                                                                                                                                                                                                                                            | Caminho                                                                                                                                                   |
| ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `#areceber_valor_vencido_aberto#`                       | Valor dos boletos com status á receber (vencido).                                                                                                                                                                                                                                                                                                                                                   | Cadastros > Contratos > aba Financeiro                                                                                                                    |
| `#assinatura_cliente#`                                  | Assinatura do cliente.  <br>Nome do arquivo: Contrato ID. com assinatura digital                                                                                                                                                                                                                                                                                                                    | Cadastros > Clientes > aba Arquivos                                                                                                                       |
| `#assinatura_empresa#`                                  | Assinatura da empresa.                                                                                                                                                                                                                                                                                                                                                                              | Menu configurações > Empresa > Filiais > aba Personalização > campo Imagem para assinatura nos contratos                                                  |
| `#ativacao_parcelas#`                                   | Número de parcelas informado na taxa de ativação.                                                                                                                                                                                                                                                                                                                                                   | Cadastros > Contratos > aba Taxas ativação > campo Número de parcelas                                                                                     |
| `#ativacao_valor_parcela#`                              | Valor da parcela do cliente.                                                                                                                                                                                                                                                                                                                                                                        | Cadastros > Contratos > aba Taxas ativação > campo Valor parcela (R$)                                                                                     |
| `#carteira_cobranca_descricao#`                         | Traz a informação descrita da carteira de cobrança.                                                                                                                                                                                                                                                                                                                                                 | Cadastros > Contratos > aba Faturamento > F3 Carteira de cobrança > campo Descrição                                                                       |
| `#contrato_cc_previsao#`                                | Regime contábil.                                                                                                                                                                                                                                                                                                                                                                                    | Cadastros > Contratos > aba Faturamento > campo Regime contábil - CRE                                                                                     |
| `#contrato_comissao#`                                   | Comissão informada no contrato.                                                                                                                                                                                                                                                                                                                                                                     | Cadastros > Contratos > aba Faturamento > campo Comissão                                                                                                  |
| `#contrato_data#`                                       | Data base financeiro.                                                                                                                                                                                                                                                                                                                                                                               | Cadastros > Contratos > campo Data base financeiro                                                                                                        |
| `#contrato_data_ativacao#`                              | Data de ativação do contrato.                                                                                                                                                                                                                                                                                                                                                                       | Cadastros > Contratos > campo Data ativação                                                                                                               |
| `#contrato_data_primeira_parcela#`                      | Informação do primeiro boleto gerado.                                                                                                                                                                                                                                                                                                                                                               | Cadastros > Contratos > aba Financeiro > coluna Vencimento                                                                                                |
| `#contrato_data_renovacao#`                             | Data de renovação inserida.                                                                                                                                                                                                                                                                                                                                                                         | Cadastros > Contratos > aba Contratos > campo Data renovação                                                                                              |
| `#contrato_data_expiracao#`                             | Data de expiração inserida.                                                                                                                                                                                                                                                                                                                                                                         | Cadastros > Contratos > aba Taxas de ativação > campo Data de expiração                                                                                   |
| `#contrato_data_ativacao_renovacao#`                    | Data ativação/renovação inserida.                                                                                                                                                                                                                                                                                                                                                                   | Cadastros > Contratos > campo Data ativação                                                                                                               |
| `#contrato_desconto_adicional#`                         | Valor total agrupado de todos os descontos adicionais ativos no contrato.                                                                                                                                                                                                                                                                                                                           | Cadastros > Contratos > aba Descontos Adicionais > soma da coluna Valor unitário                                                                          |
| `#contrato_desconto_fidelidade#`                        | Informação do desconto fidelidade.                                                                                                                                                                                                                                                                                                                                                                  | Cadastros > Contratos > aba Taxas ativação > campo Desconto fidelidade (R$)                                                                               |
| `#contrato_desconto_fidelidade_extenso#`                | Informação descrita do desconto fidelidade.                                                                                                                                                                                                                                                                                                                                                         | Cadastros > Contratos > aba Taxas ativação > campo Desconto fidelidade (R$)                                                                               |
| `#contrato_descricao#`                                  | Nome do plano de venda do contrato.                                                                                                                                                                                                                                                                                                                                                                 | Cadastros > Contratos > F3 Plano de venda > campo Plano de venda                                                                                          |
| `#contrato_descricao_comodato#`                         | Descrição dos produtos em comodato.                                                                                                                                                                                                                                                                                                                                                                 | Cadastros > Contratos > aba Comodato > campo Descrição produto                                                                                            |
| `#contrato_dia_vencimento#`                             | Informação do dia de vencimento informado na alteração de plano do contrato.                                                                                                                                                                                                                                                                                                                        | Cadastro > Contratos > F3 Tipo de cobrança > F3 Condições de pagamento > campo Dia fixo de vencimento                                                     |
| `#contrato_download_aceleracao_max#`                    | Controle de banda padrão vinculado ao plano de venda quando se trata do Tipo: Internet e Telefonia.                                                                                                                                                                                                                                                                                                 | Cadastros > Contrato > F3 Plano de venda > aba Planos > editar > F3 Plano > aba Controle de banda padrão > seção Controle de download > campo Burst Limit |
| `#contrato_fidelidade_meses#` e `#contrato_fidelidade#` | Informação da quantidade de meses preenchido na fidelidade do contrato.                                                                                                                                                                                                                                                                                                                             | Cadastros > Contratos > aba Taxas ativação > campo Fidelidade (meses)                                                                                     |
| `#contrato_forma_cobranca#`                             | Tipo de recebimento informado na carteira de cobrança.                                                                                                                                                                                                                                                                                                                                              | Cadastro > Contratos > aba Faturamento > F3 Carteira de cobrança > campo Tipo de recebimento                                                              |
| `#contrato_garantia_download#`                          | Garantia de download relacionado ao plano de velocidade do contrato. Ex: 490000K.                                                                                                                                                                                                                                                                                                                   | Cadastros > Contratos > aba Produtos > editar > F3 Plano > aba Controle de banda padrão > campo Garantia de Download (k ou M)                             |
| `#contrato_garantia_upload#`                            | Garantia de upload relacionado ao plano de velocidade do contrato. Ex: 3490000K.                                                                                                                                                                                                                                                                                                                    | Cadastros > Contratos > aba Produtos > editar > F3 Plano > aba Controle de banda padrão > campo Garantia de Upload (k ou M)                               |
| `#contrato_grade_comodato#`                             | Apresenta a tabela dos produtos que estão em comodato informando o Código, Produto, Qtde, Valor Unitário, Valor Total, Patrimônio, Núm Série.                                                                                                                                                                                                                                                       | Cadastros > Contratos > aba Comodato                                                                                                                      |
| `#contrato_grade_comodato_2#`                           | Apresenta a tabela com os produtos em comodato, apresentando: código, nome do equipamento em comodato e quantidade.                                                                                                                                                                                                                                                                                 | Cadastros > Contratos > aba Comodato                                                                                                                      |
| `#contrato_grade_comodato_sem_val#`                     | Apresenta a tabela de produto em comodato informando o Código, Produto, Qtde, Patrimônio, Núm Série sem apresentar o valor.                                                                                                                                                                                                                                                                         | Cadastros > Contratos > aba Comodato                                                                                                                      |
| `#contrato_upload_aceleracao_max#`                      | Apresenta a aceleração máxima de upload relacionado ao plano de velocidade vinculado ao contrato, com a extensão 'bps'.                                                                                                                                                                                                                                                                             | Cadastros > Contratos > aba Produto > editar > F3 Plano > aba Controle de banda padrão > campo Burst Limit                                                |
| `#contrato_nome#`                                       | Descrição informada no contrato.                                                                                                                                                                                                                                                                                                                                                                    | Cadastros > Contratos > campo Descrição                                                                                                                   |
| `#contrato_numero#`                                     | Número ID do contrato.                                                                                                                                                                                                                                                                                                                                                                              | Cadastros > Contratos > campo ID                                                                                                                          |
| `#contrato_obs#`                                        | Observação relacionado ao contrato.                                                                                                                                                                                                                                                                                                                                                                 | Cadastros > Contratos > aba Status (bloqueio, redução, suspensão) > campo Observação                                                                      |
| `#contrato_status_internet#`                            | Status de acesso da Internet.  <br>A: Ativo  <br>D: Desativado  <br>CM: Bloqueio manual  <br>CA: Bloqueio automático  <br>FA: Financeiro em atraso  <br>AA: Aguardando assinatura                                                                                                                                                                                                                   | Cadastros > Contratos > campo Status acesso                                                                                                               |
| `#contrato_taxa_improdutiva#`                           | Taxa de serviço improdutivo (R$).                                                                                                                                                                                                                                                                                                                                                                   | Cadastros > Contratos > aba Taxas ativação > campo Taxa de serviço improdutivo (R$)                                                                       |
| `#contrato_taxa_improdutiva_extenso#`                   | Informação descrita da taxa de serviço improdutivo (R$).                                                                                                                                                                                                                                                                                                                                            | Cadastros > Contratos > aba Taxas ativação > campo Taxa de serviço improdutivo (R$)                                                                       |
| `#contrato_taxa_instalacao#`                            | Valor da taxa de instalação do contrato.                                                                                                                                                                                                                                                                                                                                                            | Cadastros > Contratos > aba Taxas ativação > campo Taxa de instalação (R$).                                                                               |
| `#contrato_taxa_instalacao_extenso#`                    | Informação descrita do valor da taxa de instalação do contrato.                                                                                                                                                                                                                                                                                                                                     | Cadastros > Contratos > aba Taxas ativação > campo Taxa de instalação (R$)                                                                                |
| `#contrato_tipo#`                                       | Tipo de contrato informado (Internet, Telefonia, Serviços, SVA) conforme seleção.                                                                                                                                                                                                                                                                                                                   | Cadastros > Contratos > campo Tipo                                                                                                                        |
| `#contrato_tipo_cobranca#`                              | Tipo de envio de cobrança (Configuração padrão, Impresso ou E-mail).                                                                                                                                                                                                                                                                                                                                | Cadastros > Contratos > aba Faturamento > campo Tipo de envio de cobrança                                                                                 |
| `#contrato_servico_adicional#`                          | Valor total agrupado de todos os serviços adicionais ativos no contrato.                                                                                                                                                                                                                                                                                                                            | Cadastros > Contratos > aba Serviços adicionais > campo Valor total                                                                                       |
| `#contrato_vencimentos#` e `#ativacao_vencimentos#`     | Data de todos os vencimentos relacionados ao contrato.                                                                                                                                                                                                                                                                                                                                              | Cadastros > Contratos > aba Taxas ativação > campo Vencimentos                                                                                            |
| `#contrato_vencimento_dia#`                             | Vencimento do contrato estipulado no tipo de cobrança.                                                                                                                                                                                                                                                                                                                                              | Cadastros > Contratos > F3 Tipo de cobrança > F3 Condições de pagamento > campo Dia fixo de vencimento                                                    |
| `#contrato_vencimento_nome#`                            | Nome da descrição de pagamento atrelada ao contrato.                                                                                                                                                                                                                                                                                                                                                | Cadastros > Contratos > F3 Tipo de cobrança > F3 Condições de pagamento > campo Descrição                                                                 |
| `#contrato_vendedor#`                                   | Vendedor informado na aba faturamento do contrato.                                                                                                                                                                                                                                                                                                                                                  | Cadastros > Contratos > aba Faturamento > F3 Vendedor > campo Vendedor                                                                                    |
| `#contrato_valor_comodato#`                             | Valor somado de todos os comodatos existentes para o contrato.                                                                                                                                                                                                                                                                                                                                      | Cadastros > Contratos > aba Comodato > coluna Valor total                                                                                                 |
| `#cobranca_lista_areceber#`                             | Lista todos os boletos que o cliente possui em aberto (não vencidos), apresentando o ID, valor em aberto e a data de vencimento.                                                                                                                                                                                                                                                                    | Cadastros > Contratos > aba Financeiro                                                                                                                    |
| `#data_ativacao_extenso#`                               | Informação descrita da data de ativação do contrato.                                                                                                                                                                                                                                                                                                                                                | Cadastros > Contratos > campo Data ativação                                                                                                               |
| `#data_atual#`                                          | Data atual separada por barra.                                                                                                                                                                                                                                                                                                                                                                      | Ex: 18/10/2021.                                                                                                                                           |
| `#data_atual_extenso#`                                  | Data atual informando o dia, mês e ano.                                                                                                                                                                                                                                                                                                                                                             | Ex: 20 de Janeiro de 2021.                                                                                                                                |
| `#data_cancelamento#`                                   | Data em que foi cancelado o contrato vinculado ao cliente.                                                                                                                                                                                                                                                                                                                                          | Cadastros > Contratos > aba Cancel./Negat./Desist. > campo Data do cancelamento                                                                           |
| `#data_extenso#`                                        | Informação descrita da data base financeiro do contrato.                                                                                                                                                                                                                                                                                                                                            | Cadastros > Contratos > campo Data base financeiro                                                                                                        |
| `#desc_cancelamento#`                                   | Descrição preenchida ao cancelar o contrato vinculado ao cliente.                                                                                                                                                                                                                                                                                                                                   | Cadastros > Contratos > aba Cancel./Negat./Desist. > campo Descrição do cancelamento                                                                      |
| `#desconto_produto_valor_liquido#`                      | Traz de dentro do contrato na aba produto, valor liquido do desconto.                                                                                                                                                                                                                                                                                                                               | Cadastros > Contratos > aba Produtos > aba Desconto > campo Valor. Irá puxar o valor total da coluna Val. Desc.                                           |
| `#descricao_plano_valor_1#` `#descricao_plano_valor_2#` | Ambas apresentam as informações do plano de velocidade vinculado ao plano de venda. Plano 1: traz o preço combo com e sem fidelização, e o nome do plano. Plano 2: traz o nome do plano e o preço avulso.                                                                                                                                                                                           | Cadastros > Contratos > F3 Plano de venda > aba Planos                                                                                                    |
| `#download#`                                            | Apresenta velocidade para download de acordo com o plano de velocidade relacionado ao contrato. OBS: Quando for 1000M não modificar para 1 Gbps, buscando permanecer 1,000.00 Mbps. Isso ocorre devido a formatação de velocidades ocorrer de forma binária (1025) e não em decimal (10), portanto o cálculo sempre será em 1025. Precisa inserir no mínimo 1025M para que se modifique para 1Gbps. | Cadastros > Contratos > F3 Plano de venda > F3 Plano > aba Controle de banda padrão > campo Download                                                      |
| `#upload#`                                              | Apresenta velocidade para upload de acordo com o plano de velocidade relacionado ao contrato. OBS: Quando for 1000M não modificar para 1 Gbps, buscando permanecer 1,000.00 Mbps. Isso ocorre devido a formatação de velocidades ocorrer de forma binária (1025) e não em decimal (10), portanto o cálculo sempre será em 1025. Precisa inserir no mínimo 1025M para que se modifique para 1Gbps.   | Cadastros > Contratos > F3 Plano de venda > F3 Plano > aba Controle de banda padrão > campo Upload                                                        |
| `#download_franquia_reduzida#`                          | Controle de download, referente ao plano de velocidade relacionado ao contrato do cliente.                                                                                                                                                                                                                                                                                                          | Cadastros > Contratos > F3 Plano de venda > F3 Plano > aba Controle de banda reduzido > campo Download (k ou M)                                           |
| `#grade_desconto_fidelidade#`                           | Apresenta uma grade, informando separadamente os descontos do plano que forem como quantidade, trazendo o total delas. Também traz os descontos, sem trazer o total deles.                                                                                                                                                                                                                          | Menu sistema > Cadastros > Contratos > Planos de venda > Editar > aba planos > Editar > Quantidade de repetições do desconto                              |
| `#grade_produtos_sem_desconto_e_acrescimo#`             | Informação da grade de produtos com a descrição dos mesmos como ID, produto, qtde, valor unt. valor total e valor líquido, com o cálculo de valor de desconto e acréscimo já constante nos valores.                                                                                                                                                                                                 | Cadastros > Contratos > aba Produtos                                                                                                                      |
| `#grade_produtos_desconto_plano#`                       | Apresenta a tabela de produtos em desconto, referente ao plano por contrato vinculados ao produto.                                                                                                                                                                                                                                                                                                  | Cadastros > Contratos > aba Produtos > coluna Val. Desc.                                                                                                  |
| `#grade_tv#`                                            | Traz apenas os valores dos produtos do tipo TV que fazem parte do contrato.                                                                                                                                                                                                                                                                                                                         | Cadastros > Contratos > aba Produtos > Tipo: TV/Streaming                                                                                                 |
| `#grade_comodato_devolvido_contrato#`                   | Apresenta a tabela de produtos com status de devolvido e baixa, informando as seguintes informações: ID Produto, Equipamentos em Comodato, Data, ID Devolução, Qtde, Qtde Devolução e Status.                                                                                                                                                                                                       | Cadastros > Contratos > aba Comodato > status Devolvido/Baixa                                                                                             |
| `#grade_comodato_emprestado_contrato#`                  | Apresenta a tabela de produtos em comodato, informando as seguintes informações: ID Produto, Equipamentos em Comodato, Data, Qtde e Status.                                                                                                                                                                                                                                                         | Cadastros > Contratos > aba Comodato > status Emprestado                                                                                                  |
| `#grade_internet#`                                      | Apresenta a tabela de produtos tipo Internet vinculados ao contrato, informando as seguintes informações: ID Produto, Produto, Qtde, Vlr. Unitário, Vlr Total, Desconto, Acréscimo, Vlr Líquido.                                                                                                                                                                                                    | Cadastros > Contratos > aba Produtos > campo Tipo: Internet                                                                                               |
| `#grade_logins#`                                        | Apresenta a tabela informando logins ativos e inativos ao contrato. Login, senha e plano a qual o login vinculado serão apresentados.                                                                                                                                                                                                                                                               | Cadastros > Contratos > aba Logins                                                                                                                        |
| `#grade_logins_ativos#`                                 | Apresenta a tabela informando os logins ativos nos contratos.                                                                                                                                                                                                                                                                                                                                       | Cadastros > Contratos > aba Logins                                                                                                                        |
| `#grade_mvno#`                                          | Traz todos os produtos do tipo MVNO que exista no contrato                                                                                                                                                                                                                                                                                                                                          | Cadastros > contratos > aba produtos > tipo: MVNO                                                                                                         |
| `#grade_planos_quantidade_meses_desconto#`              | Apresenta a tabela informando o plano vinculado ao contrato, informando o ID Produto, Produto e Quantidade de Meses para o Desconto.                                                                                                                                                                                                                                                                | Cadastros > Contratos > F3 Plano de venda > aba Planos                                                                                                    |
| `#grade_produtos#`                                      | Apresenta a tabela de produtos vinculados ao contrato informando as seguintes informações, ID Prod, Produto, Qtde, Vlr Unitário, Vlr Total, Desconto, Acréscimo, Vlr Líquido.                                                                                                                                                                                                                       | Cadastros > Contratos > aba Produtos                                                                                                                      |
| `#grade_produtos_avulso_internet#`                      | Deverá validar somente os produtos com tipo vínculo contrato, e que tenha o tipo internet                                                                                                                                                                                                                                                                                                           | Cadastros > contratos > aba produtos > tipo: internet > vínculo: contrato                                                                                 |
| `#grade_produtos_avulso_mvno#`                          | Deverá validar somente os produtos com tipo vínculo contrato, e que tenha o tipo MVNO                                                                                                                                                                                                                                                                                                               | Cadastros > contratos > aba produtos > tipo: MVNO > vínculo: contrato                                                                                     |
| `#grade_produtos_avulso_servicos#`                      | Deverá validar somente os produtos com tipo vínculo contrato, e que tenha o tipo serviço                                                                                                                                                                                                                                                                                                            | Cadastros > contratos > aba produtos > tipo: serviço > vínculo: contrato                                                                                  |
| `#grade_produtos_avulso_sva#`                           | Deverá validar somente os produtos com tipo vínculo contrato, e que tenha o tipo SVA                                                                                                                                                                                                                                                                                                                | Cadastros > contratos > aba produtos > tipo: SVA > vínculo: contrato                                                                                      |
| `#grade_produtos_avulso_telefonia#`                     | Deverá validar somente os produtos com tipo vínculo contrato, e que tenha o tipo telefonia                                                                                                                                                                                                                                                                                                          | Cadastros > contratos > aba produtos > tipo: Telefonia > vínculo: contrato                                                                                |
| `#grade_produtos_avulso_tv#`                            | Deverá validar somente os produtos com tipo vínculo contrato, e que tenha o tipo TV                                                                                                                                                                                                                                                                                                                 | Cadastros > contratos > aba produtos > tipo: TV > vínculo: contrato                                                                                       |
| `#grade_servicos#`                                      | Apresenta a tabela com produtos Serviço vinculados ao contrato, informando as seguintes informações: ID Prod, Tipo, Produto, Vlr Unitário, Qtde, Vlr Total e Vlr Total Com Qtd de Parcelas.                                                                                                                                                                                                         | Cadastros > Contratos > aba Serviços adicionais                                                                                                           |
| `#grade_servicos_produtos#`                             | Apresenta a tabela com produtos do tipo Serviços/Produtos vinculados ao contrato, informando as seguintes informações: ID Prod, Produto, Qtde, Vlr. Unitário, Vlr Total, Desconto, Acréscimo e Vlr Líquido.                                                                                                                                                                                         | Cadastros > Contratos > aba Produtos > Tipo: Serviços/Produtos                                                                                            |
| `#grade_sva#`                                           | Apresenta a tabela com produtos SVA vinculados ao contrato, informando as seguintes informações: ID Prod, Produto, Qtde, Vlr Unitário, Vlr Total, Desconto, Acréscimos e Vlr Líquido.                                                                                                                                                                                                               | Cadastros > Contratos > aba Produtos > Tipo: SVA                                                                                                          |
| `#grade_sva_desconto_plano#`                            | Traz a grade com informações dos produtos SVA, mas puxando o desconto do plano de venda, informando as seguintes informações: ID Prod, Produto, Qtde, Vlr. Unitário, Desconto e Vlr. Líquido.                                                                                                                                                                                                       | Cadastros > Contrato > F3 Plano de venda > aba Planos > editar > Tipo: SVA > campo Valor do desconto                                                      |
| `#grade_telefonia#`                                     | Apresenta a tabela com produtos Telefonia vinculados ao contrato, informando as seguintes informações: ID Prod, Produto, Qtde, Vlr Unitário, Vlr Total, Desconto, Acréscimos e Vlr Liquido.                                                                                                                                                                                                         | Cadastros > Contratos > aba Produtos > Tipo: Telefonia                                                                                                    |
| `#ip_fixo#`                                             | IP Fixo relacionado ao login do cliente vinculado ao contrato.                                                                                                                                                                                                                                                                                                                                      | Cadastros > Contratos > aba Logins > aba IP/MAC > campo Endereço IP                                                                                       |
| `#motivo_cancelamento#`                                 | Motivo de cancelamento do contrato.                                                                                                                                                                                                                                                                                                                                                                 | Cadastros > Contratos > aba Cancel./Negat/.Desist. > F3 Motivo do cancelamento > campo Motivo                                                             |
| `#nome_indexador#`                                      | Nome do indexador relacionado ao contrato do cliente no campo Indexador.                                                                                                                                                                                                                                                                                                                            | Cadastros > Contratos > campo Indexador                                                                                                                   |
| `#radgrupos_busrt_upload_busrt#`                        | Valor do Burst Limit referente ao upload vinculado ao plano do cliente.                                                                                                                                                                                                                                                                                                                             | Cadastros > Contrato > F3 Plano de venda > aba Planos > editar > F3 Plano > aba Controle de banda padrão > seção Controle de download > campo Burst Limit |
| `#radgrupos_busrt_upload_busrt_th#`                     | Valor do Burst Threshold referente ao upload vinculado ao plano do cliente.                                                                                                                                                                                                                                                                                                                         | Cadastros > Contratos > aba Produto > editar > F3 Plano > aba Controle de banda padrão > campo Burst Threshold                                            |
| `#radgrupos_busrt_upload_busrt_time#`                   | Valor do Burst Time referente ao upload vinculado ao plano do cliente.                                                                                                                                                                                                                                                                                                                              | Cadastros > Contratos > aba Produto > editar > F3 Plano > aba Controle de banda padrão > campo Burst Time                                                 |
| `#SSID_Router_Wifi#`                                    | Nome do Wi-Fi relacionado à internet do cliente.                                                                                                                                                                                                                                                                                                                                                    | Cadastros > Contratos > aba Logins > campo SSID router wi-fi                                                                                              |
| `#Senha_router_wifi#`                                   | Senha do Wi-Fi relacionado à internet do cliente.                                                                                                                                                                                                                                                                                                                                                   | Cadastros > Contratos > aba Logins > campo Senha router wi-fi                                                                                             |
| `#servico_adicional_valor_unitario#`                    | Apresenta a tabela de produtos com a descrição de cada serviço adicional e o seu valor unitário.                                                                                                                                                                                                                                                                                                    | Cadastros > Contratos > aba Serviços adicionais                                                                                                           |
| `#taxa_ativacao_com_desconto_fidelidade#`               | Informação do valor da taxa de ativação já com o desconto aplicado. Irá subtrair o desconto (taxa de instalação - desconto fidelidade)                                                                                                                                                                                                                                                              | Cadastros > Contratos > aba Taxa ativação > campo Desconto fidelidade (R$)                                                                                |
| `#taxa_ativacao_com_desconto_fidelidade_extenso#`       | Informação descrita do valor da taxa de ativação já com o desconto aplicado. Irá subtrair o desconto (taxa de instalação - desconto fidelidade)                                                                                                                                                                                                                                                     | Cadastros > Contratos > aba Taxa ativação > campo Desconto fidelidade (R$)                                                                                |
| `#taxa_instalacao_isenta#`                              | Exibe a informação "ISENTO" no contrato.                                                                                                                                                                                                                                                                                                                                                            | Campo fixo ISENTO.                                                                                                                                        |
| `#taxa_instalacao#`                                     | Preço da taxa de instalação, caso o campo desconto fidelidade estiver preenchido, será subtraído no valor total.                                                                                                                                                                                                                                                                                    | Cadastros > Contratos > aba Taxas ativação > campo Taxa de instalação (R$)                                                                                |
| `#taxa_instalacao_descricao_produto#`                   | Descrição do produto da taxa de instalação.                                                                                                                                                                                                                                                                                                                                                         | Cadastros > Contratos > aba Taxas ativação > F3 Produto > campo Produto                                                                                   |
| `#total_internet_sva#`                                  | Valor líquido total de todos os produtos do Tipo: Internet e/ou SVA                                                                                                                                                                                                                                                                                                                                 | Cadastros > Contratos > aba Produtos > Tipo: Internet e/ou SVA                                                                                            |
| `#valor_mensal_com_adicional#`                          | Valor líquido descrito da aba produtos + o valor dos serviços adicionais considerando Ativos e Inativos (caso houver).                                                                                                                                                                                                                                                                              | Cadastros > Contratos > aba Produtos > soma da coluna Val. Líquido + Cadastros > Contratos > aba Serviços adicionais > Valor total                        |
| `#valor_mensal_com_adicional_ativo#`                    | Valor líquido descrito da aba produtos + o valor dos serviços adicionais considerando Ativos (caso houver).                                                                                                                                                                                                                                                                                         | Cadastros > Contratos > aba Produtos > soma da coluna Val. Líquido + Cadastros > Contratos > aba Serviços adicionais > Valor total                        |
| `#valor_mensal_com_adicional_extenso#`                  | Valor líquido descrito da aba produtos + o valor dos serviços adicionais considerando Ativos e Inativos (caso houver).                                                                                                                                                                                                                                                                              | Cadastros > Contratos > aba Produtos > soma da coluna Val. Líquido + Cadastros > Contratos > aba Serviços adicionais > Valor total                        |
| `#valor_total_comodatos_emprestados#`                   | Valor somado para todos os comodatos emprestados que possui no contrato.                                                                                                                                                                                                                                                                                                                            | Cadastros > Contratos > aba Comodato > soma dos valores da coluna Valor total                                                                             |
| `#valor_total_grade_mvno#`                              | Soma de todos os produtos do tipo MVNO inseridos no contratos                                                                                                                                                                                                                                                                                                                                       | Cadastros > contratos > aba produtos > tipo: MVNO >                                                                                                       |
| `#valor_total_grade_internet#`                          | Valor dos produtos do tipo Internet, incluindo os descontos aplicados no plano.                                                                                                                                                                                                                                                                                                                     | Cadastros > Contratos > aba Produtos > editar > coluna Val. Líquido                                                                                       |
| `#valor_total_grade_sva#`                               | Valor dos produtos do tipo SVA, incluindo os descontos aplicados no plano.                                                                                                                                                                                                                                                                                                                          | Cadastros > Contratos > aba Produtos > editar > coluna Val. Líquido                                                                                       |
| `#valor_total_grade_telefonia#`                         | Valor dos produtos do tipo Telefonia, incluindo os descontos aplicados no plano.                                                                                                                                                                                                                                                                                                                    | Cadastros > Contratos > aba Produtos > editar > coluna Val. Líquido                                                                                       |
| `#valor_total_produtos#`                                | Soma do valor líquido de todos os produtos vinculados ao contrato.                                                                                                                                                                                                                                                                                                                                  | Cadastros > Contratos > aba Produtos                                                                                                                      |
| `#valor_total_servicos#`                                | Soma do valor total dos produtos vinculados na aba serviços adicionais.                                                                                                                                                                                                                                                                                                                             | Cadastros > Contratos > aba Serviços adicionais > Valor total                                                                                             |
| `#valor_total_servicos_com_parcelas#`                   | Valor do último registro de serviço adicional subtraindo o valor do registro na aba descontos adicionais.                                                                                                                                                                                                                                                                                           | Cadastro > Contratos > aba Serviços adicionais > Editar último registro > Campo "Valor Unitário                                                           |
| `#valor_total_servicos_contrato#`                       | Soma líquido dos produtos do Tipo: Serviços/Produtos vinculados ao contrato do cliente.                                                                                                                                                                                                                                                                                                             | Cadastros > Contratos > aba Produtos > Val. Líquido dos produtos Tipo: Serviços/Produtos                                                                  |
| `#valor_total_servicos_contrato_extenso#`               | Soma líquido descrita dos produtos do Tipo: Serviços/Produtos vinculados ao contrato do cliente.                                                                                                                                                                                                                                                                                                    | Cadastros > Contratos > aba Produtos > Val. Líquido dos produtos Tipo: Serviços/Produtos                                                                  |
| `#valor_total_servicos_extenso#`                        | Soma descrita do valor total dos produtos vinculados na aba serviços adicionais.                                                                                                                                                                                                                                                                                                                    | Cadastros > Contratos > aba Serviços adicionais > Valor total                                                                                             |
| `#grade_produtos_plano#`                                | Essa variável deve buscar os produtos que estão atrelados ao plano do contrato em questão.                                                                                                                                                                                                                                                                                                          | Cadastros > Contratos > Aba Produtos > Produtos com vinculo no plano de venda                                                                             |
| `#produtos_simples#`                                    | Essa variável deve trazer apenas a informação dos produtos que tenham o vinculo com o plano.                                                                                                                                                                                                                                                                                                        | Cadastros > Contratos > Aba                                                                                                                               |
| `#grade_produtos_vinculo_plano_e_contrato#`             | Essa variável  busca os produtos que estão atrelados ao contrato do cliente, e informa em um campo qual é o vinculo deste produto, se ele se refere a **Contrato** ou **Plano**.                                                                                                                                                                                                                    | Cadastros > Contratos > Aba Produtos > Produtos com vinculo no plano de venda e contrato.<br>                                                             |

>[!TIP] Dica
Para identificar o vínculo de um produto no contrato, uma coluna indicará se ele pertence ao **plano de venda** ou ao **contrato**.
  **Vínculo ao plano de venda**: O produto foi adicionado automaticamente ao incluir o plano de venda.
 **Vínculo ao contrato**: O produto foi adicionado manualmente diretamente no contrato.

### Variáveis de Endereço de Contrato
As variáveis de Contrato são elementos dinâmicos que representam informações específicas do endereço de contrato do cliente. Quando incluídas no [[modelo de contrato do cliente|Modelo de Contrato do Cliente]], estas variáveis são automaticamente substituídas pelos dados reais do endereço do contrato, durante a geração do documento.
Confira, a seguir, a variável, o conceito de utilização e onde a informação está armazenada no sistema

| Variável | Conceito | Caminho |
| --- | --- | --- |
| `#contrato_apartamento#` | Apartamento do cliente, dependendo se no contrato estiver para puxar o endereço padrão do cliente ou do contrato. | Cadastros > Contratos > aba Endereço > campo Apartamento OU Cadastros > Contratos > aba Endereço > campo Apartamento |
| `#contrato_bairro#` | Bairro do cliente, dependendo se no contrato estiver para puxar o endereço padrão do cliente ou do contrato. | Cadastros > Contratos > aba Endereço > campo Bairro OU Cadastros > Contratos > aba Endereço > campo Bairro |
| `#contrato_bloco#` | Bloco do cliente, dependendo se no contrato estiver para puxar o endereço padrão do cliente ou do contrato. | Cadastros > Contratos > aba Endereço > campo Bloco OU Cadastros > Contratos > aba Endereço > campo Bloco |
| `#contrato_cep#` | CEP do cliente, dependendo se no contrato estiver para puxar o endereço padrão do cliente ou do contrato. | Cadastros > Contratos > aba Endereço > campo CEP OU Cadastros > Contratos > aba Endereço > campo CEP |
| `#contrato_cidade#` | Cidade do cliente, dependendo se no contrato estiver para puxar o endereço padrão do cliente ou do contrato. | Cadastros > Contratos > aba Endereço > campo Cidade OU Cadastros > Contratos > aba Endereço > campo Cidade |
| `#contrato_complemento#` | Complemento do cliente, dependendo se no contrato estiver para puxar o endereço padrão do cliente ou do contrato. | Cadastros > Contratos > aba Endereço > campo Complemento OU Cadastros > Contratos > aba Endereço > campo Complemento |
| `#contrato_condominio#` | Condomínio do cliente, dependendo se no contrato estiver para puxar o endereço padrão do cliente ou do contrato. | Cadastros > Contratos > aba Endereço > campo Condomínio OU Cadastros > Contratos > aba Endereço > campo Condomínio |
| `#contrato_endereco#` | Endereço do cliente, dependendo se no contrato estiver para puxar o endereço padrão do cliente ou do contrato. | Cadastros > Contratos > aba Endereço > campo Endereço OU Cadastros > Contratos > aba Endereço > campo Endereço |
| `#endereco_contrato#` | Ambas trazem a informação do endereço completo (rua, complemento, número, referência e bairro) dependendo se no contrato estiver para puxar o endereço padrão do cliente ou do contrato. | Cadastros > Contratos > aba Endereço OU Cadastros > Contratos > aba Endereço |
| `#contrato_endereco_numero#` | Número da rua do cliente, dependendo se no contrato estiver para puxar o endereço padrão do cliente ou do contrato. | Cadastros > Contratos > aba Endereço > campo Número OU Cadastros > Contratos > aba Endereço > campo Número |
| `#contrato_estado#` | Estado do cliente, dependendo se no contrato estiver para puxar o endereço padrão do cliente ou do contrato. | Cadastros > Contratos > aba Endereço > campo Estado OU Cadastros > Contratos > aba Endereço > campo Estado |
| `#contrato_referencia#` | Referência do cliente, dependendo se no contrato estiver para puxar o endereço padrão do cliente ou do contrato. | Cadastros > Contratos > aba Endereço > campo Referência OU Cadastros > Contratos > aba Endereço > campo Referência |
| `#contrato_uf#` | UF do cliente, dependendo se no contrato estiver para puxar o endereço padrão do cliente ou do contrato. | Cadastros > Contratos > aba Endereço > F3 Cidade > campo UF OU Cadastros > Contratos > aba Endereço > F3 Cidade > campo UF |

### Variáveis Login
As variáveis de Login são elementos dinâmicos que representam informações específicas do login relacionado ao contrato do cliente. Quando incluídas no [[modelo de contrato do cliente|Modelo de Contrato do Cliente]], estas variáveis são automaticamente substituídas pelos dados reais do login durante a geração do documento de contrato.
Confira, a seguir, a variável, o conceito de utilização e onde a informação está armazenada no sistema

| Variável                            | Conceito                                                                                                                             | Caminho                                                                      |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- |
| `#apartamento_login#`               | Número do apartamento referente ao endereço do login.                                                                                | Cadastros > Contratos > aba Logins > aba Endereço > campo Apartamento        |
| `#bairro_login#`                    | Bairro referente ao endereço do login.                                                                                               | Cadastros > Contratos > aba Logins > aba Endereço > campo Bairro             |
| `#bloco_login#`                     | Bloco referente ao endereço do login.                                                                                                | Cadastros > Contratos > aba Logins > aba Endereço > campo Bloco              |
| `#cep_login#`                       | CEP referente ao endereço do login.                                                                                                  | Cadastros > Contratos > aba Logins > aba Endereço > campo CEP                |
| `#cidade_login#`                    | Cidade referente ao endereço do login.                                                                                               | Cadastros > Contratos > aba Logins > aba Endereço > campo Cidade             |
| `#complemento_login#`               | Complemento referente ao endereço do login.                                                                                          | Cadastros > Contratos > aba Logins > aba Endereço > campo Complemento        |
| `#condominio_login#`                | ID do condomínio referente ao cadastro do login.                                                                                     | Cadastros > Contratos > aba Logins > aba Endereço > campo Condomínio         |
| `#endereco_login#`                  | Endereço referente ao login do cliente, apresentando o campo endereço, número, complemento, bairro, cidade, bloco, referência e CEP. | Cadastros > Contratos > aba Logins > aba Endereço                            |
| `#login#` e `#login_pppoe_hotspot#` | Ambas trazem a informação do login vinculado ao contrato.                                                                            | Cadastros > Contratos > aba Logins > campo Login                             |
| `#numero_login#`                    | Número referente ao login.                                                                                                           | Cadastros > Contratos > aba Logins > aba Endereço > campo Número             |
| `#referencia_login#`                | Referência vinculado ao login do cliente, dependendo se no login estiver para puxar o endereço padrão do cliente ou do login.        | Cadastros > Contrato > aba Logins > editar > aba Endereço > campo Referência |
| `#senha#` e `#senha_pppoe_hotspot#` | Senha PPPoE inserida dentro do login vinculado ao contrato.                                                                          | Cadastros > Contrato > aba Logins > editar > campo Senha PPPoE/Hotspot       |
| `#tipo_de_conexao#`                 | Tipo de conexão vinculado ao login do contrato (5.8; 2.4; Fibra; Cabo; ADSL ou LTE).                                                 | Cadastros > Contrato > aba Logins > editar > campo Tipo de conexão           |
| `#uf_login#`                        | Abreviação do estado que refere-se à cidade do login.                                                                                | Cadastros > Contratos > aba Logins > aba Endereço > F3 Cidade > campo CEP    |

### Variáveis Financeiras
As variáveis de Bolryo são elementos dinâmicos que representam informações específicas do financeiro do cliente. Quando incluídas no [[modelo de contrato do cliente|Modelo de Contrato do Cliente]], estas variáveis são automaticamente substituídas pelos dados reais do financeiro do contrato, durante a geração do documento de contrato.
Confira, a seguir, a variável, o conceito de utilização e onde a informação está armazenada no sistema

| Variável                                 | Conceito                                                                                                | Caminho                                                                                                   |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `#valores_em_aberto_contrato#`           | Soma dos valores de todos os financeiros com status a receber                                           | Cadastros > Contratos > aba Financeiro > coluna Val. aberto                                               |
| `#cobranca_lista_areceber_com_vencidos#` | Soma dos valores de todos os títulos financeiros com status "A Receber" que estão em aberto e vencidos. | Cadastros > Contratos > aba Financeiro >  ID do contas a receber, Valores em aberto e Data de vencimento. |

### Variáveis [[condicao de pagamento|Condição de Pagamento]]
As variáveis de Condição de Pagamento são elementos dinâmicos que representam informações específicas das condições de pagamento do contrato. Quando incluídas no [[modelo de contrato do cliente|Modelo de Contrato do Cliente]], estas variáveis são automaticamente substituídas pelos dados reais atrelados ao contrato, durante a geração do documento de contrato.
Confira, a seguir, a variável, o conceito de utilização e onde a informação está armazenada no sistema

| Variável                        | Conceito                                                                    | Caminho                                                                                            |
| ------------------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `#contrato_condicao_pagamento#` | Descrição da condição de pagamento do tipo de cobrança.                     | Cadastros > Contratos > F3 Tipo cobrança > F3 Condições de pagamento > campo Descrição             |
| `#contrato_numero_de_parcelas#` | Número de parcelas vinculadas às condições de pagamento dentro do contrato. | Cadastros > Contratos > F3 Tipo de cobrança > F3 Condições de pagamento > Campo Número de parcelas |
| `#instalacao_forma_pagamento#`  | Forma de pagamento da taxa de ativação do contrato.                         | Cadastros > Contratos > Aba Taxas ativação > F3 Condição de pagamento > Campo Forma de pagamento   |

### Variáveis de Integrações 
As variáveis de [[integracoes|Integrações]] são elementos dinâmicos que representam informações específicas do contrato ao utilizar plataformas terceiras, como usuários de TV, linhas de telefonia, entre outros. Quando incluídas no [[modelo de contrato do cliente|Modelo de Contrato do Cliente]], estas variáveis são automaticamente substituídas pelos dados reais atrelados ao contrato durante a geração do documento.
Confira, a seguir, a variável, o conceito de utilização e onde a informação está armazenada no sistema

| Variável            | Conceito                                         | Caminho                                                                                                                                  |                                                                                 |                                                                |
| ------------------- | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| `#login_tv#`        | Login do usuário TV                              | Menu Sistema > Cadastros > Contratos > Aba Usuário TV > Campo Login OU Cadastros > TV/SVA > Usuários TV > Campo Login                    |                                                                                 |                                                                |
| `#senha_tv#`        | Senha do usuário TV                              | Menu Sistema > Cadastros > Contratos > Aba Usuário TV > Campo Senha OU Cadastros > TV/SVA > Usuários TV > Campo Senha                    |                                                                                 |                                                                |
| `#grade_logins_tv#` | Lista todos os usuários do contrato              | Menu Sistema > Cadastros > Contratos >Aba Usuário TV                                                                                     |                                                                                 |                                                                |
| `#linha_mvno#`      | Número de telefone vinculado à linha MVNO        | Menu Sistema > Cadastros > Contrato > Aba Linha MVNO > Campo Número do telefone                                                          |                                                                                 |                                                                |
| `#binagem_sip#`     | Número do campo Número de binagem no [[ramal sip | Ramal SIP]]                                                                                                                              | Menu sistema > Plataforma VoIP > Ramal SIP - Clientes > Campo Número de Binagem |                                                                |
| `#grade_voip_did#`  | Em [[integracoes de telefonia fixa - voip        | Integrações de Telefonia Fixa - VoIP]] que utilizam DID e trunk, imprime em uma grade com os DIDs relacionacionados ao ramal no contrato | Menu sistema > Cadastros > Contratos > aba Linha SIP > Aba DID                  |                                                                |
| `#voip_did#`        | Em [[integracoes de telefonia fixa - voip        | Integrações de Telefonia Fixa - VoIP]] que utilizam DID, imprime o valor do DID relacionado ao [[ramal sip                               | Ramal SIP]] no contrato                                                         | Menu sistema > Cadastros > Contratos > aba Linha SIP > Aba DID |

## Funcionalidades Principais
- Inserção de variáveis no corpo do documento e impressão automática dos dados individuais para cada cliente;
- Editor de texto HTML, permitindo ajustar o código-fonte da mensagem, personalizando-a conforme necessário;
- Possui relacionamento direto com a integração de assinatura digital [[ixc assina|IXC Assina]], uma vez que o sistema utiliza o documento de [[modelo de contrato do cliente|Modelo de Contrato do Cliente]] para realizar o envio do link de assinatura digital.

## Fluxo de Trabalho

```mermaid
graph TD
    A[Início] --> B[Abrir Editor de Modelo]
    B --> C[Inserir Texto Base]
    C --> D[Adicionar Variáveis]
    D --> E[Incluir Condicionais]
    E --> F[Testar Geração]
    F --> G{Resultado OK?}
    G -->|Sim| H[Salvar Modelo]
    G -->|Não| I[Ajustar Variáveis/Texto]
    I --> F
    H --> J[Fim]
```

## Considerações Finais
As variáveis de modelo de contrato são ferramentas essenciais para a criação de documentos personalizados. Elas permitem que a empresa mantenha a consistência em seus contratos enquanto adapta as informações específicas para cada cliente, como nome, endereço e condições particulares. Isso é especialmente útil em situações que exigem a geração de múltiplos contratos similares, como em empresas de serviços ou vendas em grande escala.

## Etiquetas
#ModeloDeContrato #VariaveisModeloDeContato #ContratoDoCliente #Contratos #PersonalizacaoDocumentos #Variaveis #Contratos 

## Leia Também
- [[formulario contrato do cliente|Contrato do Cliente]]
- [[modelo de contrato do cliente|Modelo de Contrato do Cliente]]
- [[como cadastrar modelo de contrato|Como Cadastrar Modelo de Contrato]]
- [[cadastro de contratos no sistema|Cadastro de contratos no Sistema]]
- [[integracoes|Integrações]]
- [[ixc assina|IXC Assina]]
- [[como gerar um novo link de assinatura digital -  ixc assina|Como gerar um novo link de assinatura digital -  IXC Assina]]
- [[como reenviar um link de assinatura digital ja gerado - ixc assina|Como reenviar um link de assinatura digital já gerado - IXC Assina]]
- [[formulario planos de venda|Formulário Planos de Venda]]
- [[menu sistema/cadastros/contratos/abas (contrato)/aba - produtos|public/Menu Sistema/Cadastros/Contratos/Abas (Contrato)/Aba - Produtos]]
- [[integracoes de telefonia fixa - voip|Integrações de Telefonia Fixa - VoIP]]
- [[integracoes mvno telefonia movel|Integrações MVNO Telefonia Móvel]]
- [[integracoes de tv|Integrações de TV]]
- [[integracoes de sva|Integrações de SVA]]
- [[aba linha sip - contrato do cliente|Aba Linha SIP - Contrato do Cliente]]
- [[aba linha mvno - contrato do cliente|Aba Linha MVNO - Contrato do Cliente]]
- [[aba sva - contrato do cliente|Aba SVA - Contrato do cliente]]
- [[aba - tv - contrato do cliente|Aba TV - Contrato do cliente]]
- [[public/menu sistema/cadastros/pasta tv sva/login tv/usuarios tv|Usuários TV]]
- [[usuarios sva|Usuários SVA]]