PayrollRunReportsController
Per-run disbursement tracking and the run's frozen report archive.
| Base path | /api/payroll/{payrollId} |
| Module | Payroll |
| Endpoints | 5 |
| OpenAPI tag | Payroll |
| Source | backend/src/main/java/com/motorph/payroll/controller/PayrollRunReportsController.java |
Endpoints
| Method | Path | Requires | Handler |
|---|---|---|---|
PATCH | /api/payroll/{payrollId}/payments | payroll.manage | updatePayments() |
GET | /api/payroll/{payrollId}/report-archive | payroll.dashboard.view or payroll.manage or payroll.approve | archive() |
GET | /api/payroll/{payrollId}/report-archive/status | payroll.dashboard.view or payroll.manage or payroll.approve | archiveStatus() |
POST | /api/payroll/{payrollId}/report-archive/generate | payroll.manage | generate() |
GET | /api/payroll/{payrollId}/report-archive/{archiveId} | payroll.dashboard.view or payroll.manage or payroll.approve | download() |
Notes
GET /api/payroll/{payrollId}/report-archive/status— One state for the pack (generating, ready, incomplete, failed, not generated).POST /api/payroll/{payrollId}/report-archive/generate— Generates whatever is missing or failed (also the backfill for runs processed earlier).
Call chain
Dependencies
Constructor-injected by Lombok's @RequiredArgsConstructor: PayrollPaymentService, ReportArchiveService.
Tables reached
| Entity | Table | Tenant-scoped |
|---|---|---|
| Payroll | payroll | Yes |
| PayrollPayoutBatch | payroll_payout_batch | Yes |
| PayrollPayoutBatchLine | payroll_payout_batch_line | Yes |
| Payslip | payslip | Yes |
| PayslipHistory | payslip_history | Yes |
Generated page
This page is rebuilt from the source on every docs build by docs-site/scripts/gen-code-wiki.mjs. Editing it has no effect — change the code, or, if what you want to say is prose, write it in docs/.