Payroll Changes are used to represent all inputs to payroll calculations, including regular compensation, salary increases or decreases, changes in bonuses, alterations to vacation or sick time, or changes to health insurance or retirement plans. Changes may also include modifications to payroll deductions, such as taxes or 401K contributions. Note that each worker’s payroll starts from a blank slate, so their initial compensation is also represetned as a Payroll Change, not any subsequent modifications to it. When computing payroll items for any given pay period, Plane will take into account all payroll changes that are effective in that period.

​
Examples

Here are a few examples of what would result in a payroll change being created in Plane:
  • Compensation is set for the first time This can result in two Payroll Change entries if proration is needed to adjust the amount for the first pay period.
  • Compensation is changed after worker’s first payroll This can result in two Payroll Change entries if proration is needed to adjust the amount if the change happens mid-period.
  • Expense report is approved and added to payroll
  • Recurring reimbursement is set up
  • Benefits or deductions must be added to payroll

​
Attributes

​
id
string
Unique identifier for the object, e.g. prc_cNqYX2J3s9bI2Aa.
​
status
string
Status of the payroll change. This can be one of draft, accepted, processed, or cancelled.
​
starts
date
Date this payroll change is effective from.
​
ends
date
Date this payroll change is effective until. Can be null, meaning the change is effective indefinitely.
​
type
string
Type of this payroll change. One of reimbursement, regular, benefit, bonus or commission.
​
amount
string
Amount of the payroll change.
​
currency
string
Currency of the payroll change.
​
frequency
string
The frequency of this payroll change, aligned with the worker’s pay period. One of once, monthly, twice_monthly, weekly, biweekly, twice_annual or annual.
​
rate
string
The hourly and raily rate calculated from the payroll change amount and reportable hours.
​
tax
string
Either pre or post. Affects whether or not the change should be apply before or after taxes.
​
hours
decimal
Hours reportable for this payroll change. Mostly used for prorated pay or certain types of bonuses. Optional.
​
description
string
An additional description of the payroll change, visible to the payroll admin.
​
recurring
boolean
If the change is recurring, it will be set to true. Otherwise false.
​
prorated
string
Whether or not this change was a result of a proration.
​
worker
object
Object representing the worker whose payroll this change is applicable to.
​
source
object
Reference to the source of this payroll change. For example, a salary change will reference the Worker Compensation object that resulted in this payroll change.