A Payrun Period is the recurring billing period (typically a month) a payroll calculates.
- While open: accepts case changes and recalculates results automatically, including retroactively - there's no separate payroll run. See Results for how far back that recalculation reaches
- Payouts: can happen any time while open
- To close: requires Payroll Control clear and WageType-Accounting-Allocation complete - plus explicit confirmation to carry over any open (unpaid) amount, never silently
- After closing: Outputs generate, followed later by finalization (Swissdec submission) - reopening a closed period is ⚠ permanent not possible
- Default view: the currently open period - there's always exactly one per payroll
- Closed periods: still visible via the payrun periods list - entries/results plus generated documents (payslips, posting document, etc.) through the period's Documents view
Closing a Period
Closing isn't a single action - a few checks gate it, and closing itself has consequences.
Everything to consider when closing a Payrun Period.
API Endpoints
| What | Call |
|---|---|
| List closed payrun periods | GET /tenants/{orgId}/payrolls/{payrollId}/payrunperiods |
| Get the currently open payrun period | GET /tenants/{orgId}/payrolls/{payrollId}/payrunperiods (filtered by status) |
| Get a specific payrun period | GET /tenants/{orgId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId} |
| Close a payrun period | POST /tenants/{orgId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/close |