Select your platform and then browse by platform category

Who are you and what section are you in?

Using the Custom Imports feature

Available for the following Payroll plans: Standard, Premium

The Custom Imports feature allows you to efficiently import payroll configuration data in bulk using your own spreadsheet or a system-generated template. This feature is designed to save time when setting up or updating pay run settings, reducing the need for manual data entry.

Over the next few months, we will be adding more settings that you can import using this feature. This document will be updated progressively as new import options become available, ensuring you always have access to the latest capabilities.

What you can import

Custom Imports supports importing Pay Run Settings, including:

  • Pay schedules
  • Pay categories
  • Benefit categories
  • Expense categories

Getting started with custom imports

Accessing the custom imports feature
  1. Navigate to Business Management in the left-hand menu.
  2. Click Custom Imports.
  3. Select Pay Run Settings from the Custom Import dropdown.
  4. Click the Begin Import button.
    Beging report.jpg 

Preparing your import file

Using the system template (recommended)

The easiest way to ensure your import file is formatted correctly is to use the system-generated template:

  1. Navigate to Data Extracts via the link on the Custom Imports page.
  2. Export the Pay Run Settings template.
  3. Open the template file - it will include all required column headings for:
    • Pay schedules
    • Pay categories
    • Benefit categories
    • Expenses
    • Dimensions
    • Locations
    • Deduction Categories
    • Qualifications
  4. Fill in your data under the appropriate headings.
  5. Save the file for import.

Helpful Hint

Using the system template ensures all column headings match the system fields, making the mapping process faster and reducing errors.

Using your own spreadsheet

If you prefer to use your own spreadsheet, follow these formatting guidelines:

File format

  • Supported formats: CSV, XLSX
  • Ensure column headings are in the first row

Field naming best practices

Because many fields share the same name (e.g., "Name", "External ID"), it's best to prefix your column headings with their destination. This makes mapping much easier:

  • Good: "Pay schedule name", "Pay schedule frequency", "Location name"
  • Avoid: "Name", "Frequency" (these are too generic)

Yes/No and On/Off fields

For fields that are toggle switches or checkboxes in the system:

  • Recommended: Use "true" or "false" - these will map automatically
  • Also accepted: "yes"/"no" or "on"/"off" - you'll need to map these manually

Required vs optional fields

Not every field is mandatory. Only include the fields you need to populate, just as you would when entering data manually.

Importing your data

Step-by-step import process

Step 1: Upload your file

  1. After clicking Begin Import, you'll see the import interface.
  2. Click Upload file and select your prepared spreadsheet.
    Upload.jpg 

Alternative option

You can also click Manually enter data to type information directly into the interface fields without uploading a file.

Step 2: Map your fields

After uploading, you'll see the field mapping screen:

  1. Review the Incoming Fields (your column headings) on the left.
  2. Confirm they're mapped to the correct Destination Fields (system fields) on the right.
    Mapping.jpg 
  3. If you used the system template, most fields will be automatically mapped correctly.
  4. If you used your own spreadsheet, click on any field to change its mapping from the dropdown list.
  5. Click Continue when all fields are correctly mapped.

Important

Pay careful attention to fields with similar names. For example, ensure "Pay schedule name" maps to "Pay schedule name" and not to another "name" field in the system.

Step 3: Remap values (if needed)

If your spreadsheet uses different terminology than the system expects:

  1. Review any fields flagged for remapping.
  2. Select the correct system value from the dropdown for each field.
    • Example: If you typed "days" but the system expects "Working days (Monday to Friday)", select the correct option from the dropdown.
      Map fields.jpg 
  3. Click Continue when all values are correctly mapped.

Step 4: Review and validate

  1. Review all data to be imported in the preview screen.
  2. Scroll horizontally to check all columns.
  3. Any invalid data will be highlighted in red.
  4. Click on any cell to edit the data directly if needed.
  5. Use the tabs at the top to switch between All, Valid, and Invalid records.
  6. When all data is correct, click Submit.

Step 5: Confirm success

After submission:

  • You'll receive a confirmation message that your data has been imported.
  • Navigate to the relevant settings area to verify your imported data (e.g., Pay Run Settings > Pay Schedules).
  • Check that all settings have imported correctly and make any necessary adjustments.

Further information

Tips for successful imports
  • Start small: If you're new to the feature, try importing a few records first to familiarize yourself with the process.
  • Use descriptive column names: Prefix your column headings with the section they belong to (e.g., "Pay schedule name", "Benefit category name").
  • Use true/false values: For yes/no fields, using "true" or "false" will automatically map correctly without additional steps.
  • Review before submitting: Always check the data preview screen carefully before clicking Submit, as this is your opportunity to catch any errors.
  • Keep a backup: Save a copy of your original spreadsheet before making any changes, so you can refer back to it if needed.
Troubleshooting common issues

Fields not mapping correctly

  • Ensure your column headings are descriptive and specific.
  • Use the field mapping screen to manually select the correct destination field from the dropdown.

Data showing as invalid (red)

  • Check that required fields are populated.
  • Verify that field formats match system requirements (e.g., dates, numbers).
  • For yes/no fields, ensure you're using accepted values (true/false, yes/no, or on/off).
  • Click on the invalid cell to edit it directly in the preview screen.

Import affecting existing data

  • If you're importing data that already exists in the system, you may receive a warning about overwriting current settings.
  • Review any warnings carefully before proceeding.
Was this article helpful?
0 out of 0 found this helpful