Represents a custom earning code for a company, which can be used while creating payroll items through the API.
For more details about how to use earning codes, refer to the Earnings Guide.
{
"id": "erc_pz0fmJeuVcaPb99N0nw9",
"company": "com_omSihPyKgr68wxFQ0xTn",
"type": "hourly",
"name": "Dishwasher",
"metadata": {}
}
| Attribute | Description |
|---|---|
| id string | Unique identifier for the earning code. |
| company string | ID of the company that this earning code relates to. |
| name string | Human-readable name identifying the earning code. This is what will appear on employee paystubs. |
| type string | The Check earning type that this earning code relates to. |
| active boolean | Used to distinguish between codes used only for loading historical data (inactive) and those that you support on an ongoing basis (active). |
| metadata object | Additional loosely structured information to associate with the earning code. |
Immutable earning codes
Earning codes are immutable in Check's system, which means they cannot be updated once created. This is done primarily to prevent against the taxability of earnings potentially being changed after they have already been paid out to an employee.