Tasks are actions you need to complete manually with a third party - e.g. notifying an insurance company of a change.
- Created by: mostly case changes, but also wage-type calculations or automated reports
- Separate from: missing company/employee data (see Case Data) and Payroll Control - those don't create Tasks, even though they surface alongside them in the UI. Tasks currently don't block closing a Payrun Period either, unlike unresolved missing data and controlling cases. That's planned to change in the coming months, so every task will have to at least be reviewed before a period can close
- Creating one manually: POST
/tenants/{orgId}/payrolls/{payrollId}/tasks- not just automatically - Closed tasks: an Open/Completed filter; completed tasks stay visible with their completion date
- Deleting a task: supported by the API, but not exposed in the standard frontend - only via direct API call
API Endpoints
| What | Call |
|---|---|
| List tasks | GET /tenants/{orgId}/payrolls/{payrollId}/tasks |
| Get a task | GET /tenants/{orgId}/payrolls/{payrollId}/tasks/{taskId} |
| Create a task | POST /tenants/{orgId}/payrolls/{payrollId}/tasks |
| Update a task (accept, complete, comment) | PUT /tenants/{orgId}/payrolls/{payrollId}/tasks/{taskId} |
| Run a task's action (e.g. generate files) | POST /tenants/{orgId}/payrolls/{payrollId}/tasks/{taskId}:runAction |
| Get a task's attachment | GET /tenants/{orgId}/payrolls/{payrollId}/tasks/{taskId}/attachments/{attachmentId} |