CitoHRCitoHR
API Reference

Payroll API

Access payroll data and export payroll information through the CitoHR API.

Get Organization Payroll Data

Retrieve payroll data for an organization. 

GET /api/payroll/organization/{organizationId}

Returns comprehensive payroll data for the specified organization. Includes employee payroll information, calculations, and summaries.

Authorization: Requires ADMIN role. You can only access your own organization's payroll data.

Get Employee Payroll

Retrieve payroll information for a specific employee. 

GET /api/payroll/employee/{userId}

Returns payroll details for the specified employee including salary, deductions, and payment history.

Payroll Exports

Export payroll data in various formats:

  • GET /api/payroll/export/monthly - Export monthly payroll data
  • GET /api/payroll/export/history - Export payroll history
  • GET /api/payroll/export/new-starters - Export new starter information
  • GET /api/payroll/export/leavers - Export leaver information
  • GET /api/payroll/export/pension - Export pension data
  • GET /api/payroll/export/benefits - Export benefits data

All export endpoints require ADMIN role and return data in CSV format suitable for HMRC reporting and accounting software integration.