Documentação unificada e completa de variáveis para automação de contratos.
Este documento apresenta as tags disponibilizadas pelo CRM para utilização na geração automática de contratos através do SwiftDocs.
As tags permitem que informações cadastradas ou calculadas automaticamente pelo CRM sejam inseridas no contrato sem a necessidade de preenchimento manual.
As informações disponibilizadas podem ser provenientes do cadastro do cliente, endereço, plano, serviços, condições comerciais, descontos, regras de adesão e dados cadastrados no ERP.
| Tag | Descrição | Retorno CRM | Observação |
|---|---|---|---|
cliente_id | Identificador interno do cliente. | Retorna o ID do cliente relacionado ao contrato. | Pode ser utilizado para identificação e rastreabilidade entre sistemas. |
contrato_id | Identificador interno do contrato. | Retorna o ID do contrato gerado no CRM. | Pode ser utilizado para rastreabilidade e integrações. |
cpf | CPF do cliente. | Retorna o CPF cadastrado para o cliente. | Utilizado principalmente em contratos de Pessoa Física. |
cnpj | CNPJ da empresa contratante. | Retorna o CNPJ da empresa vinculada ao contrato. | Utilizado em contratos de Pessoa Jurídica. |
nome | Nome completo do cliente. | Retorna o nome cadastrado no CRM. | Pode representar o cliente ou responsável pela contratação, conforme o cadastro utilizado. |
razao_social | Razão social da empresa. | Retorna a razão social da empresa vinculada ao contrato. | Utilizado em contratos de Pessoa Jurídica. |
| Tag | Descrição | Retorno CRM | Observação |
|---|---|---|---|
email | E-mail do cliente. | Retorna o e-mail cadastrado para o cliente. | Pode ser utilizado para identificação e comunicação contratual. |
celular | Número de celular do cliente. | Retorna o celular cadastrado no CRM. | Atualmente utilizado no CRM. |
telefone | Número de telefone do cliente. | Retorna o telefone cadastrado no CRM ou vazio quando não informado. | Atualmente pode não estar preenchido para alguns clientes. |
rg | RG do cliente. | Retorna o RG cadastrado ou vazio quando não informado. | Atualmente pode não estar preenchido para alguns clientes. |
| Tag | Descrição | Retorno CRM | Observação |
|---|---|---|---|
data_nascimento | Data de nascimento do cliente. | Retorna a data de nascimento no formato DD/MM/AAAA. | Informação proveniente do cadastro do cliente. |
data_contratacao | Data de criação do contrato. | Retorna a data de criação do contrato no formato DD/MM/AAAA. | Representa a data da contratação, não a data de nascimento. |
| Tag | Descrição | Retorno CRM | Observação |
|---|---|---|---|
cep | CEP do endereço de contratação. | Retorna o CEP cadastrado no contrato. | Utilizado para identificação do endereço. |
rua | Rua do endereço. | Retorna a rua cadastrada no contrato. | — |
numero | Número do endereço. | Retorna o número cadastrado no contrato. | — |
complemento | Complemento do endereço. | Retorna o complemento cadastrado ou vazio quando não informado. | Campo opcional. |
bairro | Bairro do endereço. | Retorna o bairro cadastrado no contrato. | — |
cidade | Cidade do endereço. | Retorna a cidade cadastrada no contrato. | Também pode ser utilizada em regras de cálculo da adesão. |
estado | Estado do endereço. | Retorna o estado cadastrado no contrato. | — |
rua_numero | Rua e número do endereço. | Combina automaticamente a rua e o número do contrato. | Exemplo: Rua Exemplo 123. |
endereco | Endereço completo do cliente. | Combina rua, número, complemento, bairro e cidade. | O complemento somente é incluído quando estiver preenchido. |
cidade_estado_data | Cidade, estado e data atual. | Combina a cidade e o estado do contrato com a data atual por extenso. | Pode ser utilizada no fechamento do contrato. |
| Tag | Descrição | Retorno CRM | Observação |
|---|---|---|---|
dia_vencimento | Dia de vencimento das cobranças. | Retorna o dia configurado no modelo de pagamento associado ao contrato. | O valor é obtido a partir da configuração do modelo de pagamento. |
forma_pagamento | Forma de pagamento escolhida. | Retorna o nome da forma de pagamento associada ao contrato. | Pode retornar vazio quando não houver uma forma configurada. |
As tags desta seção são preenchidas a partir das informações do plano selecionado na contratação.
| Tag | Descrição | Retorno CRM | Observação |
|---|---|---|---|
plano_nome | Nome do plano contratado. | Retorna o nome do plano selecionado. | — |
plano_sla | SLA do plano. | Retorna o SLA configurado no cadastro do plano. | Pode ser utilizado para apresentar as condições de atendimento no contrato. |
plano_mttr | MTTR do plano. | Retorna o MTTR configurado no cadastro do plano. | Pode ser utilizado para apresentar o tempo médio de reparo/restabelecimento. |
plano_tecnologia_instalacao | Tecnologia utilizada na instalação. | Retorna a tecnologia de instalação configurada no plano. | Informação proveniente do cadastro do plano. |
plano_velocidade_upload | Velocidade de upload do plano. | Retorna a velocidade de upload cadastrada no plano. | — |
plano_velocidade_download | Velocidade de download do plano. | Retorna a velocidade de download cadastrada no plano. | — |
plano_dual_band | Indica se o plano possui tecnologia dual band. | Retorna Sim ou Não conforme a configuração do plano. | Retorno textual para facilitar a utilização no contrato. |
plano_instalacao_predio | Indica se o plano possui instalação em prédio. | Retorna Sim ou Não conforme a configuração do plano. | Retorno textual. |
| Tag | Descrição | Retorno CRM | Observação |
|---|---|---|---|
servicos_nome | Nome dos serviços contratados. | Retorna a relação dos serviços selecionados na contratação. | Pode ser utilizada para apresentar os serviços adicionais no contrato. |
quantidade_servicos | Quantidade de serviços contratados. | Retorna a quantidade de serviços associados à contratação. | Retorna um número. |
O CRM também disponibiliza as informações dos serviços cadastrados no plano no ERP de forma dinâmica.
As tags seguem o seguinte padrão:
servico_erp_nome_0 servico_erp_descricao_0 servico_erp_valor_0
Para o segundo serviço:
servico_erp_nome_1 servico_erp_descricao_1 servico_erp_valor_1
E assim sucessivamente.
| Tag | Descrição | Retorno CRM | Observação |
|---|---|---|---|
servico_erp_nome_N | Nome do serviço cadastrado no ERP. | Retorna o nome do serviço correspondente à posição N da lista de serviços do plano. | A numeração começa em 0. |
servico_erp_descricao_N | Descrição do serviço cadastrado no ERP. | Retorna a descrição do serviço correspondente à posição N. | Permite apresentar informações detalhadas sobre o serviço. |
servico_erp_valor_N | Valor do serviço cadastrado no ERP. | Retorna o valor do serviço correspondente à posição N. | Permite apresentar individualmente o valor de cada serviço. |
Caso o plano possua três serviços, poderão ser utilizadas as seguintes tags:
servico_erp_nome_0 servico_erp_descricao_0 servico_erp_valor_0servico_erp_nome_1
servico_erp_descricao_1
servico_erp_valor_1servico_erp_nome_2
servico_erp_descricao_2
servico_erp_valor_2
A quantidade de grupos disponíveis depende da quantidade de serviços cadastrados no plano no ERP.
| Tag | Descrição | Retorno CRM | Observação |
|---|---|---|---|
observacao | Observações relacionadas à contratação. | Retorna as observações geradas durante o processo de contratação. | Pode ser utilizada para registrar condições ou informações adicionais. |
descontos | Descontos aplicados à contratação. | Retorna a relação dos descontos aplicados na negociação. | Diferente de valor_mensalidade_descontos, que representa o valor financeiro dos descontos. |
quantidade_descontos | Quantidade de descontos aplicados. | Retorna a quantidade de descontos existentes na contratação. | Retorna um número. |
| Tag | Descrição | Retorno CRM | Observação |
|---|---|---|---|
valor_instalacao | Valor da instalação. | Retorna o valor de instalação configurado na contratação. | Quando não houver valor, retorna R$ 0,00. |
valor_ativacao | Valor de ativação. | Retorna R$ 0,00. | Atualmente o código não atribui uma cobrança específica de ativação. |
valor_ativacao_adesao | Valor de ativação relacionado à adesão. | Retorna R$ 0,00. | Atualmente não possui valor próprio no código apresentado. |
valor_ativacao_servicos | Valor de ativação dos serviços. | Retorna R$ 0,00. | Atualmente não possui valor próprio no código apresentado. |
valor_ativacao_descontos | Descontos sobre valores de ativação. | Retorna R$ 0,00. | Atualmente não possui valor próprio no código apresentado. |
valor_ativacao_total | Valor total de adesão disponibilizado na estrutura de ativação. | Retorna o valor calculado para a adesão. | Apesar do nome da tag, o valor atualmente retornado corresponde ao valor de adesão calculado pelo CRM. |
| Tag | Descrição | Retorno CRM | Observação |
|---|---|---|---|
valor_mensalidade_plano | Valor mensal do plano. | Retorna o valor do plano formatado em reais. | Representa o valor do plano antes da composição com serviços e descontos. |
valor_mensalidade_servicos | Valor mensal dos serviços. | Retorna a soma dos valores dos serviços contratados. | — |
valor_mensalidade_descontos | Valor total dos descontos mensais. | Retorna a soma dos descontos aplicados à mensalidade. | Valor apresentado em reais. |
valor_mensalidade_adesao | Valor da adesão aplicado à contratação. | Retorna o valor de adesão calculado pelo CRM. | Representa o valor de adesão considerado na contratação. |
valor_mensalidade_adesao_sem_desconto | Valor da adesão antes da aplicação de descontos. | Retorna o valor original da adesão. | Permite demonstrar o valor original e o valor efetivamente aplicado. |
valor_mensalidade | Valor mensal após descontos. | Calcula o valor do plano somado aos serviços e subtraído dos descontos. | O resultado não pode ser inferior a R$ 0,00. |
mensalidade_total | Valor total da mensalidade. | Retorna o valor total calculado pelo CRM. | Indicada para apresentar o valor mensal total da contratação. |
valor_plano | Valor do plano. | Retorna o valor do plano formatado em reais. | Representa o valor base do plano. |
| Tag | Descrição | Retorno CRM | Observação |
|---|---|---|---|
valor_primeira_fatura | Valor previsto para a primeira fatura. | Soma o valor mensal líquido com o valor da adesão. | Permite apresentar o valor inicial estimado da contratação. |
A composição segue a lógica:
Valor da primeira fatura = Valor mensal líquido + Valor da adesão
O valor mensal líquido é composto por:
Plano + Serviços - Descontos
O CRM possui diferentes regras que podem influenciar o valor da adesão.
As regras são identificadas internamente e disponibilizadas por meio das respectivas tags SwiftDocs.
| Tag | Critério | Retorno CRM | Observação |
|---|---|---|---|
valor_adesao_score | Score do cliente | Retorna o valor de adesão calculado conforme a regra de avaliação do score. | Utilizado quando houver regra de adesão baseada em score. |
valor_adesao_chance_pagamento | Chance de pagamento | Retorna o valor de adesão calculado conforme a chance de pagamento do cliente. | Utilizado quando houver regra baseada na chance de pagamento. |
valor_adesao_score_chance_pagamento | Score e chance de pagamento | Retorna o valor de adesão calculado considerando score e chance de pagamento. | Regra combinada de score e chance de pagamento. |
valor_adesao_regiao | Região/sub-região | Retorna o valor de adesão calculado conforme a região de contratação. | Pode considerar a região ou sub-região associada ao endereço. |
valor_adesao_ocorrencias | Ocorrências do score | Retorna o valor de adesão calculado conforme as ocorrências identificadas no score. | Utilizado em regras relacionadas a restrições/ocorrências do score. |
valor_adesao_observacoes_adicionais | Observações adicionais | Retorna o valor de adesão calculado conforme as observações consideradas pela regra. | Utilizado quando houver regra baseada em observações. |
valor_adesao_cidade | Cidade de contratação | Retorna o valor de adesão calculado conforme a cidade de contratação. | Pode considerar regras específicas para determinadas cidades. |
valor_adesao_vendedor | Vendedor | Retorna o valor de adesão calculado conforme a taxa/regra associada ao vendedor responsável pela venda. | Pode variar conforme o vendedor. |
valor_adesao_tipo_vendedor | Tipo de vendedor | Retorna o valor de adesão calculado conforme o tipo do vendedor responsável pela venda. | Permite regras diferentes para diferentes tipos de vendedores. |
valor_adesao_idade | Idade do cliente | Retorna o valor de adesão calculado conforme a idade do cliente. | Pode considerar faixas etárias. |
valor_adesao_debito_endereco | Débitos relacionados ao endereço | Retorna o valor de adesão calculado conforme a regra relacionada aos débitos do endereço de contratação. | Pode considerar o histórico de débitos associado ao endereço. |
valor_adesao_segmento | Débitos por segmento | Retorna o valor de adesão calculado conforme débitos ou ocorrências identificados para o CPF em diferentes segmentos. | Permite considerar informações de diferentes segmentos na composição da adesão. |
valor_adesao_plano | Plano contratado | Retorna o valor de adesão calculado conforme o plano selecionado. | Permite estabelecer valores diferentes de adesão por plano. |
valor_adesao_servicos | Serviços contratados | Retorna o valor de adesão calculado conforme os serviços selecionados. | Permite estabelecer valores diferentes conforme os serviços contratados. |
As tags de portabilidade podem ser utilizadas em contratos que contemplem esse processo.
| Tag | Descrição | Retorno CRM | Observação |
|---|---|---|---|
operadora | Operadora de origem da portabilidade. | Retorna o nome da operadora relacionada à portabilidade. | Utilizada em contratos com portabilidade. |
numero_portabilidade | Número que será portado. | Retorna o número de telefone ou celular relacionado à portabilidade. | Utilizada em contratos com portabilidade. |
produto_nome | Produto relacionado à portabilidade. | Retorna o nome do plano ou serviço relacionado à portabilidade. | Utilizada em contratos com portabilidade. |
produto_preco | Preço do produto relacionado à portabilidade. | Retorna o preço do plano ou serviço relacionado à portabilidade. | Utilizada em contratos com portabilidade. |
Para facilitar a utilização das tags em contratos, a seguinte estrutura pode ser considerada:
| Tag | Representação |
|---|---|
valor_plano | Valor base do plano |
valor_mensalidade_plano | Valor mensal do plano |
valor_mensalidade_servicos | Soma dos serviços |
valor_mensalidade_descontos | Soma dos descontos |
valor_mensalidade | Plano + serviços - descontos |
valor_mensalidade_adesao_sem_desconto | Valor original da adesão |
valor_mensalidade_adesao | Valor de adesão aplicado |
mensalidade_total | Total mensal da contratação |
valor_primeira_fatura | Mensalidade líquida + adesão |
valor_instalacao | Valor de instalação |
valor_ativacao_total | Valor de adesão disponibilizado na estrutura de ativação |
As tags disponibilizadas pelo CRM podem ser divididas em duas categorias.
São tags que possuem um nome previamente definido e que podem ser inseridas diretamente no modelo do contrato.
Exemplos:
nome cpf cnpj razao_social plano_nome valor_mensalidade mensalidade_total cidade endereco
As tags de serviços provenientes do ERP são geradas conforme a quantidade de serviços existentes no plano.
O padrão utilizado é:
servico_erp_nome_N servico_erp_descricao_N servico_erp_valor_N
Onde N representa a posição do serviço na lista, iniciando em 0.
Por exemplo:
servico_erp_nome_0 servico_erp_descricao_0 servico_erp_valor_0servico_erp_nome_1
servico_erp_descricao_1
servico_erp_valor_1
Essa estrutura permite que o contrato apresente os serviços individualmente sem a necessidade de criar uma tag específica para cada serviço existente no ERP.
Algumas tags podem retornar vazias quando a informação correspondente não estiver cadastrada no CRM.
Entre elas estão:
telefonergcomplementoforma_pagamentoobservacaoO modelo do contrato deve considerar esse comportamento para evitar que informações desnecessárias sejam apresentadas quando não houver dados disponíveis.
Os valores financeiros disponibilizados pelas tags são formatados em reais (R$) e utilizam duas casas decimais.
Exemplo:
R$ 99,90
As tags valor_adesao_* representam diferentes critérios que podem influenciar a composição do valor de adesão.
Não é recomendado assumir no modelo do contrato que todas essas tags serão preenchidas simultaneamente. A disponibilidade e o valor retornado dependem das regras aplicáveis à contratação.
As tags servico_erp_* são vinculadas aos serviços cadastrados no plano no ERP e possuem numeração dinâmica.
A quantidade de tags disponíveis dependerá da quantidade de serviços associados ao plano.
Um contrato pode utilizar as tags diretamente em seu conteúdo:
PLANO CONTRATADO: {plano_nome}
Velocidade de Download: {plano_velocidade_download}
Velocidade de Upload:
Mensalidade do Plano: {valor_mensalidade_plano}
Serviços Contratados: {servicos_nome}
Descontos Aplicados:
VALOR MENSAL:
VALOR DA ADESÃO:
VALOR DA PRIMEIRA FATURA: {valor_primeira_fatura}
As tags devem ser inseridas no documento utilizando a sintaxe e o padrão de identificação aceitos pelo SwiftDocs.
O CRM disponibiliza informações para geração automática dos contratos em diferentes níveis:
Dessa forma, o modelo de contrato no SwiftDocs pode ser estruturado para que as informações comerciais e cadastrais sejam preenchidas automaticamente pelo CRM, reduzindo a necessidade de preenchimento manual e garantindo maior padronização na geração dos contratos.
Gestão sem Fronteiras