Features supported

• Support asynchronous invocation: NO
• Supports paging: NO
• Field selection: NO
• Supplemental data: NO

curl --request GET \
  --url 'https://api.fareclock.com/payclasses?id=123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json'

Query String

Name	Type	Required	Description
id	integer	No	Numeric ID of the pay class

{
  "results": [
    {
      "id": 500,
      "active": true,
      "name": "Regular Hourly",
      "payMode": "hourly",
      "enableNetPay": false,
      "salaryPaysOvertime": false,
      "salaryDeductsUndertime": false,
      "salaryWorkDaysRule": null,
      "salaryWorkDaysShiftLabel": null,
      "salaryHoursPerDay": null,
      "salaryRateAccuracy": 2,
      "salaryHourlyRateStrategy": null,
      "salaryDaysPerYear": null,
      "payPeriod": "week",
      "payPeriodStartsOn": 1,
      "payDateDaysAfter": 1,
      "overtimeByShift": false,
      "shiftOvertimeFixed": false,
      "overtimeByPayPeriod": false,
      "overtimeOnPaidBreaks": false,
      "dailyOvertimeAppliesFromWeek": false,
      "applyShiftOverlapTo": "start_punch",
      "weekStartsOn": 1,
      "regularPayCode": 10,
      "daily1Threshold": "08:00:00",
      "daily1PayCode": 11,
      "daily2Threshold": "12:00:00",
      "daily2PayCode": 12,
      "weekly1Threshold": "40:00:00",
      "weekly1PayCode": 11,
      "weekly2Threshold": null,
      "weekly2PayCode": null,
      "consecutiveDaysThreshold": null,
      "consecutiveDaysRolling": false,
      "consecutiveDaysRegularPayCode": null,
      "consecutiveDaysDaily1Threshold": null,
      "consecutiveDaysDaily1PayCode": null,
      "created": "2020-06-02T09:00:00.000Z",
      "modified": "2020-06-02T09:00:00.000Z"
    }
  ]
}

curl --request POST \
  --url 'https://api.fareclock.com/payclasses' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Regular Hourly",
  "active": true,
  "payMode": "hourly",
  "regularPayCode": 10,
  "daily1Threshold": "08:00:00",
  "daily1PayCode": 11,
  "weekly1Threshold": "40:00:00",
  "weekly1PayCode": 11
}'

{
  "name": "Regular Hourly",
  "active": true,
  "payMode": "hourly",
  "regularPayCode": 10,
  "daily1Threshold": "08:00:00",
  "daily1PayCode": 11,
  "weekly1Threshold": "40:00:00",
  "weekly1PayCode": 11
}

{
  "results": [
    {
      "id": 500,
      "active": true,
      "name": "Regular Hourly",
      "payMode": "hourly",
      "enableNetPay": false,
      "salaryPaysOvertime": false,
      "salaryDeductsUndertime": false,
      "salaryWorkDaysRule": null,
      "salaryWorkDaysShiftLabel": null,
      "salaryHoursPerDay": null,
      "salaryRateAccuracy": 2,
      "salaryHourlyRateStrategy": null,
      "salaryDaysPerYear": null,
      "payPeriod": "week",
      "payPeriodStartsOn": 1,
      "payDateDaysAfter": 1,
      "overtimeByShift": false,
      "shiftOvertimeFixed": false,
      "overtimeByPayPeriod": false,
      "overtimeOnPaidBreaks": false,
      "dailyOvertimeAppliesFromWeek": false,
      "applyShiftOverlapTo": "start_punch",
      "weekStartsOn": 1,
      "regularPayCode": 10,
      "daily1Threshold": "08:00:00",
      "daily1PayCode": 11,
      "daily2Threshold": "12:00:00",
      "daily2PayCode": 12,
      "weekly1Threshold": "40:00:00",
      "weekly1PayCode": 11,
      "weekly2Threshold": null,
      "weekly2PayCode": null,
      "consecutiveDaysThreshold": null,
      "consecutiveDaysRolling": false,
      "consecutiveDaysRegularPayCode": null,
      "consecutiveDaysDaily1Threshold": null,
      "consecutiveDaysDaily1PayCode": null,
      "created": "2020-06-02T09:00:00.000Z",
      "modified": "2020-06-02T09:00:00.000Z"
    }
  ]
}

curl --request GET \
  --url 'https://api.fareclock.com/payclasses/123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json'

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the pay class

{
  "results": [
    {
      "id": 500,
      "active": true,
      "name": "Regular Hourly",
      "payMode": "hourly",
      "enableNetPay": false,
      "salaryPaysOvertime": false,
      "salaryDeductsUndertime": false,
      "salaryWorkDaysRule": null,
      "salaryWorkDaysShiftLabel": null,
      "salaryHoursPerDay": null,
      "salaryRateAccuracy": 2,
      "salaryHourlyRateStrategy": null,
      "salaryDaysPerYear": null,
      "payPeriod": "week",
      "payPeriodStartsOn": 1,
      "payDateDaysAfter": 1,
      "overtimeByShift": false,
      "shiftOvertimeFixed": false,
      "overtimeByPayPeriod": false,
      "overtimeOnPaidBreaks": false,
      "dailyOvertimeAppliesFromWeek": false,
      "applyShiftOverlapTo": "start_punch",
      "weekStartsOn": 1,
      "regularPayCode": 10,
      "daily1Threshold": "08:00:00",
      "daily1PayCode": 11,
      "daily2Threshold": "12:00:00",
      "daily2PayCode": 12,
      "weekly1Threshold": "40:00:00",
      "weekly1PayCode": 11,
      "weekly2Threshold": null,
      "weekly2PayCode": null,
      "consecutiveDaysThreshold": null,
      "consecutiveDaysRolling": false,
      "consecutiveDaysRegularPayCode": null,
      "consecutiveDaysDaily1Threshold": null,
      "consecutiveDaysDaily1PayCode": null,
      "created": "2020-06-02T09:00:00.000Z",
      "modified": "2020-06-02T09:00:00.000Z"
    }
  ]
}

curl --request PUT \
  --url 'https://api.fareclock.com/payclasses/123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Regular Hourly",
  "active": true,
  "payMode": "hourly",
  "regularPayCode": 10,
  "daily1Threshold": "08:00:00",
  "daily1PayCode": 11,
  "weekly1Threshold": "40:00:00",
  "weekly1PayCode": 11
}'

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the pay class

{
  "name": "Regular Hourly",
  "active": true,
  "payMode": "hourly",
  "regularPayCode": 10,
  "daily1Threshold": "08:00:00",
  "daily1PayCode": 11,
  "weekly1Threshold": "40:00:00",
  "weekly1PayCode": 11
}

{
  "results": [
    {
      "id": 500,
      "active": true,
      "name": "Regular Hourly",
      "payMode": "hourly",
      "enableNetPay": false,
      "salaryPaysOvertime": false,
      "salaryDeductsUndertime": false,
      "salaryWorkDaysRule": null,
      "salaryWorkDaysShiftLabel": null,
      "salaryHoursPerDay": null,
      "salaryRateAccuracy": 2,
      "salaryHourlyRateStrategy": null,
      "salaryDaysPerYear": null,
      "payPeriod": "week",
      "payPeriodStartsOn": 1,
      "payDateDaysAfter": 1,
      "overtimeByShift": false,
      "shiftOvertimeFixed": false,
      "overtimeByPayPeriod": false,
      "overtimeOnPaidBreaks": false,
      "dailyOvertimeAppliesFromWeek": false,
      "applyShiftOverlapTo": "start_punch",
      "weekStartsOn": 1,
      "regularPayCode": 10,
      "daily1Threshold": "08:00:00",
      "daily1PayCode": 11,
      "daily2Threshold": "12:00:00",
      "daily2PayCode": 12,
      "weekly1Threshold": "40:00:00",
      "weekly1PayCode": 11,
      "weekly2Threshold": null,
      "weekly2PayCode": null,
      "consecutiveDaysThreshold": null,
      "consecutiveDaysRolling": false,
      "consecutiveDaysRegularPayCode": null,
      "consecutiveDaysDaily1Threshold": null,
      "consecutiveDaysDaily1PayCode": null,
      "created": "2020-06-02T09:00:00.000Z",
      "modified": "2020-06-02T09:00:00.000Z"
    }
  ]
}