Variáveis do contrato e do contrato principal
Utilize templates de documento e variáveis de sua escolha para criar um contrato com as informações necessárias, como:
- Código ou tipo de contrato,
- Valor total do contrato,
- Data em que o contrato foi aprovado.
As variáveis disponíveis para o fornecimento de informações do contrato são divididas em tabelas nas seguintes seções:
- Variáveis do contrato - a seleção de variáveis que podem ser usadas para criar um contrato personalizado, pronto para ser enviado para subempreiteiros. Para saber mais sobre contratos, consulte o artigo Trabalhar com contratos.
- Variáveis de contrato para pedidos de alteração - a seleção de variáveis que podem ser usadas na geração de pedidos de alteração a jusante. Consulte o artigo Pedidos de alteração para saber mais.
- Variáveis do contrato principal - a seleção de variáveis que podem ser usadas para criar um contrato principal personalizado, pronto para ser enviado a um proprietário. Para saber mais sobre como trabalhar com os contratos principais, consulte o artigo Contrato principal.
- Principais variáveis de contrato para pedidos de alteração - a seleção de variáveis que podem ser usadas na geração de pedidos de alteração upstream.
Variáveis do contrato
Utilize as variáveis da tabela para criar um template para um contrato. Use a pesquisa na parte superior das tabelas para restringir os resultados exibidos.
| Variáveis | Descrição |
| {contract.name} | Retorna o nome do contrato |
| {contract.description} | Retorna a descrição do contrato |
| {contract.code} | Retorna o código de contrato |
| {contract.type} | Retorna o tipo de contrato |
| {contract.note} | Retorna as notas sobre o contrato |
| {contract.awarded} Por exemplo: {contract.awarded | written} |
Retorna o valor da concessão do contrato. Você pode adicionar a moeda na qual deseja que o contrato seja concedido. Por exemplo, {contract.awarded | writtenCurrency:'USD'}. |
| {contract.changes} | Retorna o valor das alterações do contrato |
| {contract.retention} | Retorna a retenção do contrato |
| {contract.completedWorkRetentionPercent || contract.retention.completedWorkRetentionPercent} | Retorna o percentual de retenção do trabalho total concluído |
| {contract.materialsRetentionPercent || contract.retention.materialsRetentionPercent} | Retorna o percentual de retenção de materiais no local |
| {contract.total} | Retorna o valor total do contrato |
| {#contract.exhibits} e {/contract.exhibits} | Retornam o nome e o nome de destino do arquivo de origem da exibição do contrato mainContract.exhibits e /mainContract.exhibits devem ser usados juntos Todas as variáveis de exibição do contrato principal existentes entre #mainContract.exhibits e /mainContract.exhibits são retornadas Para saber mais sobre a sintaxe dessa variável, consulte a ajuda de mustache.github.io sobre as seções Dica: Adicione um caractere de retorno depois das variáveis usadas entre #contract.exhibits e /contract.exhibitspara exibi-las em linhas separadas |
| {#contract.exhibits.name} Por exemplo: {#contract.exhibits}{name} {/contract.exhibits} |
Retorna o nome e a extensão do arquivo de origem da exibição do contrato |
| {#contract.exhibits.targetName} Por exemplo: {#contract.exhibits}{targetName} {/contract.exhibits} |
Retorna o novo nome da exibição do contrato no pacote gerado |
| {contract.originalBudget} | Retorna o orçamento do valor original do contrato |
| {contract.internalAdjustment} | Retorna o valor ajustado do contrato |
| {contract.approvedOwnerChanges} | Retorna o valor das alterações do proprietário aprovadas |
| {contract.revised} | Retorna o valor do contrato revisado |
| {contract.pendingOwnerChanges} | Retorna o valor das alterações do proprietário pendentes |
| {contract.projectedBudget} | Retorna o valor do orçamento do contrato projetado |
| {contract.approvedChangeOrders} | Retorna o valor dos pedidos de alteração aprovados do contrato |
| {contract.pendingChangeOrders} | Retorna o valor dos pedidos de alteração pendentes do contrato |
| {contract.projectedCost} | Retorna o valor de custo do contrato projetado |
| {(contract.awarded | toNumber) + (contract.approvedChangeOrders | toNumber)} | Retorna o valor do total do contrato |
| {contract.reserves} | Retorna o valor das reservas do contrato |
| {contract.forecastFinalCost} | Retorna o valor do custo final estimado do contrato |
| {contract.awardedAt | date:'MM DD, YYYY'} | Retorna a data em que o contrato foi concedido |
| {contract.StatusChangedAt | date:'MM DD, YYYY'} | Retorna a data em que o status do contrato foi alterado pela última vez |
| {contract.sentAt | date:'MM DD, YYYY'} | Retorna a data em que o contrato foi enviado |
| {contract.responseDue | date:'MM DD, YYYY'} | Retorna a data em que o contrato foi respondido |
| {contract.onsiteAt | date:'MM DD, YYYY'} | Retorna a data em que o contrato estava no local |
| {contract.procuredAt | date:'MM DD, YYYY'} | Retorna a data em que o contrato foi obtido |
| {contract.approvedAt | date:'MM DD, YYYY'} | Retorna a data em que o contrato foi aprovado |
| {contract.executedAt | date:'MM DD, YYYY'} | Retorna a data em que o contrato foi executado |
| {contract.returnedAt | date:'MM DD, YYYY'} | Retorna a data em que o contrato foi devolvido |
| {contract.varianceTotal} | Retorna o valor da variância do contrato |
| {contract.retentionCap} | Retorna a porcentagem da soma de compromissos do contrato até a data atual |
| {@contract.scopeOfWork} | Retorna o escopo de trabalho do contrato. A linha em que esta variável está não pode conter nenhum outro texto. |
| {contract.properties["Anexo N"] || "N/D"} ou {contract.properties["Attachment N"] | bool: "Yes":"No":"N/A"} |
Retorna o valor do Anexo N ou retorna "N/D" se o Anexo N estiver em branco |
| {#scheduleOfValues} e {/scheduleOfValues} | Retorna todos os itens de linha da tabela de valores de um contrato #scheduleOfValues e /scheduleOfValues devem ser usados juntos Qualquer tabela de variáveis de valores que exista entre #scheduleOfValues e /scheduleOfValues são retornadas Para saber mais sobre a sintaxe dessa variável, consulte a ajuda de mustache.github.io sobre as seções |
| {#scheduleOfValues.code} Por exemplo: {#scheduleOfValues}{code}{/scheduleOfValues} |
Retorna o código de contrato contido na tabela de valores |
| {#scheduleOfValues.name} Por exemplo: {#scheduleOfValues}{name}{/scheduleOfValues} |
Retorna o nome de contrato contido na tabela de valores |
| {#scheduleOfValues.quantity} Por exemplo: {#scheduleOfValues}{quantity}{/scheduleOfValues} |
Retorna a quantidade contida na tabela de valores |
| {#scheduleOfValues.unit} Por exemplo: {#scheduleOfValues}{unit}{/scheduleOfValues} |
Retorna a unidade contida na tabela de valores |
| {#scheduleOfValues.unitPrice} Por exemplo: {#scheduleOfValues}{unitPrice}{/scheduleOfValues} |
Retorna o preço unitário contido na tabela de valores |
| {#scheduleOfValues.amount} Por exemplo: {#scheduleOfValues}{amount}{/scheduleOfValues} |
Retorna o valor total contido na tabela de valores |
| {#scheduleOfValues.bulkUnitPrice} Por exemplo: {#scheduleOfValues}{bulkUnitPrice}{/scheduleOfValues} |
Somente variável de contrato. Retorna o preço unitário em lote contido na tabela de valores. |
| {#scheduleOfValues.quantityPerBulk} Por exemplo: {#scheduleOfValues}{quantityPerBulk}{/scheduleOfValues} |
Somente variável de contrato. Retorna a quantidade de exibição contida na tabela de valores. |
| {#amount > 0.0} {amount} {/} {#amount == 0.0} Incluído {/} | Retorna "Incluído" para qualquer Valor deixado como 0. |
| {#unitPrice > 0.0} {unitPrice} {/} {#unitPrice == 0.0} Incluído {/} | Retorna "Incluído" para qualquer valor de Preço unitário deixado como 0. |
Observação: Também é possível usar Variáveis do contrato principal em templates de documentos de contrato; basta inserir o prefixo
contract.. Por exemplo, contract.mainContract.plannedCompletionDate gerará a data em que o contrato principal está planejado para ser concluído.Variáveis de contrato para pedidos de alteração
Use a seleção de variáveis de contrato para gerar documentos ao criar pedidos de alteração downstream. Use a pesquisa na parte superior da tabela para restringir os resultados exibidos.
| Variáveis | Descrição | PCO | RFQ | RCO | OCO | SCO |
| {contractOriginal} | [E], compromisso original do contrato relacionado |  |
 |
|
|
|
| {previousContractApproved} | [F], todos os SCOs aprovados do contrato relacionado criados antes do SCO atual durante a geração de documento do SCO | |
|
|
|
|
| {previousContractPending} | Todos os SCOs não aprovados do contrato relacionado criados antes do SCO atual durante a geração de documento do SCO | |
|
|
|
|
| {previousContractAmount} | [G], em que [G] = [E] + [F] | |
|
|
|
|
| {revisedContractAmount} | [H], em que [H] = [G] + soma dos valores aprovados do item de custo neste OCO, incluindo revisões | |
|
|
|
|
| {generalContractAmount} | Retorna o preço líquido original do contrato. | |
|
|
|
|
| {generalContractTaxAmount} | Retorna o total de impostos do contrato original. | |
|
|
|
|
| {generalContractGrandAmount} | Retorna o preço bruto original do contrato, incluindo impostos. | |
|
|
|
|
| {previousGeneralContractAmount} | Retorna o preço líquido revisado do contrato, incluindo OCOs aprovados. | |
|
|
|
|
| {previousGeneralContractTaxTotalAmount} | Retorna o total de impostos do contrato revisado, incluindo OCOs aprovados. | |
|
|
|
|
| {previousGeneralContractGrandTotalAmount} | Retorna o preço bruto revisado do contrato, incluindo impostos e OCOs aprovados. | |
|
|
|
|
Variáveis do contrato principal
Utilize a seleção de variáveis para criar um modelo para um contrato principal. Use a pesquisa na parte superior da tabela para restringir os resultados exibidos.
| Variáveis | Descrição | Tipo |
| {mainContract.code} | Retorna o código do contrato principal | Sequência de caracteres |
| {mainContract.description} | Retorna a descrição do contrato principal | Sequência de caracteres |
| {mainContract.name} | Retorna o nome do contrato principal | Sequência de caracteres |
| {mainContract.status} | Retorna o status do contrato principal | Sequência de caracteres |
| {mainContract.amount} | Retorna o valor do contrato principal | Número |
| {mainContract.paymentDue | date:'MM DD, YYYY'} | Retorna a data de vencimento do contrato principal | Data |
| {mainContract.type} | Retorna o tipo do contrato principal | Sequência de caracteres |
| {@mainContract.note} | Retorna a nota do contrato principal | RichText |
| {mainContract.createdAt | date:'MM DD, YYYY'} | Retorna a data de criação do contrato principal | Data |
| {@mainContract.scopeOfWork} | Retorna o escopo de trabalho do contrato principal. A linha em que esta variável está não pode conter nenhum outro texto. | RichText |
| {#scheduleOfValues} e {/scheduleOfValues} | Retorna a lista de scheduleOfValues do contrato principal | Matriz |
| {#scheduleOfValues.code} Por exemplo: {#scheduleOfValues}{code}{/scheduleOfValues} |
Retorna o código do contrato principal contido na tabela de valores | Sequência de caracteres |
| {#scheduleOfValues.quantity} Por exemplo: {#scheduleOfValues}{quantity}{/scheduleOfValues} |
Retorna a quantidade contida na tabela de valores | Número |
| {#scheduleOfValues.unit} Por exemplo: {#scheduleOfValues}{unit}{/scheduleOfValues} |
Retorna a unidade contida na tabela de valores | Sequência de caracteres |
| {#scheduleOfValues.unitPrice} Por exemplo: {#scheduleOfValues}{unitPrice}{/scheduleOfValues} |
Retorna o preço unitário contido na tabela de valores | Número |
| {#scheduleOfValues.amount} Por exemplo: {#scheduleOfValues}{amount}{/scheduleOfValues} |
Retorna o valor total contido na tabela de valores | Número |
| {mainContract.executedDate | date:'MM DD, YYYY'} | Retorna a data em que o contrato principal foi executado | Data |
| {mainContract.startDate | date:'MM DD, YYYY'} | Retorna a data em que o contrato principal foi iniciado | Data |
| {mainContract.plannedCompletionDate | date:'MM DD, YYYY'} | Retorna a data em que o contrato principal deve ser concluído | Data |
| {mainContract.actualCompletionDate | date:'MM DD, YYYY'} | Retorna a data em que o contrato principal foi realmente concluído | Data |
| {contract.mainContract.createdAt | date:'MM DD, YYYY'} | Retorna a data em que o contrato principal foi criado | Data |
| {mainContract.closeDate | date:'MM DD, YYYY'} | Retorna a data em que o contrato principal foi fechado | Data |
| {mainContract.plannedCompletionDate} | Retorna a data de conclusão planejada | Data |
| {mainContract.revisedCompletionDate} | Retorna a data de conclusão revisada | Data |
| {mainContract.scheduleChange} | Retorna a alteração no cronograma | Número |
| {oco.proposedRevisedCompletionDate} | Retorna a data de conclusão proposta ou revisada | Data |
| {mainContract.taxes.TaxTotal.amount} | Retorna o total de impostos do contrato original. | Número |
| {mainContract.taxes.GrandTotal.amount} | Retorna o preço bruto original do contrato, incluindo impostos. | Número |
| {mainContract.taxesWithApprovedOCOs.TaxTotal.amount} | Retorna o total de impostos do contrato original. | Número |
| {mainContract.taxesWithApprovedOCOs.GrandTotal.amount} | Retorna o preço bruto revisado do contrato, incluindo impostos. | Número |
| {mainContract.owner} | Retorna o proprietário a partir do painel do menu desdobrável | |
| {mainContract.owner.phone} | Retorna o número de telefone da empresa do proprietário | |
| {mainContract.architect} | Retorna a empresa do arquiteto a partir do painel do menu desdobrável |
Variáveis de contrato principal para pedidos de alteração
Use a seleção das variáveis de contrato principais para gerar documentos ao criar pedidos de alteração upstream. Use a pesquisa na parte superior da tabela para restringir os resultados exibidos.
| Variáveis | Descrição |
| {mainContract.code} | Retorna o código do contrato principal |
| {mainContract.description} | Retorna a descrição do contrato principal |
| {mainContract.name} | Retorna o nome do contrato principal |
| {mainContract.status} | Retorna o status do contrato principal |
| {mainContract.amount} | Retorna o valor do contrato principal |
| {mainContract.type} | Retorna o tipo do contrato principal |
| {@mainContract.note} | Retorna a nota do contrato principal |
| {mainContract.createdAt | date:'MM DD, YYYY'} | Retorna a data de criação do contrato principal |
| {@mainContract.scopeOfWork} | Retorna o escopo de trabalho do contrato principal. A linha em que esta variável está não pode conter nenhum outro texto. |
| {mainContract.executedDate | date:'MM DD, YYYY'} | Retorna a data em que o contrato principal foi executado |
| {mainContract.startDate | date:'MM DD, YYYY'} | Retorna a data em que o contrato principal foi iniciado |
| {mainContract.plannedCompletionDate | date:'MM DD, YYYY'} | Retorna a data em que o contrato principal deve ser concluído |
| {mainContract.actualCompletionDate | date:'MM DD, YYYY'} | Retorna a data em que o contrato principal foi concluído |
| {contract.mainContract.createdAt | date:'MM DD, YYYY'} | Retorna a data em que o contrato principal foi criado |
| {mainContract.closeDate | date:'MM DD, YYYY'} | Retorna a data em que o contrato principal foi fechado |
| {generalContractTaxAmount} | Retorna o total de impostos do contrato original. |
| {generalContractGrandAmount} | Retorna o preço bruto original do contrato, incluindo impostos. |
Dica:
- Os templates de documentos de pedido de alteração e contrato também podem usar as variáveis do contrato principal. Adicione uma das opções a seguir à variável específica do contrato principal:
- contract.
- pco.
- rfq.
- rco.
- oco.
- sco. Por exemplo, adicionar
sco.mainContract.startDateno modelo de documento SCO gerará a data em que o contrato principal foi iniciado.
- A planilha não é compatível com a variável rich text. Remova "@" da variável ao utilizá-la em planilhas. Por exemplo, em vez de {@pco.scopeOfWork}, use {pco.scopeOfWork}.
Artigos relacionados
Para saber mais sobre o uso de variáveis em diferentes cenários, consulte o artigo Exemplo de uso de variáveis.