GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference

Generate printable payroll checks (pdf)

post
https://api.gusto-demo.com/v1/payrolls//generated_documents/printable_payroll_checks

This endpoint initiates the generation of employee checks for the payroll specified by payroll_uuid. A generation status and corresponding request_uuid will be returned. Use the generated document GET endpoint with document_type: printable_payroll_checks and request_uuid to poll the check generation process and retrieve the generated check URL upon completion.

scope: generated_documents:write

Path Params
string
required

The UUID of the payroll

Body Params
string
enum
required

The type of check stock being printed. Check the "Types of check stock" section in this link for more info on check types

Allowed:
integer

The starting check number we will start generating checks from. Use to override the sequence that will be used to generate check numbers.

Headers
string
enum
Defaults to 2026-02-01

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Allowed:
Responses

404

Not Found

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

Updated 6 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago