v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

Get an earning rate

get/earning_rates/{earning_rate}

Path parameters

earning_ratestring required

ID for the earning rate object

Response

200

idstring

amountstring

periodstring

May be hourly, annually, or piece

employeestring

companystring

ID of the company that this earning rate relates to (via the employee).

namestring

workweek_hoursnumber float

activeboolean

metadataobject

Example response

{
  "id": "rte_aOSqW0QTKcE1iVU1C5",
  "amount": "50000.00",
  "period": "annually",
  "employee": "emp_aslkj192j3laksdj",
  "company": "com_omSihPyKgr68wxFQ0xTn",
  "name": "Dishwasher Weekend Rate",
  "workweek_hours": 40,
  "active": true,
  "metadata": {}
}