Skip to main content

PayrollRunReportsController

Per-run disbursement tracking and the run's frozen report archive.

Base path/api/payroll/{payrollId}
ModulePayroll
Endpoints5
OpenAPI tagPayroll
Sourcebackend/src/main/java/com/motorph/payroll/controller/PayrollRunReportsController.java

Endpoints​

MethodPathRequiresHandler
PATCH/api/payroll/{payrollId}/paymentspayroll.manageupdatePayments()
GET/api/payroll/{payrollId}/report-archivepayroll.dashboard.view or payroll.manage or payroll.approvearchive()
GET/api/payroll/{payrollId}/report-archive/statuspayroll.dashboard.view or payroll.manage or payroll.approvearchiveStatus()
POST/api/payroll/{payrollId}/report-archive/generatepayroll.managegenerate()
GET/api/payroll/{payrollId}/report-archive/{archiveId}payroll.dashboard.view or payroll.manage or payroll.approvedownload()

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​

EntityTableTenant-scoped
PayrollpayrollYes
PayrollPayoutBatchpayroll_payout_batchYes
PayrollPayoutBatchLinepayroll_payout_batch_lineYes
PayslippayslipYes
PayslipHistorypayslip_historyYes

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/.