Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Payrolls

Generate printable payroll checks (pdf)

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

post/v1/payrolls/{payroll_uuid}/generated_documents/printable_payroll_checks

Path parameters

payroll_uuidstring required

The UUID of the payroll

Headers

X-Gusto-API-Version'2026-06-15'

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

Request body

printing_format'top' | 'bottom' required

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

starting_check_numberinteger

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

Response

Example response

payroll_uuidstring

A unique identifier of the payroll.

printing_formatstring

The format the checks will be printed.

starting_check_numberinteger nullable

The starting check number for the checks being printed.

request_uuidstring

A unique identifier of the Generated Document request

statusstring

Current status of the Generated Document