Skip to main content

Billing & Platform

}: that prefix also carries signup, billing and widget endpoints, which belong to the platform group.

Controllers8
Endpoints18
Tables35
Screens2
API reference/api/ — group billing-and-platform
OpenAPI spec/openapi/billing-and-platform.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/billing/**
  • /api/webhooks/**
  • /api/admin/**
  • /api/system-admin/**
  • /api/public/billing/**
  • /api/public/signup/**
  • /api/public/altcha/**
  • /api/public/chatwoot/**

Controllers​

ControllerBase pathEndpointsGETPOSTPUTPATCHDELETE
BillingController/api/billing211———
BillingWebhookController/api/webhooks1—1———
DemoDataController/api/system-admin/demo-data312———
PublicAltchaController/api/public/altcha11————
PublicBillingController/api/public/billing11————
PublicChatwootController/api/public/chatwoot11————
PublicSignupController/api/public/signup2—2———
TenantAdminController/api/admin/tenants72212—

Across the module: 7 GET, 8 POST, 1 PUT, 2 PATCH.

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
BillingSubscriptionbilling_subscription14—
BillingWebhookEventbilling_webhook_event9—
Bonusbonus8Yes
CompanyProfilecompany_profile20Yes
CrmPicklistItemcrm_picklist_item11Yes
CrmSettingscrm_settings12Yes
DeductionTypededuction_types10Yes
DeMinimisBenefitTypede_minimis_benefit_types12Yes
Departmentdepartment4Yes
Employeeemployee24Yes
EmployeeDeductionemployee_deductions12Yes
LeaveBalanceleave_balance2Yes
LeaveRequestleave_request8Yes
LeaveRequestTypeleave_request_type3Yes
OvertimeRequestovertime_request6Yes
PagibigContributionRatepagibig_contribution_rates6—
Payrollpayroll10Yes
PayrollApprovalpayroll_approval3Yes
PayrollChangepayroll_changes6Yes
PayrollSettingspayroll_settings71Yes
Payslippayslip52Yes
PayslipDeductionItempayslip_deduction_items4Yes
PayslipHistorypayslip_history8Yes
Permissionpermission4—
PhHolidayph_holidays7Yes
PhilhealthContributionRatephilhealth_contribution_rates6—
Positionposition4Yes
Rolerole6—
SssContributionRatesss_contribution_rates11—
Tenanttenant11—
Timesheettimesheet7Yes
Userusers11—
UserLoguser_log5—
WithholdingTaxBracketwithholding_tax_brackets7—
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
/billingBillingsystem.admin.billing.manage
/settingsSettingssystem.admin.demo.data.manage

Unauthenticated endpoints​

6 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
POST/api/webhooks/{provider}
GET/api/public/altcha/challenge
GET/api/public/billing/checkout-links
GET/api/public/chatwoot
POST/api/public/signup
POST/api/public/signup/verify

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