Submit payroll

put https://api.gusto-demo.com/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.

You should poll to ensure that payroll is processed successfully, as async errors only occur after async processing is complete.

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

Responses

202

Accepted

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.gusto-demo.com/v1/companies/company_id/payrolls/payroll_id/submit \
3
     --header 'X-Gusto-API-Version: 2024-04-01' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'

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

application/json

422Unprocessable Entity