Represents a custom earning rate for an employee, which can be used while creating payroll items through the API.
For more details about how to use earning rates, refer to the Earnings Guide.
{
"id": "rte_aOSqW0QTKcE1iVU1C5",
"amount": "11.25",
"period": "hourly",
"employee": "emp_aslkj192j3laksdj",
"name": "Dishwasher Weekend Rate",
"active": true,
"metadata": {}
}
id | Unique identifier for the earning rate. |
|---|---|
amount | The amount to pay the employee per period. |
period | The time frame to spread the amount over. May be |
employee | ID of the employee that this earning rate relates to. |
name | Human-readable name identifying the earning rate. |
active | Flag to filter out earning rates that are no longer in use. |
metadata | Additional loosely structured information to associate with the earning rate. |