OfficeRnD Contract placeholders are containers for dynamically generated contract data. The format is a data reference contained within double curly brackets - {{ placeholder }}.
There are a few primary data objects available in the contract templates:
- contract
- resourceLines
- planLines
- location
- team
- org
- credits
Each has its own set of properties; the org object, for example, contains your company billing details such as billing address, name and VAT/REG numbers. In addition to these data objects, there are associated data objects such as logoUrl, deposit amount and terms and conditions.
| Property/Placeholder | Description |
| vatAmount | The tax amount applied on the contract. |
| varPercent | The tax percentage applied on the contract. |
| baseTotal | Total amount of the contract without taxes. |
| total | The total amount of the contract. |
| deposit | The deposit amount. |
| date | The date when the contract document is generated. |
| LegalDocuments | Legal documents included in the contract such as Terms and Conditions. |
| logoUrl | The URL to your organization logo so that it can be automatically displayed on the contract document. |
| credit.count | The total credits for the contract provided by the services and/or resources. |
| totalSetupFee | The total amount of setup fees provided by the billing plans. |
This article categorizes the placeholders by the data they display:
- Contract Data
- Resource Data
- Services Data
- Location Data
- Company Data
- Organization Data
Contract Data
| 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 for the rent of resources included in the contract. |
| contract.servicesTotal | The total amount for the plans(services) 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].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].date | The start date of the first month period in the contract. It matches the start date of the contract. |
| 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. |
Resource Data
When you create a License or a Lease agreement, you can add one or multiple resources to the contract. The resourceLines placeholder keeps the list of all resources added in the contract. By traversing the collection of resources, you can display the following information about each resources added in the contract:
| Property/Placeholder | Description |
| resourceLines[0].name | The name of the resource. |
| resourceLines[0].price | The price of the resource as explicitly specified in the contract. |
| 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. |
| resourceLines[0].discount | Discount on the resource regular price. |
| resourceLines[0].listPrice | Default resource price. |
| resourceLines[0].startDate | Same as the contract start date. |
| resourceLines[0].endDate | Same as the contract end date. |
| resourceLines[0].credits | Provides an object with own properties of "title", "count", "isValueCredits". Credits property displays the type, amount and name of the credits provided by the resource's plan. |
Services Data
| Property/Placeholder | Description |
| contract.servicesTotal | The average monthly total amount for the additional plans(services) included in the contract. |
| 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 on 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.monthly.servicesVat | The average monthly tax amount applied on 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. |
Plan Lines Data
| Property/Placeholder | Description |
| pLine.name | The name of the plan that you've added in services. |
| pLine.count | The quantity of plans of the same type and price. |
| pLine.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') |
| pLine.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') |
| contract.monthly.servicesVat | The average monthly tax amount applied on 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. |
Location Data
| Property/Placeholder | Description |
| locationId | The ID number of the location targeted in the contract. |
| location.name | Name of the location targeted in the contract. |
| location.address | Address 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. |
Company Data
The information about the company targeted in the contract can be displayed via the team property in the contract template. 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.country | The company country. |
| team.name | The company name. |
| team.properties | The company custom properties' values. |
| team.regNum | The company registration number. |
| team.state | The company state. |
| team.vatId | The company VAT Id. |
| team.zip | The company ZIP code. |
Contact Member Data
| member.name | The name of the contract's contact member. |
| member.email | The email of the contract's contact member. |
| member.properties | The contract contact member's custom properties' values. |
Organization Data
The information about your organization, such as billing details and address can be displayed via the org property in the contract template. 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 |
Credits Data
Plans (services) or target plans for resources sometimes provide credits to the user. The total credits provided by the contract through the services and/or resources is available as property to be used in the template. Each credit has their own property, described in the table below.
| Property/Placeholder | Description |
| credits[0].count | Total count of this group 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].isValueCredits | Boolean property that provides information if the credits are value credits or hour credits. If the value is false - the credits are hour credits |
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. |
Comments
0 comments
Please sign in to leave a comment.