> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plane.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Compensation

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](/reference/payroll-changes/object)
and are included in payroll calculations.

### Attributes

<ResponseField name="id" type="string">
  Unique identifier for the object, e.g. `wec_cNqYX2J3s9bI2Aa`.
</ResponseField>

<ResponseField name="worker" type="string">
  The ID of the worker this compensation is associated with.
</ResponseField>

<ResponseField name="type" type="string">
  The type of earning, e.g. `regular`, `bonus`, `commission`.
</ResponseField>

<ResponseField name="reason" type="string | null">
  The reason for this compensation change, if provided.
</ResponseField>

<ResponseField name="amount" type="string">
  Amount of compensation offered.
</ResponseField>

<ResponseField name="currency" type="string">
  Currency of compensation offered.
</ResponseField>

<ResponseField name="unit" type="string">
  The time period this pay rate is denomiated in. E.g. `hour`, `day`, `week`, `month`, `year` or
  `other`.
</ResponseField>

<ResponseField name="frequency" type="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),
</ResponseField>

<ResponseField name="stock" type="string">
  Description of stock-based compensation, e.g. `23,832 shares of the Company’s common stock`
</ResponseField>

<ResponseField name="other" type="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`.
</ResponseField>

<ResponseField name="starts" type="string">
  The date when this compensation takes effect, formatted as `YYYY-MM-DD`. Falls back to the
  worker's start date if not specified on the compensation.
</ResponseField>

<ResponseField name="ends" type="string">
  The date when this compensation ends, formatted as `YYYY-MM-DD`. Falls back to the worker's end
  date if not specified on the compensation.
</ResponseField>

<ResponseField name="created" type="string">
  Timestamp of when the compensation was created.
</ResponseField>