Skip to main content
Timeclock and payroll

The payroll run (wizard)

The payroll wizard takes one pay period through five fixed steps, from setup and reconciliation to review, summary, locking and paystubs.

Last updated 26 days ago

The payroll wizard is the guided screen for running one pay period. It has five steps in a fixed order. Payroll administrators use all five steps. A user who only has the accountant role uses Step 4.

Before you start: the Timeclock & Payroll module must be on for your organization, and the pay period must already exist (create it with New Period on Pay periods). Set up your payroll employees and rule groups before the first run, not during it. A rate or rule that changes halfway through a run means the figures you already reviewed no longer match.

Open the wizard for a pay period

  1. Open the card of the period you want to run. Period cards are on the Payroll tab of the Admin Hub (the Payroll Management entry in the side menu opens it) and on the stand-alone Payroll Management page (/timeclock/payroll), not the sidebar entry of the same name. Both are described in Pay periods.
  2. Select Wizard on the card.

The wizard opens on the step the period was left on. The left rail shows the period name, a checkmark beside every step behind you and a dot beside the current one. Back to Admin at the bottom of the rail returns you to the hub.

A locked period still has a Wizard button. Open it to look back at how the period was run, or to unlock or reopen it. If the period cannot be loaded, the wizard shows Period Not Found and a Back to Admin Hub button.

The five steps

StepWhat you do thereWhere it is explained
1. SetupCheck the period and payment date, and choose the employees.This page
2. ReconcileSettle leave, punch problems and overtime, optionally run an AI check, and add manual adjustments.Payroll wizard: reconcile
3. Preview & AuditReview each employee from the card down to single punches, and mark each one reviewed.Payroll wizard: preview and summary
4. Summary & ExportCheck the totals, correct figures, export a provisional Excel file and give an accountant access.Payroll wizard: preview and summary and Giving your accountant access
5. FinalizeReview edits to the figures, lock the period, download the final report and send paystubs.Payroll wizard: finalize and paystubs

Who can use which step

The wizard admits the Payroll Admin, Payroll Accountant and Administrator roles.

  • Payroll Admin and Administrator: all five steps.
  • Payroll Accountant only: the wizard opens on Step 4 and the other steps are grayed out. Step 4 has no Accountant Access panel and no Back to Preview or Continue to Finalize buttons.

To give an accountant access, either with the role or with a link that needs no account, see Giving your accountant access.

The wizard remembers where you were

Each time you change step, the wizard saves the step on the period. Whoever opens the period next continues on that step instead of starting at Setup. If you take over a run that someone else started, read the rail before you read the screen: the step you land on tells you how far the run got.

You can go back to any earlier step from the rail. You can go forward one step at a time, and the rail makes the same checks as the Continue buttons (see below). While you are on Step 2, the rail lists five sub-steps under Reconcile: PTO / Leave, Punch Issues, OT Review, AI Review and Adjustments. The first four show how many items are still open; Adjustments shows how many adjustments the period has.

Step 1: Set up the run

  1. Check Period Details. Period Name, Period Type, Start Date and End Date are read only here. To change one, leave the wizard and select Edit on the period's card. Edit is available only while the period is not locked.
  2. Check Payment Date. It starts as the period's saved payment date. When none is saved, it starts as the date the employees' pay schedule suggests (the next pay day on or after the end date, moved back to a weekday when the schedule adjusts for weekends), or the end date when no schedule says. You can change it here.
  3. Choose the employees in Employees.
  4. Select Continue to Reconcile. This saves the payment date and opens Step 2.

Payment date and early payment

When the saved payment date is before the period ends, an Early Payment banner appears. The banner follows the payment date saved on the period, so it appears after Continue to Reconcile saves an earlier date, or when an earlier date was already saved. Hours after the payment date are projected. When you open Step 2 for a period that has not been calculated yet, the wizard fills in the projected days for the checked employees and calculates the period.

A projected day is built like this:

  • If the employee's schedule has fixed start and end times, the day uses them.
  • With no fixed times, the day uses the average clock-in and clock-out times the employee worked on the same weekday in the last calculated period.
  • Failing that, the day starts at 08:00 and is sized from the employee's expected weekly hours divided by the days a week the wizard fills in, plus the lunch hour. Those are the days the schedule rosters that week, whatever the country: a 40-hour employee on a Monday-to-Friday roster gets five days of 8 hours, 08:00 to 17:00 with the lunch, and one on a four-day roster gets four days of 10 hours. When the schedule lists no work days, it is six days in a Colombian rule group, and otherwise the expected hours divided by the schedule's hours a day. With no expected hours, the day runs from 08:00 to 17:00.
  • Every projected day includes a one-hour lunch. A day that the schedule says the employee does not work is skipped, and so is a day that already has punches. So is a day of approved leave of any kind, because leave is paid as leave and a projected shift there would be paid a second time as worked hours. A day before the hire date or after the termination date is skipped too. When the schedule lists no work days (a Custom schedule, or no schedule), projected days fall on the days the pay calculation expects: six days a week, Monday to Saturday, in a Colombian rule group, and otherwise the employee's Expected Weekly Hours divided by the schedule's hours a day (8 when there is no schedule), counted from Monday. Leave entries recorded in the Admin Hub count as leave here too.

On an employee's day in the Preview step, Auto-fill from Schedule fills that one day by the same rules. It is refused, with a message, on a day of approved leave, on a day the schedule does not roster or that is outside the employment, and when the employee's leave cannot be read. A day of approved leave with no real punch is drawn as Approved leave, not as a Projected card waiting to be filled. Use Add Punch to enter a shift on such a day by hand. The days are drawn the same way whichever way you reach an employee's days, including Investigate on an AI finding, and always from that employee's own leave.

A leave day that still holds a projected shift is drawn as Approved leave with Projected punches to clear. That happens when the shift was filled before the leave was approved, or when you add unpaid time or incapacity on a day that already had one. Select the day and use Clear Projected. The shift blocks Lock Period until you do. The calculation leaves the shift out on paid time off and, for an employee paid by the hour, on incapacity (in a Colombian rule group a paid Sick, Maternity or Paternity entry in the Admin Hub counts as incapacity). On unpaid time, on an Admin Hub entry that is not marked paid and, for an employee paid from salary, on incapacity, the projected shift is still paid as worked hours, so clear it in every case.

If the wizard cannot read what it needs while it fills the projected days (the period's punches, an employee's approved leave or the days you cleared on purpose), it fills no day rather than risk saving a shift twice or paying a leave day twice. A shift that cannot be saved leaves its day unfilled too. Every time Step 2 or Step 3 opens, the wizard checks the saved punches of each employee in the run and names the ones that have a scheduled day after the payment date with no projected shift. The names are in a yellow banner at the top of Step 2 and above the employee cards in Step 3. Because the banner comes from the saved punches and not from a message that was shown once, it is still there after you reload the page, lose the connection or open the period as another user. The first time the period is calculated, a message names the same employees; a message from the calculation itself (a failure, an overlap or a gap) replaces it, and the banner stays. Only the employees checked in Setup are named. Open the employee in Preview and select Auto-fill Projected Days; the banner drops the employee once every scheduled day holds a shift. Until then that row is calculated without the employee's remaining days.

If one of those reads fails the first time a Draft period is opened, the period is still calculated (so the later steps have figures) but the automatic fill is skipped, and it does not run again by itself once the period is calculated. The banners say so. Reloading the step only checks again; it never fills. Open each named employee in Preview and use Auto-fill Projected Days, which reads the punches and the days you cleared again when you press it and fills nothing, with a message, if either cannot be read. When a retry of the read works in Step 3, the banners are rebuilt from it.

Two things are kept apart from that banner. A day you cleared on purpose with Clear Projected is not counted as unfilled: the clear is recorded, the banner does not name the employee for it, and Auto-fill Projected Days leaves the day empty (its message says how many days it left alone). Auto-fill from Schedule on that one day is an explicit request and fills it. And an employee the wizard could not check is named in a second banner, Projected days could not be checked, whichever read failed (the punches, the approved leave or the cleared days): that is not a finding, only a notice that their scheduled days were not verified, so reload the step to check again (a reload only checks; it does not fill). Opening Step 2 or Step 3 makes these reads once for the whole run, not once per employee.

What that means for the run:

  • Projected hours are estimates, and they are paid as if they were real. You can review and export provisional figures that include them.
  • You cannot lock the period or make paystubs until the projected punches are cleared or replaced by real ones. Recalculating an employee replaces a projected day once real punches exist for it. See Payroll wizard: finalize and paystubs.
  • Nothing in the wizard compares the projection with the hours actually worked after the payment date. Compare what you paid early with the final figures and settle the difference in the next period.

Choose the employees

The list shows your active payroll employees with their contract type and currency. Everyone starts checked, and a count shows how many are selected.

  • Use the filter above the list (All Groups or one rule group) to narrow the list.
  • Select All checks every active employee and Clear unchecks everyone, whatever the filter shows.
  • An employee with a termination date shows Terminated and the date.
  • At least one employee must be checked before Continue to Reconcile works.

The checkboxes choose who is in this run. An employee left unchecked is not calculated, is not paid and gets no paystub, and the AI check in Reconcile does not look at them. Continue to Reconcile saves the choice on the period: if the period was already calculated, the calculation of anyone you unchecked is removed, and anyone you checked again is calculated, without touching the reviews on everyone else (this is refused once the period is locked, exported or paid, and Continue stops if the removal fails). Everyone is included until you uncheck them: a period that has never been through Setup includes every employee, and so does a later hire. Only active employees whose hire and termination dates overlap the period are calculated: an employee who left before the period started is not calculated, and one who left during the period is.

What blocks you from moving on

WhereThe Continue button waits until
SetupAt least one employee is checked.
Reconcile, Continue to PreviewNo leave request is pending, no punch issue is pending, every overtime row is marked reviewed, and any anomaly from an AI run is acknowledged.
Preview & Audit, Continue to SummaryEvery employee is marked reviewed, everyone checked in Setup has a calculation, no punch is unpaired (a clock-in with no clock-out, or the reverse), and no hourly employee has a day paid twice (a full day of paid leave and a full day of punches) that you have not resolved or kept with Keep both.
Summary & Export, Continue to FinalizeNothing. The button is always available.
FinalizeLock Period checks Steps 2 and 3 again with fresh data and is refused while a leave request or punch issue is pending, an employee is not marked reviewed, someone checked in Setup has no calculation, a punch is unpaired (or the punches could not be checked), a day is paid twice and not kept on purpose (or the leave and punches could not be checked), or projected punches remain. Generate Paystubs and Send Paystubs stay disabled until the period is locked.

The rail makes the same checks when you move forward, so jumping ahead with it is refused with a message until the step you are leaving is clear. The one deliberate exception is Investigate on an AI finding, which opens the employee's days in Step 3 from Step 2. Going back is never checked.

A checklist for one run

  1. Before you open the wizard, decide pending leave requests and clear punch exceptions on the timeclock supervisor screen. Anything still open is waiting for you in Step 2.
  2. Open the period's Wizard, read the rail and confirm which step you are on.
  3. Setup: confirm the payment date and the employees.
  4. Reconcile: resolve leave, punch issues and overtime. Run the AI check if you want it. Add manual adjustments.
  5. Preview & Audit: open the red and orange cards first. Correct punches where needed and mark each employee reviewed.
  6. Summary & Export: compare the totals with your accountant's. Export the provisional Excel file, or generate an access link for an external accountant.
  7. Finalize: review any edits made to the figures, lock the period and download the final report.
  8. Generate the paystubs, open a few to check them, then send them.
  9. If the run was an early payment, check the projected hours against the real ones in the next period.