Skip to main content
All CollectionsDocumentsHolding Confirmations
Variables for Payroll Statements
Variables for Payroll Statements

This guide outlines what variables you can use when creating custom Payroll Statements

Support Team avatar
Written by Support Team
Updated over a week ago

If you're looking for instructions on how to create Payroll Statements please check out this guide instead.

If you'd like to use Ledgy's template rather than create your own. Feel free to download the following file:

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}

      • {shareClassName}

      • {date}

      • {strikePrice}

      • {vesting}

      • {vestingStartDate}

      • {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

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.

Did this answer your question?