Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Tip

Details of break clauses, allowances & responsibilities are stored on the Agreement tab of the tenancy record - the merge codes listed in this guide pull information from here

From tenancy:

  • Click Agreement

  • All break clauses, allowances and responsibilities are stored on this screen

    Agreement tab.pngImage Removed
Agreement tab.pngImage Added
Tip

Further information on agreement configuration is available in this section of the Knowledge Base: Configuration options (tenancy)

...

Responsibilities in the Agreement tab

Responsibilities are shown in the agreement tab of the tenancy record with the title of the responsibility displayed

  • Both the responsibility title and description/letter text have a merge code

  • The place in the list also needs to be noted as this needs to be inserted into the merge code

Responsibilities in Agreement tab.png

Responsibilities title

Responsibilities - title.png

Merge code

Merge code for the first title in the list:

<Tenancy.GetRespTitleSelectMerge(0)>

Merge code for the second title in the list:

<Tenancy.GetRespTitleSelectMerge(1)>

Number 2 should be used for the third responsibility in the list, and so on (a number needs to be entered into the merge code to ensure that the required responsibility is pulled into the letter/document)

Responsibilities description / letter text

Responsibilities - description.png

Merge code

Merge code for the first description in the list:

<Tenancy.GetRespDescSelectMerge(0)>

Merge code for the second description in the list is:

<Tenancy.GetRespDescSelectMerge(1)>

Number 2 should be used for the third responsibility in the list, and so on (a number needs to be entered into the merge code to ensure that the required responsibility is pulled into the letter/document)

...

Using formatting and/or numbered lists for merge codes

Formatting

Entering a merge code using formatting will pull that formatting through to the letter/document itself - e.g. bold

Numbered lists

A numbered list can be generated by adding ‘true’ to the right of the number within the brackets at the end of the merge code - e.g. <Tenancy.GetAllowTitleSelectMerge(0,true)>

If the number is not to be included then enter: <Tenancy.GetAllowTitleSelectMerge(0)>

Example

For example, to pull the title and description into a letter/document for the first allowance shown in the example below (i.e. Pets) - to show:

  • the title in bold

  • a number beside the the title

The following merge codes would need to be used in the template:

<Tenancy.GetAllowTitleSelectMerge(0,true)>

<Tenancy.GetAllowDescSelectMerge(0)>

Merge code formatting example.png

This will display the following text in a letter/document:

1. Pets

Pets Clause:

The Tenant agrees neither to keep any animals, birds or reptiles or rodents in or on the Premises nor to allow his invited guests or visitors to do so and in breach of this clause to be responsible for the reasonable costs of rectification of any damage caused or for any appropriate de-infestation, cleaning, fumigation etc required.

Info

Number 1. is shown next to this allowance due to it being the first entry in the list of allowances on the Agreement tab

...