Validate an external payroll
Changed onRuns the checks that approving an external payroll runs, without approving the payroll. Use it to find problems with a draft external payroll before you approve it. It does not approve the payroll or change its status.
Validate doesn't recalculate the payroll. Use it to check for errors quickly while you fix a payroll, and use preview to review calculated amounts before you approve.
If every check passes, the response is the external payroll object. If any check fails, the response is a 400 validation_error, with one entry in input_errors for each problem found.
Validate does not run the negative quarter-to-date tax check. That check runs only when you approve, so an approve request can still fail after a validate request succeeds.
Request
- Base URLhttps://sandbox.checkhq.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
ID of the external payroll to validate.
Response
200
Changes
- info
endpoint added
- info