Pular para o conteúdo principal

Entendendo as variáveis de cobrança e seus retornos

Laura Gonçalves
Atualizado

Entendendo as variáveis de cobrança e seus retornos

Consulte as variáveis de cobrança disponíveis nos modelos de contrato e entenda como configurar os retornos financeiros.

💡

O editor possui variáveis simples, inseridas diretamente pelo menu, e variáveis avançadas, configuradas de acordo com o tipo de informação, a parcela e o agrupamento do serviço.

Nesta página

1
Como acessar
›
2
Como criar uma variável avançada
›
3
Variáveis simples de cobrança
›
4
Retornos de desconto
›
5
Retornos de parcela, serviço e título
›
6
Retornos de valor e vencimento
›
1

Como acessar

  1. No menu superior esquerdo, selecione [Administrativo].
  2. Clique em [Configurações].
  3. Abra a seção [Contratos] e selecione [Modelos de contrato].
  4. Localize o modelo desejado, abra o menu de ações e clique em [Editar].
  5. No campo [Conteúdo HTML], use [Variáveis da cobrança] para inserir uma variável simples ou clique em [Variáveis avançadas] para configurar um retorno com parâmetros.

💡

As opções disponíveis podem variar conforme o tipo de texto. Se uma variável não aparecer no editor, ela não está disponível para aquele modelo.

Voltar ao índice
2

Como criar uma variável avançada

Use o assistente para definir exatamente qual informação financeira será inserida no contrato.

  1. No campo [Conteúdo HTML], clique em [Variáveis avançadas].
  2. Selecione [Cobrança] e clique em [Próximo].
  3. Em [Tipo de informação], escolha o retorno que deseja apresentar.
  4. Em [Por extenso], escolha se o resultado será apresentado em números ou escrito por extenso.
  5. Em [Parcela], selecione uma parcela específica ou mantenha [Todas as parcelas].
  6. Em [Agrupamento do serviço], selecione um agrupamento específico ou mantenha [Todos os agrupamentos de serviço].
  7. Clique em [Próximo] e, na última etapa, clique em [Copiar variável].
  8. Feche o assistente e cole a variável no ponto desejado do contrato.
💡

O sistema monta a expressão completa. Por exemplo: [COBRANCA_TURMA('DESCONTO_PERCENTUAL_COND','','')]. Copie o conteúdo gerado sem alterar sua estrutura.

⚠️

Confira o resultado pelo botão [Pré-visualizar contrato] antes de salvar o modelo.

Voltar ao índice
3

Variáveis simples de cobrança

Estas opções são inseridas diretamente pelo menu [Variáveis da cobrança] do editor.

Opções disponíveis no menu
Variável
Informação indicada
NOME_ABATIMENTO
Nome do abatimento relacionado à cobrança.
NOME_DESCONTO
Nome do desconto relacionado à cobrança.
VALOR_OU_PERCENTUAL_DESCONTO
Valor ou percentual configurado para o desconto.
VALOR_OU_PERCENTUAL_DESCONTO_EXTENSO
O mesmo valor ou percentual, escrito por extenso.
NOME_DESCONTO_COM_VALOR_DESCONTO
Nome do desconto acompanhado do respectivo valor.
PERCENTUALTITULO_DESCONTOANUIDADE_TODOSDESC
Percentual de desconto aplicado ao título da anuidade, considerando os descontos.
PERCENTUALTITULO_DESCONTOANUIDADE_TODOSDESC_EXTENSO
O mesmo percentual, escrito por extenso.
NOME_PLANO_PAGAMENTO
Nome do plano de pagamento relacionado à cobrança.
NOME_PLANO_PAGAMENTO_PRE_MATRICULA
Nome do plano de pagamento utilizado na pré-matrícula.
⚠️

O conteúdo retornado depende dos dados existentes na cobrança e da configuração utilizada pela instituição. Faça uma pré-visualização com um contrato que possua dados financeiros para conferir o resultado.

Voltar ao índice
4

Retornos de desconto

Selecione estes retornos no campo [Tipo de informação] das variáveis avançadas.

Retornos de desconto
Tipo de informação (código)
O que retorna
DESCONTO_PERCENTUAL_COND
Valor do percentual do desconto condicional (financeiro) alocado no título, por parcela ou total, conforme os parâmetros.
DESCONTO_PERCENTUAL_COND_EXTENSO
O mesmo valor acima, por extenso.
DESCONTO_PERCENTUAL_NAOCOND
Valor do percentual do desconto incondicional (comercial) alocado no título, por parcela ou total.
DESCONTO_PERCENTUAL_NAOCOND_EXTENSO
O mesmo valor acima, por extenso.
DESCONTO_PERCENTUAL_TODOSDESC
Valor percentual de todos os descontos do título, combinando condicionais e incondicionais, por parcela ou total.
DESCONTO_PERCENTUAL_TODOSDESC_EXTENSO
O mesmo valor acima, por extenso.
DESCONTO_VALOR_COND
Valor em reais do desconto condicional (financeiro) alocado no título, por parcela ou total.
DESCONTO_VALOR_COND_EXTENSO
O mesmo valor acima, por extenso.
DESCONTO_VALOR_NAOCOND
Valor em reais do desconto incondicional (comercial) alocado no título, por parcela ou total.
DESCONTO_VALOR_NAOCOND_EXTENSO
O mesmo valor acima, por extenso.
DESCONTO_VALOR_TODOSDESC
Valor em reais de todos os descontos do título, combinando condicionais e incondicionais, por parcela ou total.
DESCONTO_VALOR_TODOSDESC_EXTENSO
O mesmo valor acima, por extenso.
Voltar ao índice
5

Retornos de parcela, serviço e título

O código é inserido dentro da expressão completa criada pelo assistente.

Retornos de parcela, serviço e título
Tipo de informação (código)
O que retorna
PARCELA_NUMERO
Número da parcela de cobrança atrelada ao título, conforme os parâmetros. Exemplo: 1/12.
PARCELA_QUANTIDADE
Quantidade de parcelas de cobrança (títulos) geradas, conforme os parâmetros. Exemplo: 12.
SERVICO_NOME
Nome do serviço por parcela, conforme os parâmetros. Exemplo: Mensalidade Educação Infantil - Nível IV.
SERVICO_AGRUPAMENTO
Agrupamento vinculado ao cadastro do serviço por parcela, conforme os parâmetros. Exemplo: Educação Infantil.
TITULO_NUMERO
Número do título por parcela, conforme os parâmetros. Exemplo: 206318.
Voltar ao índice
6

Retornos de valor e vencimento

Use os parâmetros do assistente para definir a parcela e o agrupamento considerados no retorno.

Retornos de valor e vencimento
Tipo de informação (código)
O que retorna
VALOR
Valor por parcela ou total, conforme os parâmetros. Exemplo: R$ 1.200,00.
VALOR_EXTENSO
O mesmo valor acima, por extenso. Exemplo: um mil, duzentos reais.
VALOR_MENOSDESCCOND
Valor líquido da parcela ou do total após subtrair o desconto condicional (financeiro). Se não houver desconto condicional, retorna o valor principal do boleto.
VALOR_MENOSDESCCOND_EXTENSO
O mesmo valor acima, por extenso.
VALOR_MENOSDESCNAOCOND
Valor líquido da parcela ou do total após subtrair o desconto incondicional (comercial). Se não houver desconto incondicional, retorna o valor principal do boleto.
VALOR_MENOSDESCNAOCOND_EXTENSO
O mesmo valor acima, por extenso.
VALOR_MENOSTODOSDESC
Valor líquido da parcela ou do total após subtrair todos os descontos do título, condicionais e incondicionais. Se não houver desconto, retorna o valor principal do boleto.
VALOR_MENOSTODOSDESC_EXTENSO
O mesmo valor acima, por extenso.
VENCIMENTO
Vencimento do título por parcela, conforme os parâmetros. Exemplo: 15/08/2025.
VENCIMENTO_DIA
Apenas o dia do vencimento do título por parcela, conforme os parâmetros. Exemplo: 15.
Voltar ao índice

Comentários

0 comentário

Por favor, entre para comentar.