Create a compensation
Compensations
Create a compensation
Creates a compensation for a worker, such as a commission, bonus, or a new regular pay rate.
POST
Create a compensation
Use this endpoint to record a one-time earning — for example a commission, bonus,
or other imputed income — or a new regular pay rate for a worker. Accepted
compensations flow into payroll changes and
are included in payroll calculations. One-time earnings for workers employed
through an employer of record are reviewed by Plane before they are accepted.
Parameters
string
required
The ID of the worker this compensation is for.
string
required
The type of earning. One of
regular, commission, bonus, overtime,
allowance, severance, retropay, other_imputed, or pto_payout.
regular records a new pay rate that takes effect on the starts date;
every other type records a one-time earning.string
required
The amount of the compensation, as a decimal string, e.g.
2500.00. For
regular compensation this is the pay rate per unit; for one-time earnings
it is the total amount to pay.string
required
Three-letter ISO currency code of the compensation, e.g.
USD.string
The time period the pay rate is denominated in, one of
year, month,
week, day, hour, fixed, or other. Required for regular
compensation. One-time earnings default to fixed.string
The date this compensation starts, formatted as
YYYY-MM-DD. Defaults to
today. A regular compensation replaces the worker’s pay rate from this
date; a one-time earning is paid in the pay period containing this date, so
for workers on a pay schedule the date must fall within a scheduled pay
period. The response’s starts reflects the resolved pay period placement.string
An optional reason for the compensation, shown alongside the resulting
payroll change, e.g.
Q3 sales commission.Returns
Returns the new compensation on success. Thestatus is accepted when the compensation flows straight into payroll, or
pending when it needs review first. Retrying an identical regular create
returns the existing compensation instead of recording a duplicate change.