Skip to content
Log in
  • There are no suggestions because the search field is empty.

Pay Cycle Import

 Summary

Pay Cycle Import adds income or deduction amounts to the current draft pay run from an Excel file. Open Import from the pay cycle three-dot menu (⋮). The wizard has two stages: Details and Import.

Use PayrollIncomeOrDeductionTemplate.xlsx and make sure the worksheet name is Import.

In this article

  • Before you begin
  • Opening Import
  • Details
  • Importing
  • Frequently Asked Questions (FAQ)

Before you begin

You must have an active Payroll add-on to access and use Payroll features.

You need Company Money access, View Pay Schedules, and Start Payrun to open the draft pay cycle.

The Import menu is shown with Delete when you have Delete Payrun.

The pay cycle must be a draft pay run. Import is not available from a completed Pay Cycle History page.

Download PayrollIncomeOrDeductionTemplate.xlsx before completing your import file.

The following import requirements apply:

  • You can import a maximum of 1,000 records at a time.
  • For larger imports, divide the records into several smaller files.
  • The file must be .xlsx or .xls.
  • The maximum file size is 5 MB.
  • You can upload one file only.
  • The worksheet name must be Import.

The template uses the following columns:

  • Email — required
  • PayCode — required
  • Amount — required
  • Description — accepted on the import row

Spaces in column headers are removed when the import is processed.

Opening Import

  1. Open the draft pay cycle for the period using Start Pay run or Continue Pay run.
  2. If you have Delete Payrun, open the three-dot menu (⋮).
  3. Select Import.

The modal heading is Import.

The wizard timeline is:

Details → Import

Details

The Details stage shows the following guidance:

Maximum of 1,000 records per import. For optimal outcomes, consider dividing extensive imports into several smaller files.

Select the download link to download PayrollIncomeOrDeductionTemplate.xlsx.

Complete the template and make sure the worksheet is named Import.

Select Upload to add your completed file.

The upload control shows:

Drag and drop a file - Supported format: .CSV / Browse files.

Although the upload control mentions .CSV, Pay Cycle Import validates Excel file extensions .xlsx and .xls.

If the file extension is not supported, Plumm shows:

Please upload an Excel file with extension .xlsx or .xls.

If the file is larger than 5 MB, Plumm shows:

You cannot upload a file more than 5 MB.

If you select more than one file, Plumm shows:

You can only upload up to 1 files.

When a valid file is uploaded, Plumm shows Uploaded.

If the file contains more than 1,000 data rows, Plumm shows:

The Excel file has more than 1k rows. Please reduce the number of rows and try again.

If the file contains only a header row, Plumm shows:

The Excel file contains only header row without any data. Please add data and try again.

If you try to continue without selecting a file, Plumm shows:

Required field.

Select Next to continue.

Importing

Plumm validates the rows in the uploaded file.

If every row is valid, Plumm shows:

It seems everything looks good and ready to go.

If one or more rows fail validation, Plumm shows:

It seems there are some errors.

An Important Note explains that only working imports will be used. If you choose to skip a row with an issue, that row is not imported, but the remaining valid rows can still be loaded.

The error table contains:

  • Name
  • Error Description
  • Skip

Tick Skip next to an individual row to exclude it from the import.

You can also use the Skip checkbox in the header to skip all affected rows.

Validation messages can include:

  • Email is required field.
  • Pay Code is required field.
  • Amount is required field.
  • Email is not in correct format.
  • Amount is not in correct format.
  • Paycode already exist!
  • Not Found
  • Paycode Not Found

Select Back to return to Details if you need to change the file.

Select Submit to load the valid rows.

After Submit, the modal closes and the pay cycle grids refresh with the imported pay codes.

Frequently Asked Questions (FAQ)

  • Who can open Import on a pay cycle?
    Import is in the same three-dot menu (⋮) as Delete. This menu is shown when you have Delete Payrun.
  • Can I import on a completed pay run?
    No. Import is available on the draft pay cycle page and not on Pay Cycle History.
  • What template do I use?
    Use PayrollIncomeOrDeductionTemplate.xlsx. The worksheet name must be Import.
  • What columns are required?
    Email, Pay Code, and Amount are required. Description is also available on the import model.
  • What happens to rows I skip?
    Skipped rows are not imported. Other valid rows can still be loaded.
  • Can I import more than 1,000 rows?
    No. Split larger imports into smaller files. The wizard blocks files containing more than 1,000 data rows.