Fetch latest payroll readiness snapshot

GET/payroll/readiness

Returns the most recent payroll readiness assessment, indicating whether all prerequisites are satisfied for running payroll (e.g. all timesheets approved, no unresolved anomalies, statutory filings up to date). Use to gate the "Run Payroll" action in the UI.

Request

This endpoint takes no parameters and no request body.

Responses

200 Payroll readiness snapshot

Content type application/json, object · PayrollReadinessV1.

Field	Type	Required	Description
ready	boolean	No	True if all checks pass and payroll can be initiated.
checks	array of object	No	Individual readiness checks and their pass/fail state.
checks[].name	string	No	Machine-readable check name.
checks[].passed	boolean	No
checks[].message	string, nullable	No	Human-readable explanation when the check fails.
generated_at	string (date-time)	No

Example

{
  "ready": false,
  "checks": [
    {
      "name": "all_timesheets_approved",
      "passed": true
    },
    {
      "name": "no_open_anomalies",
      "passed": false,
      "message": "3 unresolved anomalies must be resolved before running payroll."
    },
    {
      "name": "bank_accounts_configured",
      "passed": true
    }
  ],
  "generated_at": "2026-04-08T09:00:00Z"
}

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/payroll/readiness" \
  -H "Accept: application/json"