GuidesReferenceChangelogAPI Versioning

The earning rate object

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
string		Unique identifier for the earning rate.
amount
string		The amount to pay the employee per period.
period
string		The time frame to spread the amount over. May be hourly, annually, or piece.
employee
string		ID of the employee that this earning rate relates to.
name
string		Human-readable name identifying the earning rate.
active
boolean		Flag to filter out earning rates that are no longer in use.
metadata
object		Additional loosely structured information to associate with the earning rate.