Skip to main content
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.
worker
string
The ID of the worker this compensation is associated with.
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.
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.
created
string
Timestamp of when the compensation was created.