Skip to main content

Payroll

Controllers20
Endpoints90
Tables33
Screens27
API reference/api/ — group payroll
OpenAPI spec/openapi/payroll.json

URL prefixes​

Endpoints belong to this module by URL, exactly as the OpenAPI group defines it in backend/src/main/java/com/motorph/payroll/config/OpenApiConfiguration.java.

  • /api/payroll/**
  • /api/payroll-changes/**
  • /api/payroll-settings/**
  • /api/payroll-settings-changes/**
  • /api/payroll-transactions/**
  • /api/payslips/**
  • /api/payslip-history/**
  • /api/payslip-templates/**
  • /api/payslip-template-settings/**
  • /api/bonuses/**
  • /api/employee-deductions/**
  • /api/deduction-types/**
  • /api/de-minimis-benefit-types/**
  • /api/reimbursement-requests/**
  • /api/reimbursement-transactions/**
  • /api/payroll-reports/**
  • /api/onboarding/payroll/**
  • /api/public/payroll-simulator/**

Controllers​

ControllerBase pathEndpointsGETPOSTPUTPATCHDELETE
BonusController/api/bonuses6311—1
DeductionTypeController/api/deduction-types4111—1
DeMinimisBenefitTypeController/api/de-minimis-benefit-types4111—1
EmployeeDeductionController/api/employee-deductions5211—1
PayoutBatchController/api/payroll743———
PayrollChangesController/api/payroll-changes11————
PayrollController/api/payroll1043—21
PayrollOnboardingController/api/onboarding/payroll11————
PayrollReportController/api/payroll-reports44————
PayrollRunReportsController/api/payroll/{payrollId}531—1—
PayrollSettingsChangesController/api/payroll-settings-changes11————
PayrollSettingsController/api/payroll-settings64—2——
PayrollTransactionController/api/payroll-transactions6311—1
PayslipController/api/payslips77————
PayslipHistoryController/api/payslip-history11————
PayslipTemplateController/api/payslip-templates4111—1
PayslipTemplateSettingsController/api/payslip-template-settings21—1——
PublicPayrollSimulatorController/api/public/payroll-simulator312———
ReimbursementRequestController/api/reimbursement-requests731111
ReimbursementTransactionController/api/reimbursement-transactions6311—1

Across the module: 49 GET, 17 POST, 11 PUT, 4 PATCH, 9 DELETE.

Tables​

Everything this module's controllers can reach through a repository, including through a shared service — so this is the upper bound of what the module touches, not the set of tables it owns. A table appearing under two modules means two modules can read it.

EntityTableColumnsTenant-scoped
Bonusbonus8Yes
CompanyProfilecompany_profile22Yes
DeductionTypededuction_types10Yes
DeMinimisBenefitTypede_minimis_benefit_types12Yes
Employeeemployee39Yes
EmployeeDeductionemployee_deductions12Yes
LeaveRequestleave_request8Yes
OvertimeRequestovertime_request6Yes
PagibigContributionRatepagibig_contribution_rates7—
Payrollpayroll14Yes
PayrollApprovalpayroll_approval3Yes
PayrollChangepayroll_changes6Yes
PayrollPayoutBatchpayroll_payout_batch14Yes
PayrollPayoutBatchLinepayroll_payout_batch_line3Yes
PayrollSettingspayroll_settings76Yes
PayrollSettingsChangepayroll_settings_changes6Yes
PayrollTransactionpayroll_transactions5Yes
Payslippayslip60Yes
PayslipDeductionItempayslip_deduction_items4Yes
PayslipHistorypayslip_history8Yes
PayslipTemplatepayslip_template9Yes
PayslipTemplateSettingspayslip_template_settings7Yes
PhHolidayph_holidays10Yes
PhilhealthContributionRatephilhealth_contribution_rates7—
RecognitionAwardrecognition_award8Yes
ReimbursementRequestreimbursement_requests7Yes
ReimbursementTransactionreimbursement_transactions6Yes
SssContributionRatesss_contribution_rates12—
Timesheettimesheet8Yes
Userusers11—
UserLoguser_log5—
WithholdingTaxBracketwithholding_tax_brackets8—
WorkSuspensionwork_suspensions5Yes

Screens​

Frontend routes gated by a permission this module's endpoints also require — the link between a page and its API is the permission string, not the URL.

RouteComponentRequires
/accounting/accountsChartOfAccountsaccounting.view
/accounting/journal-entriesJournalEntriesaccounting.view
/accounting/journal-entries/:idJournalEntryDetailaccounting.view
/accounting/periodsAccountingPeriodsaccounting.view
/accounting/settingsAccountingSettingsaccounting.view
/bonusesBonusespayroll.bonus.manage
/departmentsDepartmentshr.employees.manage
/employee-deductionsEmployeeDeductionspayroll.deduction.manage
/employeesEmployeeshr.employees.view
/ewt-registryEwtRegistrypayroll.ewt.manage
/government-formsGovernmentFormshr.employees.manage or payroll.manage
/holiday-calendarHolidayCalendarpayroll.holidays.manage or payroll.manage
/hr-analyticsHrAnalyticshr.dashboard.view
/my-awardsMyAwardsemployee.payslip.view
/my-payslipsMyPayslipsemployee.payslip.view
/my-reimbursementsMyReimbursementsemployee.reimbursement.request
/payroll-analyticsPayrollAnalyticspayroll.dashboard.view or payroll.manage or payroll.approve
/payroll-reportsPayrollReportspayroll.dashboard.view or payroll.manage or payroll.approve or hr.employees.view or hr.dashboard.view
/payroll-runsPayrollRunspayroll.dashboard.view or payroll.manage or payroll.approve
/payroll-runs/:idPayrollRunDetailpayroll.dashboard.view or payroll.manage or payroll.approve
/payroll-runs/:id/comparePayrollRunComparepayroll.dashboard.view or payroll.manage or payroll.approve
/payroll-settingsPayrollSettingspayroll.settings.manage
/payroll-transactionsPayrollTransactionspayroll.transactions.view or payroll.transactions.manage
/payroll/payoutsPayoutBatchespayroll.manage or accounting.view
/positionsPositionshr.employees.manage
/reimbursement-requestsReimbursementRequestspayroll.reimbursement.manage
/reimbursement-transactionsReimbursementTransactionspayroll.reimbursement.transactions.view or payroll.reimbursement.transactions.manage

Unauthenticated endpoints​

3 endpoint(s) in this module are permitted without a token by PUBLIC_ENDPOINTS in backend/src/main/java/com/motorph/payroll/config/SecurityConfiguration.java.

MethodPath
GET/api/public/payroll-simulator/defaults
POST/api/public/payroll-simulator/pdf
POST/api/public/payroll-simulator

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