Results are always up to date - no separate payroll run to trigger. Any new CaseChange (a salary change, a bonus, an absence, ...) recalculates immediately, retroactively if needed, back to the case change's own start date - the practical floor is the payroll's accounting start date.
Payroll Control
Payroll Control surfaces cases worth a human check before closing a period - missing calculation-relevant data, or values needing confirmation. Any unresolved one blocks closing the Payrun Period.
- Flagged company- or employee-level cases, grouped as their own tab in the payrun view - fetched via the
Pcluster, same mechanism as everywhere else - Configured per payroll, at the wage-type level - see Controlling triggers
- List all relevant case data for a payrun period. This helps to see immediately what happend since closing last payrun period. GET
/tenants/{orgId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/entries/{payrunPeriodEntryId}/relevantEventValues
| State | Meaning |
|---|---|
| Employed but without wage | still marked employed, nothing to calculate or pay this period |
| Ready to pay out | an open (unpaid) amount, not blocked by any unresolved controlling case |
Checking outputs before they're final
A period's documents (Payslip, AccountingDocument, ...) already exists before closing - the document endpoints below work anytime, if you want to show them (payroll control) to your user. See Outputs for the automated, webhook-driven way to fetch the complete final set.
API Endpoints
| What | Call |
|---|---|
| Get current data values | GET /tenants/{orgId}/payrolls/{payrollId}/cases/values/time |
| Get values relevant to a payrun period entry | GET /tenants/{orgId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/entries/{payrunPeriodEntryId}/relevantEventValues |
| List a payrun period's documents | GET /tenants/{orgId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/documents |
| Get a specific payrun period document | GET /tenants/{orgId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/documents/{documentId} |
| Query controlling data of the open payrun period | GET /tenants/{orgId}/payrolls/{payrollId}/payrunperiods/open/controlling |
Webhook management endpoints (create/list/update/delete a subscription) are on the Webhooks page.