Generate payroll printable checks (pdf)

POST {{baseUrl}}/v1/payrolls/:payroll_id/generated_documents/printable_payroll_checks

This endpoint initiates the generation of employee checks for the payroll specified by payrollid. A generation status and corresponding generated document requestuuid will be returned. Use the generated document GET endpoint with documenttype: `printablepayrollchecks` and requestuuid to poll the check generation process and retrieve the generated check URL upon completion.

scope: generated_documents:write

Request Body

{"printing_format"=>"<string>", "starting_check_number"=>"<integer>"}

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

RESPONSES

status: OK

{&quot;payroll_uuid&quot;:&quot;a83d0bd8-7d20-43b9-834c-6d514ef6cb20&quot;,&quot;printing_format&quot;:&quot;top&quot;,&quot;starting_check_number&quot;:&quot;10&quot;,&quot;request_uuid&quot;:&quot;p83d0ca8-7d41-42a9-834y-7d218ef6cb20&quot;,&quot;status&quot;:&quot;pending&quot;}