Dicionário de Variáveis DocSales

Neste artigo, abordaremos o Dicionário de Variáveis no DocSales. Compreender esse dicionário é fundamental para otimizar o uso do sistema, oferecendo informações cruciais aos usuários.

O artigo fornecerá orientações detalhadas sobre o Dicionário de Variáveis. Essas variáveis são essenciais para personalizar modelos de documentos e e-mails. Elas permitem acessar informações específicas que podem ser inseridas nos modelos, tornando-os mais dinâmicos e adaptáveis às necessidades de cada interação.

Ao consultar e entender as variáveis disponíveis no Dicionário, os usuários poderão criar modelos mais personalizados e eficientes, agregando valor aos documentos e e-mails enviados através do DocSales.

Variáveis do Documento:

Código/Número do Documento {{code}}

Status do Documento {{status}}

Data de Criação {{formatted_created_at}}

Atualizado Em {{updated_at}}

Data de Validade do Documento{{formatted_expiration_date}}

Início de Vigência {{contract_start}}

Meses de Vigência {{contract_months}}

Fim de Vigência {{contract_end}}

Observações {{notes}}

Variáveis de Cliente Empresa:

Razão Social {{customer.name}}

Código {{customer.code}}

Nome Fantasia {{customer.alias}}

CNPJ/CPF {{customer.legal_code}}

Endereço {{customer.address}}

Número da localidade {{customer.number}}

Complemento do endereço {{customer.complement}}

Bairro {{customer.district}}

Cidade {{customer.city}}

Estado {{customer.state}}

CEP {{customer.postal_code}}

Telefone 1 {{customer.phone1}}

Telefone 2 {{customer.phone2}}

WhatsApp do Cliente {{customer.whatsapp_number}}

Representante {{customer.contact_name}}

Função/Cargo {{customer.contact_role}}

Email do Representante {{customer.contact_email}}

Inscrição Estadual {{customer.legal_code2}}

Tipo de Cliente {{customer.customer_type}}

Variáveis de Cliente Pessoa Física:

Nome {{customer.name}}

Email {{customer.contact_email}}

Profissão {{customer.profession}}

CPF {{customer.legal_code}}

RG {{customer.legal_code2}}

Estado Civil {{customer.civil_status}}

Gênero {{customer.gender}}

Nacionalidade {{customer.nationality}}

Endereço {{customer.address}}

Número da localidade {{customer.number}}

Complemento do endereço {{customer.complement}}

Bairro {{customer.district}}

Cidade {{customer.city}}

Estado {{customer.state}}

CEP {{customer.postal_code}}

Variáveis de Serviço ou Produto:

Código do Serviço {{service.code}}

Nome do Serviço {{service.name}}

Descrição do Serviço {{service.description}}

Quantidade {{service.quantity | round:0}}

Valor Unitário {{service.raw_value | number_to_currency}}

Valor Total {{service.raw_total | number_to_currency}}

Periodicidade do Serviço {{service._periodicity}}

Observação do Serviço {{service.obs}}

Tipo de Desconto (R$ ou %) {{service.adjustment_type}}

Valor do Desconto do Serviço {{service.adjustment_value}}

Quantidade de Serviços no Documento {{services.size}}

Variáveis de Valores:

Valor Total do Documento {{raw_value | number_to_currency}}

Valor Mensal {{raw_mrr_value | number_to_currency}}

Variáveis de Formas de Pagamento:

Data Primeiro Pagamento {{first_payment_at}}

Quantidade de Parcelas {{parcels_count}}

Dia do Vencimento {{due_day}}

Valor Total da Proposta {{value}}

Ciclo de Faturamento {{billing_cycle.name}}

Data de Vencimento Cadastrada no Ciclo {{billing_cycle.expiration_day}}

Periodicidade de Pagamento {{periodicity.name}}

Nome do Meio de Pagamento {{payment_method.name}}

Variáveis do Representante Legal:

{{procurator.name}}

{{procurator.document_number}}

{{procurator.legal_code2}}

{{procurator.email}}

{{procurator.role}}

{{procurator.phone}}

Variáveis da Conta (Empresa Usuária DocSales):

Nome da Conta {{account.name}}

Documento {{account.document_number}}

Endereço {{account.address1}}

Endereço {{account.address2}}

CEP {{account.postal_code}}

Cidade {{account.city}}

Estado {{account.state}}

Variáveis do Usuário do DocSales:

Nome do usuário {{user.name}}

E-mail do usuário {{user.email}}

Telefone do usuário {{user.phone_number}}

WhatsApp {{user.whatsapp_number}}

Variáveis de Assinatura:

Mostra todas as assinaturas {% signatures %}

Mostra o número mencionado {% signature 1 %}:

Quando tem mais do que um signatário, adicione o número necessário. Por exemplo, se tiver 2 signatários, pode colocar {% signature 1 %} e {% signature 2 %}. Quando tem 3 signatários: {% signature 1%}, {% signature 2%}, {% signature 3 %} e assim sucessivamente.

Exemplo de cláusula de qualificação das partes (Cliente Contratante):

{{customer.name}}, inscrita no CNPJ sob o nº {{customer.legal_code}} sediada na cidade de {{customer.city}}, Estado de {{customer.state}}, na {{customer.address}}, {{customer.number}}, {{customer.complement}}, CEP {{customer.postal_code}}.

Texto completo de endereço:

{{customer.address}}, {{customer.number}} {{customer.complement}}, {{customer.district}}

– {{customer.city}}/{{customer.state}}, CEP {{customer.postal_code}}.

Texto para o final do documento:

E que, estando de acordo com as cláusulas e condições expressas neste documento e no EULA, concorda e firma este documento de forma eletrônica, conforme regulamentado pela LEI No. 14.063, DE 23 SETEMBRO DE 2020.

Se você é um usuário avançado e quer saber mais sobre controle de fluxo, iteração e funções disponíveis no modelos de documentos acesse: https://shopify.github.io/liquid/

Veja como criar e editar seus modelos de documentos DocSales clicando aqui.

Para dúvidas adicionais, entre em contato com o nosso time de suporte clicando no ícone de ajuda no canto inferior esquerdo ou enviando e-mail para [email protected]