If your organisation manages leave accruals in an external payroll system, the Data Loader tool allows you to import worker leave balances directly into Lumary. This article explains how to use the Data Loader to load leave balances into Contact Leave Type records, ensuring worker leave data is accurate and up to date. Note that this tool is only suitable for organisations exporting uninterpreted worker data from Lumary and should not be used if you are exporting interpreted timesheets or using Lumary Payroll.
Required packages and permissions
Available with: Lumary 2.12 and later
To import leave balances using the Data Loader:
- Navigate to the Data Loader tool in Lumary.
- Select the Leave Balance option.
- Then choose which employee ID type you will be using from the Contact Lookup Field.
- Download the leave_balance_template.csv file and open it in your preferred spreadsheet application.
- Populate the template with your leave balance data, adding one row per employee per leave type. You can include multiple leave types for the same employee. Refer to the field definitions table below for guidance on how to complete each column.
- Save your file in CSV format and upload it to the Data Loader. The system will process it automatically.
- Once processing is complete, review your results. If any records have failed, you can either correct them manually in Lumary or upload a new CSV file containing only the failed records with the errors resolved.
⚠️ Important: This tool will override any existing leave balances in Lumary. Ensure your data is correct before uploading.
The CSV template contains the following mandatory fields:
| Field | Purpose |
|---|---|
| *Payroll ID or External Client ID | Must match the Payroll Id field on the Payee record in Lumary. Each employee should have a unique Payroll ID or if using External Client ID: Must match the External Client ID field on the Contact record in Salesforce. |
| *Leave Type | The type of leave being recorded. Must exactly match the Name of a Leave Type record in Lumary, including correct spelling and capitalisation. |
| *Leave Balance | The worker's current leave balance, expressed in hours. Must be a number (decimals are allowed). |