Payroll Runs
Manage the payroll processing lifecycle from run creation through approval and payment.
Fetch latest payroll readiness snapshot
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.
List payroll runs
Returns all payroll runs for the tenant, ordered by most recently created. Use to populate the payroll dashboard and select a run for viewing, approving, or marking as paid.
Create payroll run
Creates a new payroll run for the specified pay period. After creation, the run enters draft status while calculations are computed. Trigger the approval workflow once the run is verified and anomalies are resolved.
Get payroll run
Returns full detail for a specific payroll run including totals, employee count, and approval history.
Delete payroll run
Permanently removes a payroll run. Only draft runs with no associated payment batches can be deleted.
Approve payroll run
Submits the payroll run for approval, triggering any configured multi-level approval workflow. Once all required approvals are granted, the run transitions to 'approved' status and payment batches can be generated.
Mark payroll run as paid
Marks an approved payroll run as fully paid, indicating all payment batches have been processed and disbursed. This is a terminal state — once marked paid, the run cannot be modified.
Approve payroll approval step
Grants an individual approval within a multi-level payroll approval workflow. Each step must be approved before the run advances to the next.
Reject payroll approval step
Rejects an individual approval step, returning the payroll run to draft status for correction.