Added improved status fields to Get All Tax Requirement States

The Get All Tax Requirement States endpoint now returns three new fields to give partners more granular visibility into a company's state tax setup progress:

• setup_status—The current status of the state tax setup, comprehensive of all fields necessary for state agency payments and filings. Unlike the existing setup_complete field, which only reflects onboarding requirements, setup_status gives a full picture of tax readiness.
• default_rates_applied—Whether the state is using system-assigned default SUI rates rather than employer-specific rates.
• ready_to_run_payroll—Whether the state tax setup is sufficiently complete for the company to run payroll. Functionally the same as setup_complete today, and informs onboarding step completion for state_setup.

The state_setup flow has also been updated to reflect the new setup_status.

🚧

Deprecation notice

setup_complete will be deprecated in an upcoming API version. Use setup_status and ready_to_run_payroll as replacements going forward.

Why this matters

These fields help to distinguish between company state tax setup that's sufficient to unblock payroll, and tax setup that's fully complete for downstream filings—such as employer-specific account information from state agencies that may arrive later and shouldn't necessarily block payroll processing.

Use ready_to_run_payroll to gate onboarding in your UI, and setup_status to surface more detailed setup progress to employers.

See the Get All Tax Requirement States API reference for full details.