Submit payroll

PUT {{baseUrl}}/v1/companies/:company_id/payrolls/:payroll_id/submit

Submits an unprocessed payroll to be calculated and run. This submission is asynchronous and a successful request responds with a 202 HTTP status. Upon success, transitions the payroll to the processed state.

If the company is blocked from running payroll due to issues like incomplete setup, missing information or other compliance issues, the response will be 422 Unprocessable Entity with a categorization of the blockers as described in the error responses.

scope: payrolls:run

Request Body

{"submission_blockers"=>[{"blocker_type"=>"<string>", "selected_option"=>"<string>"}, {"blocker_type"=>"<string>", "selected_option"=>"<string>"}]}

HEADERS

KeyDatatypeRequiredDescription
X-Gusto-API-VersionstringDetermines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Content-Typestring
Acceptstring