Plane keeps track of each workers changes in compensation over time to accurately calculate payroll and contract changes. This means each change is recorded as a separate object with its own lifecycle. When using Plane for payroll, accepted compensation changes are mapped to payroll changes and are included in payroll calculations.

​
Attributes

​
id
string
Unique identifier for the object, e.g. wec_cNqYX2J3s9bI2Aa.
​
status
string
Status of the compensation change. This can be one of pending, accepted, or cancelled. If a compensation requires contract changes to be effective or a manager approval, it will be created in a pending state. Otherwise defaults to accepted.
​
starts
date
Date this compensation is effective from.
​
ends
date
Date this compensation is effective until. Can be null, meaning the change is effective indefinitely.
​
current
boolean
Whether or not this compensation is current in the context of this employment.
​
amount
string
Amount of compensation offered.
​
currency
string
Currency of compensation offered.
​
unit
string
The time period this pay rate is denomiated in. E.g. hour, day, week, month, year or other.
​
unit_description
string
An optional description of the compensation unit. This is used in combination with other to indicate custom compensation units, e.g. 2,000 USD per Project.
​
frequency
string
The position’s pay frequency. E.g. weekly, biweekly, twice_monthly, monthly, thirteen_monthly (annual compensation divided by 13) and fourteen_monthly (annual compensation divided by 14),
​
stock
string
Description of stock-based compensation, e.g. 23,832 shares of the Company’s common stock
​
other
string
Optional details or incentives included in the compensation, e.g. You will be eligible to participate in the company’s sales commission plan with on target earnings of 150,000 USD.
​
reason
string
Explanation of why this compensation change was requested.
​
worker
object
A Worker object this compensation change is related to.