Variáveis do contrato
Escreva estas variáveis nos seus modelos de contrato e de adenda; a VIVIN substitui-as pelos dados da reserva.
Antes de começar
- Onde: os modelos que carrega em Definições → Contrato (
https://platform.vivin.app/settings/contract). Ver a lista de variáveis disponíveis aqui, nesse separador, abre as Variáveis do modelo de contrato, com um botão de copiar em cada uma. - Plano: todas as contas.
- Permissões: as mesmas de Contrato.
Escreva cada variável entre chavetas simples, tal como está na lista; as maiúsculas contam. As variáveis de assinatura começam por %, por exemplo {%TenantSignature}. Uma variável que a VIVIN não conhece é impressa em branco.
As variáveis que terminam em InText… existem em quatro línguas: substitua … por En, Pt, Es ou It, por exemplo {RentValueInTextPt}. Um modelo pode ter a mesma cláusula em duas línguas.
Inquilino
| Variável | Imprime |
|---|---|
{TenantName}, {TenantFirstName}, {TenantLastName} | Nome completo, nome próprio e apelido |
{TenantEmail}, {TenantPhone}, {Nationality} | Email, telefone, nacionalidade |
{FiscalId} | NIF |
{IdentificationId}, {TenantIdDocumentType}, {TenantIdDocumentCountry}, {TenantIdDocumentExpiryDate} | Número do documento, tipo de documento, país de emissão, data de validade |
{TenantFiscalAddress} | Morada de residência |
{TenantDateOfBirth}, {TenantPlaceOfBirth} | Data e local de nascimento |
{TenantResidenceAddress}, {TenantResidenceCity}, {TenantResidenceCountry} | Residência principal |
{TenantEmergencyContact1Name}, …Relationship, …Email, …Phone | Primeiro contacto de emergência (use 2 para o segundo) |
Os dados de nascimento, a residência principal e os contactos de emergência só são recolhidos enquanto essas secções estiverem ativadas em Detalhes do contrato; caso contrário, ficam em branco.
Segundo inquilino e fiador
Preenchidas a partir das secções Segundo inquilino e Fiador do separador Informação do Contrato da reserva. Numa reserva sem eles, ficam em branco (ou imprimem N/A), por isso um só modelo serve para todas as reservas.
- Segundo inquilino:
{SecondTenantName},{SecondTenantFirstName},{SecondTenantLastName},{SecondTenantEmail},{SecondTenantPhone},{SecondTenantNationality},{SecondTenantFiscalId},{SecondTenantIdentificationId},{SecondTenantIdDocumentType},{SecondTenantIdDocumentCountry},{SecondTenantIdDocumentExpiryDate},{SecondTenantFiscalAddress}. - Fiador: o mesmo conjunto, começado por
Guarantor(por exemplo{GuarantorName}), mais{GuarantorAmount}e{GuarantorAmountInText…}, que imprimem em branco (nunca0) quando não é indicado nenhum valor.
Para ambos, só se registam os dados de identificação; os dados de faturação e bancários vêm do inquilino principal.
Proprietário
{OwnerName}, {OwnerFiscalId}, {OwnerFiscalAddress}, {OwnerEmail}, {OwnerPhone}, {OwnerIdDocumentType}, {OwnerIdDocumentNumber} vêm do proprietário da propriedade em Proprietários. Ficam em branco numa propriedade sem proprietário.
Propriedade, unidade e reserva
| Variável | Imprime |
|---|---|
{PropertyAddress} | Morada da propriedade |
{ListingInternalName}, {Floor}, {RoomNumber} | Nome interno da unidade, andar, número do quarto |
{PropertyTotalRooms} | Número de unidades da propriedade |
{PropertyRoomRange} | Nomes das unidades: um intervalo (H.1 a H.6) quando não falta nenhum número, caso contrário uma lista (H.1, H.3, H.6) |
{PropertyArea}, {ListingArea} | Área em m², com duas casas decimais; em branco se não estiver definida |
{PropertyAreaInText…}, {ListingAreaInText…} | Área por extenso: sixty-two [62] square meters (En), sessenta e dois [62] metros quadrados (Pt) |
{LeasePurpose} | A finalidade do arrendamento da reserva |
{BookingSource} | Plataforma de onde veio a reserva; em branco nas reservas diretas |
As áreas vêm do separador Integração completa do editor da propriedade ou da unidade. As opções de finalidade do arrendamento definem-se em Categorias.
Datas e duração
| Variável | Imprime |
|---|---|
{StartDate}, {EndDate} | Datas do contrato, 01/09/2026 |
{CheckInDate}, {CheckOutDate} | Datas de entrada e de saída |
{CheckInTime}, {CheckOutTime} | Horas de check-in e de check-out |
{StartDateInText…}, {EndDateInText…}, {CheckInDateInText…}, {CheckOutDateInText…} | Forma extensa: September 1, 2026, 1 de setembro de 2026, 1 de septiembre de 2026, 1 settembre 2026 |
{ContractDurationMonths} | Meses completos, em número: 6 |
{ContractDurationInText…} | Meses completos por extenso: six [6] months (En), seis [6] meses (Pt, Es) |
{ContractDurationDays} | Dias que sobram depois dos meses completos |
{ContractDurationFullInText…} | Meses e dias: three [3] months and thirteen [13] days (En), tres [3] meses y trece [13] días (Es) |
{ContractSignDate} | O dia em que o contrato é gerado, enquanto a estadia não começou; a partir da data de início, a data de início |
{ContractGenerationDate} | Sempre o dia em que o PDF é produzido |
- A duração conta a data de fim como último dia, por isso de 01/01 a 30/06 são 6 meses. Os meses incompletos não são arredondados para cima.
- Uma data em falta é impressa em branco, nas duas formas.
- Nas renovações, ou em qualquer contrato regenerado depois de a estadia ter começado, ponha
{ContractGenerationDate}na linha da assinatura;{ContractSignDate}imprimiria a data de início original.
Valores
| Variável | Imprime |
|---|---|
{RentValue} | Renda mensal; um intervalo (900 - 1100) quando muda de mês para mês |
{CurrencySymbol}, {Currency} | O símbolo da moeda da reserva (€, £, $) e o código (EUR, GBP, USD) |
{RentJan} … {RentDec} | Renda de cada mês; os meses fora do contrato imprimem NA |
{SecurityDeposit}, {AdministrativeFee}, {CleaningFee}, {ExitFee} | Caução e taxas; 0 quando não existem |
{ContractTotalValue} | Renda total do contrato, sem taxas; não muda à medida que o inquilino paga |
{TotalValuePending} | Valor ainda por pagar |
{Debt} | Valor em dívida; 0 quando o saldo não é negativo |
{AmountDueAtBookingConfirmation}, {AmountDueAtCheckIn} | Pagamentos exigidos na confirmação da reserva ou no check-in; 0 quando não há |
{BillsIncludedMaxValue} | Máximo de contas incluídas por mês |
{vIBAN} | O IBAN virtual da reserva para transferências |
{LocalRentCap}, {RentCapDifference} | Limite da renda e parte de serviços com preços duplos |
Valores por extenso: {RentValueInText…}, {SecurityDepositInText…}, {CleaningFeeInText…}, {ContractTotalValueInText…}, {AmountDueAtBookingConfirmationInText…}, {AmountDueAtCheckInInText…} e {GuarantorAmountInText…}. Escrevem o valor por extenso na moeda da reserva, com os cêntimos (eight hundred and fifty euros and fifty cents); uma renda que muda imprime o intervalo (nine hundred to one thousand one hundred euros).
A renda mensal é de {RentValue} {CurrencySymbol} ({RentValueInTextPt}).
The monthly rent is {CurrencySymbol}{RentValue} ({RentValueInTextEn}).
Assinaturas e um segundo documento
| Variável | O que faz |
|---|---|
{%TenantSignature} | A assinatura do inquilino, acrescentada quando assina no portal |
{%SecondTenantSignature}, {%GuarantorSignature} | As assinaturas do segundo inquilino e do fiador; em branco até assinarem |
{%LandlordSignature} | A sua assinatura do senhorio guardada, acrescentada quando o inquilino assina |
{NewDocument: Name} | Divide o modelo num segundo documento, assinado em conjunto com o contrato |
Para anexar, por exemplo, o regulamento da casa, escreva {NewDocument: House rules} numa linha própria no corpo do texto. Tudo o que fica abaixo passa a ser um PDF separado, com o nome do texto que vem a seguir aos dois pontos; o inquilino assina os dois de uma só vez e ambos ficam guardados nos ficheiros da reserva. Acrescente variáveis de assinatura abaixo da linha se o segundo documento precisar delas. A linha não faz nada dentro de uma tabela, de uma caixa de texto ou de um cabeçalho.
Adenda
Use estas no modelo de adenda, a par das variáveis normais, que imprimem os novos valores:
- Condições assinadas por último:
{PreviousStartDate},{PreviousEndDate},{PreviousCheckInDate},{PreviousCheckOutDate},{PreviousRentValue},{PreviousSecurityDeposit},{PreviousAdministrativeFee},{PreviousExitFee},{PreviousCleaningFee}. - Período acrescentado, nas prorrogações:
{ExtensionStartDate},{ExtensionEndDate},{ExtensionRentValue}.
Resolução de problemas
- Um valor é impresso em branco: verifique a ortografia e as maiúsculas, e se a reserva tem esse dado. Ative Imprimir N/A nas variáveis vazias para ver quais estão vazias.
- A VIVIN recusa-se a gerar o contrato por causa de um símbolo de moeda: use
{CurrencySymbol}ou{Currency}em vez de um€,£ou$escrito à mão.
Dicas
- Use uma só forma de um valor por cláusula:
{StartDate} {StartDateInTextEs}imprime a data duas vezes, e{ContractDurationInTextEs}já inclui o número entre parênteses retos. - Faça coincidir o sufixo da língua com a cláusula à volta.
Ver também
- Contrato
- Reservas
- Predefinições de reservas e pagamentos: Detalhes do contrato
- Proprietários
- Portal do inquilino