Skip to main content
The Payroll API processes payroll runs and generates payslips. Employee records live in HR — create employees there before running payroll.

​
Base path

/api/v1/payroll

​
Authorization

Developer JWT + API key on every request. See Authorization.

​
Operations and monitoring

EndpointPurpose
GET /api/v1/payrollService root
GET /api/v1/payroll/metricsPrometheus scrape target

​
Typical integration flow

  1. Ensure employees exist in HR
  2. Create a payroll run for a pay period
  3. Process the run and fetch payslips
  4. Optionally trigger payslip PDF generation via Utils

Payroll product guide

Runs, payslips, and integration patterns.