Skip to main content

Payroll quickstart

Fluide Payroll processes pay runs and payslips. Employees must already exist in HR before you run payroll.

Prerequisites

1. List payroll runs

Confirm you can reach the Payroll API:
curl -X GET "$FLUIDE_BASE_URL/api/v1/payroll/payroll" \
  -H "Authorization: Bearer $FLUIDE_ACCESS_TOKEN" \
  -H "X-Fluide-Api-Key: $FLUIDE_API_KEY" \
  -H "X-Fluide-Client-Id: fluide-developer"

2. Create and process a run

Create a payroll run for your pay period, then process it. Exact fields depend on your organization’s payroll configuration.
Open the Payroll group in API reference for create/process endpoints, request bodies, and status codes.

3. Fetch payslips

After a run completes, retrieve payslips for employees in that period. You can generate PDF artifacts through Utils when your integration needs downloadable payslips.

Typical flow

1

Sync employees in HR

Create or update employee records via /api/v1/hr/employees.
2

Create a payroll run

POST a run for the target period.
3

Process the run

Trigger processing and poll until the run reaches a terminal status.
4

Deliver payslips

Fetch payslip data via the API or generate PDFs through Utils.

Payroll overview

Runs, payslips, and integration patterns.

Payroll API reference

Full endpoint list and playground.