Payroll API — Periods & Runs | نرم‌افزار هُما

Read-only access to payroll periods, calculation runs and the employee roster. Scopes: payroll:periods:read, payroll:runs:read, payroll:employees:read.

Privacy by design: only aggregate run totals and summary identity fields are exposed — individual payslip lines, salary details and sensitive personal data are never returned by this API.

List Periods

GET /payroll/periods

Payroll periods. Query: year, status, page, pageSize.

List Calculation Runs

GET /payroll/runs

Calculation runs with employee count and aggregate gross/deductions/net totals. Query: periodId, status, page, pageSize.

Get Run Summary

GET /payroll/runs/{id}

Aggregate totals for a single run — individual payslip lines are intentionally omitted.

List Employees

GET /payroll/employees

Employee roster with summary identity fields only (name, code, status). Query: search, page, pageSize.

مدیریت مشتریان

عملیات مالی