Preview Overtime Checks

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

Generate a job_id to Preview Payroll by utilizing corresponding employeeCheckIDs. This Preview Payroll will return an updated check object if there are Overtime eligible shift hours.

Note: The Overtime eligible shifts will be calculated at the Compliance Mandated Rate.

This job_id will then be used in the GET Preview request. This endpoint can only preview pending checks.

Returns

attribute type description
success boolean Response status
data object job_id for Preview Payroll
errors array Contains a list of error objects which consists of:
message: Error message
code: Error code as described in Error codes

companyID

string

required

The ID of the Company

checks

array of strings

required

Array of employeeCheckIDs

checks*
ADD string

``200 200

``400 400

Updated 7 months ago


Shell


xxxxxxxxxx

{

"companyID": "h0c56cc41q1040ac8a3322342a3bbb462",

"checks": [
        "c614c5ff59d7cc22eae4c9442f315",
        "22cdbd897e3345a55c3fa22b1712be52",
        "3942348bd453410485cd783ef1ce8391"
    ]
}

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200 - Result400 - Result

Updated7 months ago