feat(SDK-1161): add print payroll checks alert and modal

.reports/embedded-react-sdk.api.md

@@ -129,6 +129,7 @@ import { FunctionComponent } from 'react';
 import { Garnishment } from '@gusto/embedded-api/models/components/garnishment';
 import { GarnishmentChildSupport } from '@gusto/embedded-api/models/components/garnishmentchildsupport';
 import { GarnishmentType } from '@gusto/embedded-api/models/components/garnishment';
+import { GeneratedDocumentStatus } from '@gusto/embedded-api/models/components/generateddocument';
 import { HolidayPayPolicy } from '@gusto/embedded-api/models/components/holidaypaypolicy';
 import { HolidayPayPolicyEmployees } from '@gusto/embedded-api/models/components/holidaypaypolicy';
 import { HourlyCompensations } from '@gusto/embedded-api/models/components/payrollemployeecompensationstype';
@@ -247,6 +248,8 @@ import { PayScheduleShow } from '@gusto/embedded-api/models/components/payschedu
 import { PlaidStatus } from '@gusto/embedded-api/models/components/companybankaccount';
 import { PolicyType } from '@gusto/embedded-api/models/components/timeoffpolicy';
 import { PresidentsDay } from '@gusto/embedded-api/models/components/holidaypaypolicy';
+import { PrintablePayrollChecksBody } from '@gusto/embedded-api/models/components/printablepayrollchecksbody';
+import { PrintingFormat } from '@gusto/embedded-api/models/components/printablepayrollchecksbody';
 import { QueryClient } from '@tanstack/react-query';
 import { Questions } from '@gusto/embedded-api/models/components/employeestatetaxesrequest';
 import { RateType } from '@gusto/embedded-api/models/components/taxrequirementmetadata';
@@ -537,6 +540,7 @@ declare namespace APIModels {
         Garnishment,
         GarnishmentChildSupport,
         PaymentPeriod,
+        GeneratedDocumentStatus,
         ChristmasDay,
         ColumbusDay,
         HolidayPayPolicyEmployees,
@@ -656,6 +660,8 @@ declare namespace APIModels {
         PayScheduleFrequency_2 as PayScheduleFrequency,
         PaySchedulePreviewPayPeriod,
         PayScheduleShow,
+        PrintablePayrollChecksBody,
+        PrintingFormat,
         RecoveryCase,
         RecoveryCaseStatus,
         IdentityVerificationStatus,
@@ -1338,6 +1344,9 @@ export const componentEvents: {
     readonly PAYROLL_EXIT_FLOW: "payroll/saveAndExit";
     readonly RUN_PAYROLL_GROSS_UP_SELECTED: "runPayroll/grossUp/selected";
     readonly RUN_PAYROLL_GROSS_UP_CALCULATED: "runPayroll/grossUp/calculated";
+    readonly RUN_PAYROLL_PRINT_CHECKS_REQUESTED: "runPayroll/printChecks/requested";
+    readonly RUN_PAYROLL_PRINT_CHECKS_GENERATED: "runPayroll/printChecks/generated";
+    readonly RUN_PAYROLL_PRINT_CHECKS_FAILED: "runPayroll/printChecks/failed";
     readonly CONTRACTOR_SELF_ONBOARDING_START: "contractor/selfOnboarding/start";
     readonly CONTRACTOR_SELF_ONBOARDING_DONE: "contractor/selfOnboarding/done";
     readonly CONTRACTOR_SELF_ONBOARDING_CANCELLED: "contractor/selfOnboarding/cancelled";
@@ -4983,6 +4992,8 @@ export interface Resources {
     // (undocumented)
     'Payroll.PayrollReceipts': Translations.PayrollPayrollReceipts
     // (undocumented)
+    'Payroll.PrintChecksModal': Translations.PayrollPrintChecksModal
+    // (undocumented)
     'Payroll.RecoveryCasesList': Translations.PayrollRecoveryCasesList
     // (undocumented)
     'Payroll.RecoveryCasesResubmit': Translations.PayrollRecoveryCasesResubmit

docs/guides/endpoint-inventory.json

@@ -266,11 +266,21 @@
           "path": "/v1/companies/:companyUuid/payment_configs",
           "docsUrl": "https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/get-v1-company-payment-configs"
         },
+        {
+          "method": "GET",
+          "path": "/v1/generated_documents/:documentType/:requestUuid",
+          "docsUrl": "https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/get-v1-generated_documents-document_type-request_uuid"
+        },
         {
           "method": "GET",
           "path": "/v1/payrolls/:payrollId/employees/:employeeId/pay_stub",
           "docsUrl": "https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/get-v1-payrolls-payroll_uuid-employees-employee_uuid-pay_stub"
         },
+        {
+          "method": "POST",
+          "path": "/v1/payrolls/:payrollUuid/generated_documents/printable_payroll_checks",
+          "docsUrl": "https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/post-v1-payrolls-payroll_uuid-generated_documents-printable_payroll_checks"
+        },
         {
           "method": "GET",
           "path": "/v1/wire_in_requests/:wireInRequestUuid",
@@ -280,8 +290,11 @@
       "variables": [
         "companyId",
         "companyUuid",
+        "documentType",
         "employeeId",
         "payrollId",
+        "payrollUuid",
+        "requestUuid",
         "wireInRequestUuid"
       ]
     },

docs/guides/endpoint-reference.md

@@ -432,7 +432,9 @@ import inventory from '@gusto/embedded-react-sdk/endpoint-inventory.json'
 |  | PUT | [`/v1/companies/:companyId/payrolls/:payrollId/cancel`](https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/put-api-v1-companies-company_id-payrolls-payroll_id-cancel) |
 |  | PUT | [`/v1/companies/:companyId/payrolls/:payrollId/submit`](https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/put-v1-companies-company_id-payrolls-payroll_id-submit) |
 |  | GET | [`/v1/companies/:companyUuid/payment_configs`](https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/get-v1-company-payment-configs) |
+|  | GET | [`/v1/generated_documents/:documentType/:requestUuid`](https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/get-v1-generated_documents-document_type-request_uuid) |
 |  | GET | [`/v1/payrolls/:payrollId/employees/:employeeId/pay_stub`](https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/get-v1-payrolls-payroll_uuid-employees-employee_uuid-pay_stub) |
+|  | POST | [`/v1/payrolls/:payrollUuid/generated_documents/printable_payroll_checks`](https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/post-v1-payrolls-payroll_uuid-generated_documents-printable_payroll_checks) |
 |  | GET | [`/v1/wire_in_requests/:wireInRequestUuid`](https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/get-wire_in_requests-wire_in_request_uuid) |
 | **Payroll.PayrollFlow** | GET | [`/v1/companies/:companyId/payrolls`](https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/get-v1-companies-company_id-payrolls) |
 |  | GET | [`/v1/companies/:companyId/payrolls/:payrollId`](https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/get-v1-companies-company_id-payrolls-payroll_id) |

docs/reference/APIModels/index.md

@@ -3036,6 +3036,39 @@ Defined in: [gusto\_embedded\_v\_2026\_06\_15/src/models/components/garnishment.
 
 ***
 
+<a id="generateddocumentstatus"></a>
+
+## GeneratedDocumentStatus
+
+> `const` **GeneratedDocumentStatus**: `object`
+
+Defined in: [gusto\_embedded\_v\_2026\_06\_15/src/models/components/generateddocument.ts:15](https://github.com/Gusto/gusto-typescript-client/blob/gusto_embedded_v_2026_06_15/v0.1.0/gusto_embedded_v_2026_06_15/src/models/components/generateddocument.ts#L15)
+
+Current status of the Generated Document
+
+### Type Declaration
+
+| Name | Type |
+| ------ | ------ |
+| <a id="property-generateddocumentstatusfailed"></a> `Failed` | `"failed"` |
+| <a id="property-generateddocumentstatuspending"></a> `Pending` | `"pending"` |
+| <a id="property-generateddocumentstatusstarted"></a> `Started` | `"started"` |
+| <a id="property-generateddocumentstatussucceeded"></a> `Succeeded` | `"succeeded"` |
+
+***
+
+<a id="generateddocumentstatus-1"></a>
+
+## GeneratedDocumentStatus
+
+> **GeneratedDocumentStatus** = `ClosedEnum`\<*typeof* [`GeneratedDocumentStatus`](#generateddocumentstatus)\>
+
+Defined in: [gusto\_embedded\_v\_2026\_06\_15/src/models/components/generateddocument.ts:15](https://github.com/Gusto/gusto-typescript-client/blob/gusto_embedded_v_2026_06_15/v0.1.0/gusto_embedded_v_2026_06_15/src/models/components/generateddocument.ts#L15)
+
+Current status of the Generated Document
+
+***
+
 <a id="holidaypaypolicy"></a>
 
 ## HolidayPayPolicy
@@ -6028,6 +6061,56 @@ Defined in: [gusto\_embedded\_v\_2026\_06\_15/src/models/components/holidaypaypo
 
 ***
 
+<a id="printablepayrollchecksbody"></a>
+
+## PrintablePayrollChecksBody
+
+> **PrintablePayrollChecksBody** = `object`
+
+Defined in: [gusto\_embedded\_v\_2026\_06\_15/src/models/components/printablepayrollchecksbody.ts:24](https://github.com/Gusto/gusto-typescript-client/blob/gusto_embedded_v_2026_06_15/v0.1.0/gusto_embedded_v_2026_06_15/src/models/components/printablepayrollchecksbody.ts#L24)
+
+Request body for generating printable payroll checks.
+
+### Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="property-printablepayrollchecksbodyprintingformat"></a> `printingFormat` | [`PrintingFormat`](#printingformat-1) | The type of check stock being printed. Check the "Types of check stock" section in this [link](https://support.gusto.com/article/999877761000000/Pay-your-team-by-check) for more info on check types |
+| <a id="property-printablepayrollchecksbodystartingchecknumber"></a> `startingCheckNumber?` | `number` | The starting check number we will start generating checks from. Use to override the sequence that will be used to generate check numbers. |
+
+***
+
+<a id="printingformat"></a>
+
+## PrintingFormat
+
+> `const` **PrintingFormat**: `object`
+
+Defined in: [gusto\_embedded\_v\_2026\_06\_15/src/models/components/printablepayrollchecksbody.ts:12](https://github.com/Gusto/gusto-typescript-client/blob/gusto_embedded_v_2026_06_15/v0.1.0/gusto_embedded_v_2026_06_15/src/models/components/printablepayrollchecksbody.ts#L12)
+
+The type of check stock being printed. Check the "Types of check stock" section in this [link](https://support.gusto.com/article/999877761000000/Pay-your-team-by-check) for more info on check types
+
+### Type Declaration
+
+| Name | Type |
+| ------ | ------ |
+| <a id="property-printingformatbottom"></a> `Bottom` | `"bottom"` |
+| <a id="property-printingformattop"></a> `Top` | `"top"` |
+
+***
+
+<a id="printingformat-1"></a>
+
+## PrintingFormat
+
+> **PrintingFormat** = `ClosedEnum`\<*typeof* [`PrintingFormat`](#printingformat)\>
+
+Defined in: [gusto\_embedded\_v\_2026\_06\_15/src/models/components/printablepayrollchecksbody.ts:12](https://github.com/Gusto/gusto-typescript-client/blob/gusto_embedded_v_2026_06_15/v0.1.0/gusto_embedded_v_2026_06_15/src/models/components/printablepayrollchecksbody.ts#L12)
+
+The type of check stock being printed. Check the "Types of check stock" section in this [link](https://support.gusto.com/article/999877761000000/Pay-your-team-by-check) for more info on check types
+
+***
+
 <a id="questions"></a>
 
 ## Questions

docs/reference/Translations/index.md

@@ -5069,16 +5069,17 @@ Translation keys for the `Payroll.PayrollOverview` i18n namespace.
 | Property | Default value |
 | ------ | ------ |
 | <a id="property-payrollpayrolloverviewalerts"></a> `alerts` | |
-| `alerts.checkPaymentWarning_one` | `"You noted {{count}} employee who should be paid by check."` |
-| `alerts.checkPaymentWarning_other` | `"You noted {{count}} employees who should be paid by check."` |
-| `alerts.checkPaymentWarningDescription` | `"Employees with this payment method will need their checks delivered to them."` |
+| `alerts.checkPaymentWarning_one` | `"You noted {{count}} employee that should be paid by check."` |
+| `alerts.checkPaymentWarning_other` | `"You noted {{count}} employees that should be paid by check."` |
+| `alerts.checkPaymentWarningDescription` | `"Employees with this payment method will need their checks delivered to them. If you aren't using your own checks, you can view and print checks."` |
 | `alerts.directDepositDeadline` | `"To pay your employees with direct deposit by {{payDate}}, you'll need to run payroll by {{time}} on {{date}}"` |
 | `alerts.payrollNotCalculated` | `"Payroll is not calculated"` |
 | `alerts.payrollProcessedMessage` | `"{{amount}} will be debited on {{date}}. Make sure you have these funds available."` |
 | `alerts.payrollProcessedTitle` | `"Payroll submitted"` |
 | `alerts.payrollProcessingFailedCtaLabel` | `"Recalculate payroll"` |
 | `alerts.payrollProcessingFailedTitle` | `"There was an error submitting payroll"` |
 | `alerts.paystubPdfError` | `"There was an issue generating the paystub PDF. Please try again later."` |
+| `alerts.printChecksCta` | `"View and print checks"` |
 | `alerts.wireDetailsSubmittedMessage` | `"Once we receive the funds from your bank we'll pay your team on {{checkDate}}"` |
 | `alerts.wireDetailsSubmittedTitle` | `"Wire details submitted"` |
 | <a id="property-payrollpayrolloverviewbackcta"></a> `backCta` | `"Back"` |
@@ -5234,6 +5235,37 @@ Translation keys for the `Payroll.PayrollReceipts` i18n namespace.
 
 ***
 
+<a id="payrollprintchecksmodal"></a>
+
+### PayrollPrintChecksModal
+
+Translation keys for the `Payroll.PrintChecksModal` i18n namespace.
+
+#### Properties
+
+| Property | Default value |
+| ------ | ------ |
+| <a id="property-payrollprintchecksmodalblankstockdescription"></a> `blankStockDescription` | `"Use this check stock if you have blank check stock and need us to populate your company and bank information. The physical check will always be on the bottom of the check PDF."` |
+| <a id="property-payrollprintchecksmodalblankstocklabel"></a> `blankStockLabel` | `"Blank check stock"` |
+| <a id="property-payrollprintchecksmodalcancelcta"></a> `cancelCta` | `"Cancel"` |
+| <a id="property-payrollprintchecksmodalclosecta"></a> `closeCta` | `"Close"` |
+| <a id="property-payrollprintchecksmodalcustomstockdescription"></a> `customStockDescription` | `"Use this check stock if you have check stock that is pre-printed with your company and bank information. The physical check will appear on the top of the check PDF. Check numbers should already be pre-printed on the check stock you purchased."` |
+| <a id="property-payrollprintchecksmodalcustomstocklabel"></a> `customStockLabel` | `"Custom check stock"` |
+| <a id="property-payrollprintchecksmodalfailedtitle"></a> `failedTitle` | `"We couldn't generate your checks"` |
+| <a id="property-payrollprintchecksmodalmodaltitle"></a> `modalTitle` | `"Choose check stock"` |
+| <a id="property-payrollprintchecksmodalretrycta"></a> `retryCta` | `"Try again"` |
+| <a id="property-payrollprintchecksmodalstartingchecknumberdescription"></a> `startingCheckNumberDescription` | `"This will be the first check number, all other checks will follow sequentially."` |
+| <a id="property-payrollprintchecksmodalstartingchecknumberlabel"></a> `startingCheckNumberLabel` | `"Check number starts with"` |
+| <a id="property-payrollprintchecksmodalsubmitcta"></a> `submitCta` | `"View checks"` |
+| <a id="property-payrollprintchecksmodalsubmitctaloading"></a> `submitCtaLoading` | `"Generating..."` |
+| <a id="property-payrollprintchecksmodalsucceededdescription"></a> `succeededDescription` | `"They should have opened in a new tab."` |
+| <a id="property-payrollprintchecksmodalsucceededtitle"></a> `succeededTitle` | `"Your checks are ready"` |
+| <a id="property-payrollprintchecksmodalvalidations"></a> `validations` | |
+| `validations.startingCheckNumber` | `"Enter a valid check number"` |
+| <a id="property-payrollprintchecksmodalviewcheckscta"></a> `viewChecksCta` | `"View checks"` |
+
+***
+
 <a id="payrollrecoverycaseslist"></a>
 
 ### PayrollRecoveryCasesList
@@ -5606,6 +5638,7 @@ yields that namespace's keys. Backs i18next `t()` typing and `ResourceDictionary
 | <a id="property-resourcespayrollpayrolllist"></a> `Payroll.PayrollList` | [`PayrollPayrollList`](#payrollpayrolllist) |
 | <a id="property-resourcespayrollpayrolloverview"></a> `Payroll.PayrollOverview` | [`PayrollPayrollOverview`](#payrollpayrolloverview) |
 | <a id="property-resourcespayrollpayrollreceipts"></a> `Payroll.PayrollReceipts` | [`PayrollPayrollReceipts`](#payrollpayrollreceipts) |
+| <a id="property-resourcespayrollprintchecksmodal"></a> `Payroll.PrintChecksModal` | [`PayrollPrintChecksModal`](#payrollprintchecksmodal) |
 | <a id="property-resourcespayrollrecoverycaseslist"></a> `Payroll.RecoveryCasesList` | [`PayrollRecoveryCasesList`](#payrollrecoverycaseslist) |
 | <a id="property-resourcespayrollrecoverycasesresubmit"></a> `Payroll.RecoveryCasesResubmit` | [`PayrollRecoveryCasesResubmit`](#payrollrecoverycasesresubmit) |
 | <a id="property-resourcespayrolltransition"></a> `Payroll.Transition` | [`PayrollTransition`](#payrolltransition) |

docs/reference/events.md

@@ -327,6 +327,9 @@ import { componentEvents, EmployeeOnboarding } from '@gusto/embedded-react-sdk'
 | `RUN_PAYROLL_GROSS_UP_CALCULATED` | `"runPayroll/grossUp/calculated"` |
 | `RUN_PAYROLL_GROSS_UP_SELECTED` | `"runPayroll/grossUp/selected"` |
 | `RUN_PAYROLL_PDF_PAYSTUB_VIEWED` | `"runPayroll/pdfPaystub/viewed"` |
+| `RUN_PAYROLL_PRINT_CHECKS_FAILED` | `"runPayroll/printChecks/failed"` |
+| `RUN_PAYROLL_PRINT_CHECKS_GENERATED` | `"runPayroll/printChecks/generated"` |
+| `RUN_PAYROLL_PRINT_CHECKS_REQUESTED` | `"runPayroll/printChecks/requested"` |
 | `RUN_PAYROLL_PROCESSED` | `"runPayroll/processed"` |
 | `RUN_PAYROLL_PROCESSING_FAILED` | `"runPayroll/processingFailed"` |
 | `RUN_PAYROLL_RECEIPT_GET` | `"runPayroll/receipt/get"` |

docs/reference/payroll/blocks.md

@@ -665,6 +665,9 @@ _Inherits `children`, `className`, `defaultValues`, `FallbackComponent`, `Loader
 | `runPayroll/receipt/get` | User requested the payroll receipt | `{ payrollId }` |
 | `runPayroll/pdfPaystub/viewed` | User opened an employee's paystub PDF | `{ employeeId }` |
 | `payroll/wire/form/done` | Wire-in details were confirmed via the embedded wire form | Submit wire-in response |
+| `runPayroll/printChecks/requested` | User submitted the print-checks modal | Generate printable checks response |
+| `runPayroll/printChecks/generated` | Printable checks finished generating | Generated document |
+| `runPayroll/printChecks/failed` | The print-checks request was rejected or generation failed | Generated document, when generation had started |
 
 <br />
 
@@ -677,7 +680,9 @@ _Inherits `children`, `className`, `defaultValues`, `FallbackComponent`, `Loader
 | PUT | [`/v1/companies/:companyId/payrolls/:payrollId/cancel`](https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/put-api-v1-companies-company_id-payrolls-payroll_id-cancel) |
 | PUT | [`/v1/companies/:companyId/payrolls/:payrollId/submit`](https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/put-v1-companies-company_id-payrolls-payroll_id-submit) |
 | GET | [`/v1/companies/:companyUuid/payment_configs`](https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/get-v1-company-payment-configs) |
+| GET | [`/v1/generated_documents/:documentType/:requestUuid`](https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/get-v1-generated_documents-document_type-request_uuid) |
 | GET | [`/v1/payrolls/:payrollId/employees/:employeeId/pay_stub`](https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/get-v1-payrolls-payroll_uuid-employees-employee_uuid-pay_stub) |
+| POST | [`/v1/payrolls/:payrollUuid/generated_documents/printable_payroll_checks`](https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/post-v1-payrolls-payroll_uuid-generated_documents-printable_payroll_checks) |
 | GET | [`/v1/wire_in_requests/:wireInRequestUuid`](https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/get-wire_in_requests-wire_in_request_uuid) |
 
 ***