Introduction
Ledgy's Payroll Statement templates use dynamic variables to automatically populate stakeholder data, grant details, settlements and transaction custom fields. This reference guide lists all available variables you can use when customising your template, including how to display arrays of grants or settlements and show content conditionally. If you're new to creating Payroll Statements, start with our step-by-step creation guide first.
If you'd like to use Ledgy's template rather than create your own. Feel free to download the following file: Ledgy payroll annex template (2).docx
Available variables
Global variables
{today} gives today
{date} gives the date selected in the form
{currency} gives the currency in the company settings
Stakeholder Specific Variables
Stakeholder
{stakeholder.name}
{stakeholder.email}
{stakeholder.nationality}
{stakeholder.birthdate}
{stakeholder.notes}
{stakeholder.identifier}
Stakeholder address
{stakeholder.address.line1}
{stakeholder.address.line2}
{stakeholder.address.postcode}
{stakeholder.address.city}
{stakeholder.address.county}
Stakeholder Custom Fields
General Structure: {stakeholder.Custom Field}
Example:
Custom Field example: "Cost Center: 7237-234"
Custom Field variable: {stakeholder.Cost Center} ⇒ Result: 7237-234
Grant Specific Variables
Grants: for the total amounts of grants
{stakeholder.granted}
{stakeholder.issued}
{stakeholder.ownershipPercentage}
{stakeholder.votingPercentage}
{stakeholder.grantVested}
{stakeholder.grantValue}
{stakeholder.shareCapital}
{stakeholder.dilutedShareCapital}
{stakeholder.vestedGrantValue}
{stakeholder.vestedStockValue}
Per Grant variables: (variables inside an array of grants)
{#stakeholder.grants} to be added in the first column of the array
{grantType}
{poolName}
{granted}
{grantValue}
{grantVested}
{outstanding}
{class}
{date}
{strikePrice}
{vesting}
{vesting.StartDate}
{shareCapital}
{dilutedShareCapital}
{/stakeholder.grants} to be added in the last column of the array: closes the array of variables linked to #grants
Settlement Specific Variables
Per Settlement variables: (variables inside an array of grants)
{#stakeholder.settlements} to be added in the first column of the array
{date}
{grantDate}
{exercised}
{fmvAtExercise}
{exercisePrice}
{totalFmvAtExercise}
{totalGainLoss}
{/stakeholder.settlements} to be added in the last column of the array: closes the array of variables linked to #settlements
Transaction Custom Fields
You can include transaction custom field values in your Payroll Statements. Transaction custom fields are set up in Company Settings > Data Management > Transaction custom fields.
Per Grant transaction custom fields: (use inside the grants array)
{#stakeholder.grants} to be added in the first column of the array
{customField.X} where X is the name of your custom field
{/stakeholder.grants} closes the array
Per Settlement transaction custom fields: (use inside the settlements array)
{#stakeholder.settlements} to be added in the first column of the array
{customField.X} where X is the name of your custom field
{/stakeholder.settlements} closes the array
Example:
Custom field name: "Board approval status"
Variable: {customField.Board approval status} ⇒ Result: Approved
Note: Transaction custom fields must first be created in Company Settings > Data Management and populated on the relevant transactions before they can be used in templates. See Custom fields for transactions for setup instructions.
Show Blocks Conditionally
To avoid clutter and only show blocks within the document if a stakeholder has grants or settlements follow these instructions.
To show a whole block conditionally wrap it in:
{#stakeholder.hasGrants}/{#stakeholder.hasSettlements}
This only shows up if the stakeholder has at least one grant/settlement
{/}
Example template
Please check out the example template to see how the variables and the variables inside an array are implemented.