Skip to main content

Create and review Payroll Runs

A Payroll Run collects each employee's salary, compensations, time-based pay lines, and deductions for one pay period. This guide covers creating a Payroll Run, reviewing it, automating recurring runs, adding stages, and reversing a completed run.

Who can use this?

HR Admins and payroll teams in the flair HR app in Salesforce. Salesforce Admin access is required to add Payroll Run stages or use Developer Console.

Before you begin​

Create a Payroll Run​

Create a Payroll Run manually when you need a one-off period. For recurring periods, configure automatic Payroll Run creation on the Payroll Territory.

  1. In the flair HR app, open Payroll Runs.
  2. Click New.
  3. Enter Name, Start Date, and End Date.
  4. Select Payroll Territory.
  5. Click Save.
  6. Click Add Employees, then select employees from the territory.

New Payroll Run form in Salesforce

Payroll Runs use these default stages:

StageWhat it means
DraftYou can add or remove employees and change data.
Pending ApprovalThe run is ready for review and approval.
SubmittedThe run is approved, submitted, and locked for processing.
CompletedPayroll processing is finished when the territory's completion policy allows it.

Review a Payroll Run​

Check each employee's pay before you move the run on. The Payroll Run page shows every employee in the run, with their pay lines, changes, and a review status.

  1. In Payroll Runs, open the run.
  2. Check Payroll Health in the right sidebar. It counts line items that need attention, pending line items, pending absences, and pending time entries for the run, and shows Good when there are none. The card is hidden once the run is Completed.
  3. On the Overview tab, use the All Employees filter to narrow the list to New Hires, Leaving Employees, With Changes, With comments, or With notes. Each option appears only when at least one employee in the run matches it. Use All Payroll Statuses to filter by review status.
  4. Click an employee's name to open their panel. Use the arrows in the panel header to move to the previous or next employee.
  5. Review the employee's pay on the panel's Overview tab, and check the Comments, Time Entries, Changes History, and Files tabs as needed.
  6. In Payroll Status at the bottom of the panel, set the status to Reviewed or Needs Attention.
  7. To update several employees at once, select them in the list, click Mark as, and select Reviewed or Needs Attention.
  8. When the review is done, click Mark as followed by the next stage name in the path at the top of the page. Moving to Completed or to a locked stage asks you to confirm first.

A Draft Payroll Run with the employee list, the All Employees filter open, and the Payroll Health card

Each employee's review status is Pending, Reviewed, or Needs Attention. Payroll Health counts Pending employees as pending line items and Needs Attention employees as line items that require attention. Whether completion also requires every employee to be Reviewed depends on the territory's Completion Policy; see Configure automatic Payroll Runs.

The list's other controls:

ControlWhat it does
Switch to Changes ViewReplaces the pay columns with each employee's count of data changes and absences in the run.
Show detailsExpands each employee into their individual pay lines.
Data Changes, Absences tabsList the run's employee data changes and absences across all employees.
Add EmployeesAdds employees from the Payroll Territory. Available until the run is locked or completed.

Add or correct a pay line​

Use the employee panel to add a one-off amount to this run only, such as a bonus or a correction.

  1. Open the employee's panel on the Overview tab.
  2. Under Incomes, click Add new line. A new row appears under Other compensations.
  3. Enter a name for the line.
  4. Optional: Select a Pay Type.
  5. Keep the multiplier at 1 or change it, then enter the amount. A negative amount makes the line a deduction.
  6. Click Save. The employee's totals update.

To change an existing other compensation or deduction, click its row, edit the values, and click Save. When a line comes from an Employee One-Time Compensation, saving a new amount also updates that compensation record. Pay lines can't be added or edited once the run is locked or completed.

Configure automatic Payroll Runs​

Configure recurring Payroll Runs for each Payroll Territory. flair supports weekly, biweekly, and monthly periods, and skips a period when an overlapping Payroll Run already exists.

  1. Open a Payroll Territory, then select Automation.
  2. In Recurrence, select Weekly, Every two weeks, or Monthly.
  3. In Next start date, select the start date of the first period to generate.
  4. In Create in advance (days), enter how many days before the period starts flair should create the run. Enter 0 to create it on the start date.
  5. Optional: In Run name pattern, enter a name pattern. Leave it blank to use the payroll period.
  6. In Completion Policy, select Take no action, Mark all as reviewed, or Require all to be reviewed.
  7. Click Save. flair previews upcoming periods and creates due Payroll Runs automatically.

The Automation tab of a Payroll Territory with Recurrence set to Monthly, a Next start date, Create in advance (days), Run name pattern, Completion Policy, and the Upcoming payroll runs preview

The scheduler checks enabled territories daily. If a period is overdue, flair catches up within the supported window and advances the next period. Existing overlapping Payroll Runs are not duplicated.

The completion policy controls what happens to Employee Payroll Runs when you move a Payroll Run to Completed:

PolicyResult
Take no actionTheir statuses stay unchanged.
Mark all as reviewedflair marks them as reviewed.
Require all to be reviewedflair blocks completion until every one is reviewed.

Add a Payroll Run stage​

  1. In Salesforce Setup, open Object Manager.
  2. Search for Payroll Run, then open Payroll Run.
  3. Open Fields & Relationships → State.
  4. Under Values, click New.
  5. Enter the stage name, then click Save.
  6. Optional: Click Reorder, then use Up, Down, Top, or Bottom to position the stage.
  7. To lock data in this stage, click Edit next to the value.
  8. Add _locked to the value's API name, then click Save.

The Completed stage is locked by default. For API deductions, use a locked stage named Submitted.

Locked State value for a Payroll Run

Reverse a completed Payroll Run​

Clearing flair__Completed_At2__c returns a completed run to Pending Approval.

Use Salesforce Inspector​

  1. Install the Salesforce Inspector browser extension.
  2. Open the Payroll Run.
  3. From Salesforce Inspector, click Show All Data.
  4. Find Completed At (flair__Completed_At2__c).
  5. Clear the field value, then click Save.
  6. Return to the Payroll Run. The run can move back to Pending Approval.

Completed At value cleared with Salesforce Inspector

Use Developer Console​

  1. From Salesforce settings, open Developer Console.
  2. Open Query Editor.
  3. Enter SELECT Id, Name, flair__Completed_At2__c FROM flair__Payroll_Run__c.
  4. Click Execute.
  5. Find the Payroll Run and clear its Completed At value.
  6. Save the change, then close Developer Console.
  7. Return to the Payroll Run. The run can move back to Pending Approval.

Payroll Run returned to Pending Approval