Contract Template Properties

 

OfficeRnD Flex comes with a set of predefined contract templates for a license agreement, a lease agreement, a membership agreement, and a quote. Read more about the different types of contacts supported on the platform

Customizing Templates

If you want to customize any of the default templates, you can:

  • Navigate to Settings/Templates/Contracts
  • Open one of the existing templates
  • Choose to edit or clone it

In order to customize one of the default templates, you can use the Text Editor or you can update its Code using HTML and CSS.

mceclip0.png

When customizing the contract templates, you can use a variety of properties, which act as placeholders for dynamically generated content.  These properties are enclosed:

  • Text Editor: in single square brackets, such as [date]
  • Code: in double curly quotes, such as {{date}}.

Adding CSS

If you want to add CSS code to a template, you need to add it in the Custom Code section: 

mceclip1.png

Editing the Dates Format

By default all dates in the invoice documents are formatted as DD/MM/YYYY. If this format doesn't match your local date format, you can change it. Find more information about the different date formats available in OfficeRnD Flex.

Contract Template Properties

Primary Properties

There are a few primary properties available in the contract templates:

Property/Placeholder Description
baseTotal Total amount of the contract without taxes.

contract

This property contains additional information about the contract. Review all sub-properties available as additional information through the contract property. 

credits

Information about the credits provided by the contract through its services, one-off fees and/or resources. Review the properties of each credit record.

currency

Information about the default currency of the contract. Review its properties for more details.
date The date when the contract document is generated.
deposit The deposit amount.

eSign

A property representing esign information, such as name, signature and date of signing. 
LegalDocuments Legal documents included in the contract such as Terms and Conditions.

location

Information about the location of the contract. Review its detailed properties.

locationId

The ID number of the location targeted in the contract.
logoUrl The URL to your organization logo so that it can be automatically displayed on the contract document.

member

Information about the company member acting as a representative of the company, signing the contract. Review the available properties for the member.

oneOffPlanLines

A detailed list of the one-offs included in the contract. Review all available information, which you can print on the document.

org

Detailed information about your organization, your address, and billing details. Review all information that you can print on the contract document.

orgName

The default name of your account in OfficeRnD Flex. 

planLines

A detailed list of the plans (services) included in the contract. Review all available information, which you can print on the document.

resourceLines

A detailed list of the resources included in the contract. Review all available information, which you can print on the document.

setupFees

A detailed list of the setup fees included in the contract. Review all available information, which you can print on the document.

team

Information about the company the contract is created for. Review all additional properties you can display for the company. 

termsHtml

The html code of the terms and conditions included in the contract. 
total The total amount of the contract. 
totalSetupFee The total amount of setup fees provided by the billing plans.
varPercent The tax percentage applied on the contract. 
vatAmount The tax amount applied on the contract. 

Location 

This property provides additional information about the location targeted in the contract. 

Property/Placeholder Description
location.name Name of the location targeted in the contract.
location.address Address of the location targeted in the contract.
location.country The country of the location targeted in the contract.
location.code The code of the location targeted in the contract. 
location.properties List of any custom location properties.
location.slug The slug of the location targeted in the contract.
location.officeData.isOpen
A boolean value indicating if the targeted location is open.
location.officeData.public
A boolean value indicating if the targeted location is publicly available on the members portal.

Team

This property provides additional information about the company targeted in the contract. Here are the exact details of what you can display for the company.

Property/Placeholder Description
team.address The company registered address.
team.billingAddress The company billing address.
team.city The company city.
team.state The company state.
team.zip The company ZIP code.
team.country The company country.
team.name The company name.
team.properties The company custom properties' values.
team.regNum The company registration number.
team.vatId The company VAT Id.

Member

This property provides additional information about the company member acting as a representative of the company, signing the contract.

Property/Placeholder Description
member.name The name of the contact member.
member.email The email of the contact member.
member.properties The contact member's custom properties' values.

Org

This property provides additional information about your organization, such as billing details and address. Here are the exact details of what you can display:

Property/Placeholder Description
org.accountBank Your organization bank account
org.accountBic Your organization BIC number
org.accountIban Your organization IBAN
org.address Your organization address
org.city Your organization city
org.country Your organization country
org.name Your organization name
org.regId Your organization registration number
org.vatId Your organization VAT Id 
org.state Your organization State 
org.zip Your organization ZIP code 

Contract 

This property holds additional information about the contract. 

Property/Placeholder Description
contract.startDate The start date of the contract.
contract.endDate The end date of the contract.
contract.noticeDate The first date of the notice period.
contract.notice The notice period of the contract.
contract.number The contract number.
contract.total The total amount of the contract. 
contract.resourcesTotal The total amount of the rent of all resources included in the contract.
contract.servicesTotal The total amount of the plans(services) included in the contract.
contract.oneOffsTotal
The total amount of the one-offs included in the contract.
contract.baseTotal  The total amount of the contract without taxes.
contract.previousDepositHeld  The deposit held for this customer before creating the contract.
contract.properties  List of custom contract properties.
contract.perMonth[0].baseTotal  The total amount of the first-month payment excluding the deposit and the tax rate.
contract.perMonth[0].vatAmount  The tax amount applied in the first month of the contract. 
contract.perMonth[0].total  The total amount of the first-month payment.
contract.perMonth[0].discount The total amount of the first-month discount.
contract.perMonth[0].servicesBase  The total amount for the plans(services) included in the first month of the contract, excluding taxes and deposits.
contract.perMonth[0].servicesVat  The tax amount applied to the plans(services) in the first month of the contract.
contract.perMonth[0].servicesTotal  The total amount for the additional plans(services) included in the first month of the contract.
contract.perMonth[0].resourcesBase  The total amount for the resources included in the first month of the contract, excluding taxes and deposits.
contract.perMonth[0].resourcesVat The tax amount applied to the resources in the first month of the contract.
contract.perMonth[0].resourcesTotal The total amount for the resources included in the first month of the contract.
contract.perMonth[0].oneOffsBase The total amount for the one-offs included in the first month of the contract, excluding taxes and deposits.
contract.perMonth[0].oneOffsVat The tax amount applied to the one-offs in the first month of the contract.
contract.perMonth[0].oneOffsTotal The total amount for the one-offs included in the first month of the contract.
contract.perMonth[0].date The start date of the first month period in the contract. It matches the start date of the contract.
contract.perMonth[0].dayOfMonth The string representation of the start date of the first period in the contract. The format is Dth MMM-YYYY (e.g. 9th June-2022).
contract.perMonth[0].month The string representation of the month of the first period in the contract. The format is MMM-YYYY (e.g. June-2022).
contract.monthly.servicesVat  The average monthly tax amount applied to the plans(services) included in the contract.
contract.monthly.servicesBase  The average monthly total amount for the plans(services) included in the contract, excluding taxes and deposits.
contract.monthly.servicesTotal  The average monthly total amount for the additional plans(services) included in the contract.
contract.monthly.resourcesBase  The average monthly total amount for the resources included in the contract, excluding taxes and deposits.
contract.monthly.resourcesVat  The average monthly tax amount applied to the resources included in the contract.
contract.monthly.resourcesTotal  The average monthly total amount for the resources included in the contract.
contract.monthly.baseTotal  The average monthly total amount excluding the deposit and the tax rate.
contract.monthly.vatAmount  The average monthly tax amount.
contract.monthly.total  The average monthly total amount.

ResourceLines

This property provides a detailed list of the resources that are included in the contract. It is a collection of items and it, therefore, has to be traversed by a for cycle. 
 
When you create a License or a Lease agreement, you can add one or multiple resources to the contract. By traversing the collection of resources, you can display the following information about each resource added in the contract:
Property/Placeholder Description
resourceLines[0].id The id of the resource in OfficeRnD Flex.
resourceLines[0].name The name of the resource.
resourceLines[0].price The price of the resource as explicitly specified in the contract (including any discounts). The property is formatted as a currency string.
resourceLines[0].desks The number of desks in the resource of type private office.
resourceLines[0].pricePerDesk The price per desk for private office resource types. The property is formatted as a currency string.
resourceLines[0].discount Discount on the resource regular price. The property is formatted as a currency string.
resourceLines[0].listPrice Default resource price. The property is formatted as a currency string.
resourceLines[0].unitPrice The price of the resource as explicitly specified in the contract (including any discounts). This property is a numeric value. 
resourceLines[0].startDate The start date of the resources rent.
resourceLines[0].endDate The end date of the resources rent.
resourceLines[0].vatPercent
The tax percent applied to the resource's rent. This property is a numeric value. 
resourceLines[0].setupFeeTotal
The total amount of the resource's setup fees. The property is formatted as a currency string.
resourceLines[0].subtotal
The total amount of the resource's rent without taxes.  This property is a numeric value. 
resourceLines[0].baseUnitPrice
The price of the resource as explicitly specified in the contract (including any discounts) without taxes. This property is a numeric value. 
resourceLines[0].vatAmount
The tax amount applied on the resource's rent. This property is a numeric value. 
resourceLines[0].baseTotal
The total amount of the resource's rent without taxes. This property is a numeric value. 
resourceLines[0].total
The total amount of the resource's rent. This property is a numeric value. 
resourceLines[0].credits

Provides an object with own properties of "title", "count", "isValueCredit". Credits property displays the type, amount, and name of the credits provided by the resource's plan.

Note: Credits require a 2nd for loop for every resource.

Example:

<div style="margin-top:20px;">
{% for r in resourceLines %}
{% for credit in r.credits %}
{{credit.count}}<br />
{{credit.title}}<br />
{{credit.isValueCredit}}
{% endfor %}
{% endfor %}
</div>
 

PlanLines

This property provides a detailed list of the pllans (services) that are included in the contract. It is a collection of items and it, therefore, has to be traversed by a for cycle. By traversing the collection of resources, you can display the following information about each plan (service) added in the contract:

Property/Placeholder Description
planLines[0].id
The id of the plan in OfficeRnD Flex.
planLines[0].name The name of the plan that you've added in services.

planLines[0].quantity

planLines[0].count

The quantity of plans of the same type and price.
planLines[0].listPrice
The default plan price. The property is formatted as a currency string.
planLines[0].price
The price of the plan as explicitly specified in the contract (including any discounts). The property is formatted as a currency string.
planLines[0].unitPrice
The price of the plan as explicitly specified in the contract (including any discounts). This property is a numeric value. 
planLines[0].setupFeeTotal The total amount of the setup fees of the plan. The property is formatted as a currency string.
planLines[0].steps[0].startDate The start date of the plan line. Please note that the data format also has to be entered, you can change the format using |date('d-m-Y') or |date('m-d-Y').
Example: (pLine.steps[0].startDate)|date('d-m-Y')
planLines[0].steps[0].endDate The end date of the plan line. Please note that the data format also has to be entered, you can change the format using |date('d-m-Y') or |date('m-d-Y').
Example: (pLine.steps[0].endDate)|date('d-m-Y')
planLines[0].steps[0].price
The default price of the plan in each step (excluding any discounts). This property is a numeric value. 
planLines[0].steps[0].calculatedDiscountAmount
 
The total amount of the discount of the plan in each step. This property is a numeric value. 
planLines[0].steps[0].discountedPrice
 
The discounted price of the plan in each step. This property is a numeric value. 
planLines[0].discount
Discount on the plan's regular price. This property is a numeric value. 
planLines[0].vatPercent
The tax percent applied to the plan's price. This property is a numeric value. 
planLines[0].subtotal
The total amount of the plan without taxes.  This property is a numeric value. 
planLines[0].baseUnitPrice
The price of the plan as explicitly specified in the contract (including any discounts) without taxes. This property is a numeric value. 
planLines[0].vatAmount
The tax amount applied on the plan's price. This property is a numeric value. 
planLines[0].baseTotal
The total amount of the plan without taxes. This property is a numeric value. 
planLines[0].total
The total amount of the plan. This property is a numeric value. 
planLines[0].setupFeeTotal
The total amount of the plan's setup fees. The property is formatted as a currency string.
planLines[0].credits

Provides an object with own properties of "title", "count", "isValueCredit". Credits property displays the type, amount, and name of the credits provided by the plan.

Note: Credits require a 2nd for loop for every resource.

Example:

<div style="margin-top:20px;">
{% for r in resourceLines %}
{% for credit in r.credits %}
{{credit.count}}<br />
{{credit.title}}<br />
{{credit.isValueCredit}}
{% endfor %}
{% endfor %}
</div>

OneOffPlanLines

This property provides a detailed list of the one-off plans that are included in the contract. It is a collection of items and it, therefore, has to be traversed by a for cycle. By traversing the collection of one-off fees, you can display the following information about each one-off fee added in the contract:

Property/Placeholder Description
oneOffPlanLines[0].id
The id of the one-off plan in OfficeRnD Flex.
oneOffPlanLines[0].name The name of the one-off plan that you've added in services.
oneOffPlanLines[0].quantity The quantity of the one-off plans of the same type and price.
oneOffPlanLines[0].listPrice
The default one-off plan price. The property is formatted as a currency string.
oneOffPlanLines[0].price
The price of the one-off plan as explicitly specified in the contract (including any discounts). The property is formatted as a currency string.
oneOffPlanLines[0].unitPrice
The price of the one-off plan as explicitly specified in the contract (including any discounts). This property is a numeric value. 
oneOffPlanLines[0].setupFeeTotal The total amount of the setup fees of the one-off plan. The property is formatted as a currency string.
oneOffPlanLines[0].steps[0].startDate The date of the one-off. Please note that the data format also has to be entered, you can change the format using |date('d-m-Y') or |date('m-d-Y').
Example: (pLine.steps[0].startDate)|date('d-m-Y')
oneOffPlanLines[0].steps[0].price
The default price of the one-off plan in each step (excluding any discounts). This property is a numeric value. 
oneOffPlanLines[0].steps[0].calculatedDiscountAmount
 
The total amount of the discount of the one-off plan in each step. This property is a numeric value. 
oneOffPlanLines[0].steps[0].discountedPrice
 
The discounted price of the one-off plan in each step. This property is a numeric value. 
oneOffPlanLines[0].discount
Discount on the one-off plan's regular price. This property is a numeric value. 
oneOffPlanLines[0].vatPercent
The tax percent applied to the one-off plan's price. This property is a numeric value. 
oneOffPlanLines[0].subtotal
The total amount of the one-off plan without taxes.  This property is a numeric value. 
oneOffPlanLines[0].baseUnitPrice
The price of the one-off plan as explicitly specified in the contract (including any discounts) without taxes. This property is a numeric value. 
oneOffPlanLines[0].vatAmount
The tax amount applied on the one-off plan's price. This property is a numeric value. 
oneOffPlanLines[0].baseTotal
The total amount of the one-off plan without taxes. This property is a numeric value. 
oneOffPlanLines[0].total
The total amount of the one-off plan. This property is a numeric value. 
oneOffPlanLines[0].setupFeeTotal
The total amount of the one-off plan's setup fees. The property is formatted as a currency string.
oneOffPlanLines[0].credits

Provides an object with own properties of "title", "count", "isValueCredit". Credits property displays the type, amount, and name of the credits provided by the plan.

Note: Credits require a 2nd for loop for every resource.

Example:

<div style="margin-top:20px;">
{% for r in resourceLines %}
{% for credit in r.credits %}
{{credit.count}}<br />
{{credit.title}}<br />
{{credit.isValueCredit}}
{% endfor %}
{% endfor %}
</div>

SetupFees

This property provides a detailed list of the setup fees that are included in the contract. It is a collection of items and it, therefore, has to be traversed by a for cycle. By traversing the collection of setup fees, you can display the following information about each setup fee added in the contract:

Property/Placeholder Description
setupFees[0].plan The billing plan that that is being used for the setup fee.
setupFees[0].setupFees[0].name The name of the billing plan for the setup fee.
setupFees[0].setupFees[0].price The price of the billing plan for the setup fee.
setupFees[0].setupFees[0].count The number of setup fees.

Note: All properties except for the plan require 2 for loops to cycle through. One for each billing plan and an additional one for the details of the plan itself.

Example:

<div style="margin-top:20px;">
{% for setupFeePlan in setupFees %}
{{setupFeePlan.plan}} - this is the plan of the setup fee.<br />
{% for setupFee in setupFeePlan.setupFees %}
{{setupFee.name}}<br />
{{setupFee.price}}<br />
{{setupFee.count}}
{% endfor %}
{% endfor %}
</div>

Credits 

This property provides information about the credits provided by the contract through its services, one-off fees and/or resources. Each credit record has additional information available via the next set of properties:

Property/Placeholder Description
credits[0].count Total count of this record of credits
credits[0].title Combination of the names of the rates that the credits are for, or All Resource Rates, if no specific rates are selected.
credits[0].isValueCredit Boolean property that provides information if the credits are value credits or hour credits. If the value is false - the credits are hour credits
Note that you can also display the credits per resources, plans (services) and one-offs as the exact number of credits available with each resource, plan, and a one-off fee is available in their corresponding collections. 

How to Display the Total Number of Coins or Credits Separately

In order to separately display in your contract the total number of credits and coins provided by the resources, plans, or one-off fees, you can use the following table:

Custom Code

<table>
    <tr>
        <th style="text-align:left;">Credits Type</th>
        <th style="text-align:left;">Title</th>
        <th style="text-align:right;">Amount</th>
    </tr>
    {% for credit in credits %}
    <tr>
        <td style="text-align:left;">{% if credit.isValueCredit == false %}Hourly credits{% else %}Coins{% endif %}</td>
        <td style="text-align:left;">{{credit.title}}</td>
        <td style="text-align:right;">{{credit.count}}</td>
    </tr>
    {% endfor %}
</table>

Currency

This property provides information about the default currency used in the contract. Review the additional properties you can use to display currency information on your contract documents:

Property/Placeholder Description
currency.code
The three-letter alphabetic code that represent the currency. 
currency.symbol The graphic symbol used as a shorthand for the currency's name.
currency.thousandsSeparator The character used as the thousands separator.
currency.decimalSeparator The character used as the decimal separator
currency.symbolOnLeft A boolean value indicating if the currency symbol is displayed on the left or right of the currency amount. 
currency.spaceBetweenAmountAndSymbol A boolean value indicating if there is a space between the amount and symbol of the contracts' values. 
currency.decimalDigits The number of decimal digits. 

eSign Properties

Property/Placeholder Description
orgESignTag("text", 20) Free text field
orgESignTag("date", 20) Date of signing
orgESignTag("sig", 20) Signature field
memberESignTag("text", 20) Free text field
memberESignTag("date", 20) Date of signing
memberESignTag("sig", 20) Signature field

Other Functions

Property/Placeholder Description
sum('placeholder') Allows the summing of placeholders or properties of placeholders.
Example: resourceLines|sum('desks') will give you the total number of desks for the contract.
map('placeholder')

Allows the projection of properties of placeholders.
Example: resourceLines | map('price') | map(parseMoney) | sum | money.
This will map the price of each resource line, parse it, sum it and then format it to a currency format.

 

Was this article helpful?
2 out of 5 found this helpful

Comments

0 comments

Please sign in to leave a comment.