Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Access token JWT. Use as Authorization: Bearer . In the API playground, paste the JWT only.

X-Fluide-Api-Key
string
header
default:fl_dev_your_key
required

Developer API key (fl_dev_...). Required on every API call with a machine access token.

X-Fluide-Client-Id
string
header
default:fluide-developer
required

First-party client audience. Must match the fluide_client_id claim on the JWT. Use fluide-developer for Connect.

Headers

X-Workspace-Id
string<uuid>

Partner / ISV only: UUID of the workspace that owns the client company. Required together with X-Acting-Company-Id when scoping product APIs to a merchant. See /getting-started/multi-tenancy.

X-Acting-Company-Id
string<uuid>

Partner / ISV only: UUID of the client company to act on. Must belong to the workspace in X-Workspace-Id.

Body

application/json
companyId
string<uuid>
required

Company ID (from FluideAuth)

Example:

"c0a80123-..."

month
number
required

Payroll period month (1-12)

Required range: 1 <= x <= 12
Example:

3

year
number
required

Payroll period year

Example:

2026

periodStart
string

Inclusive period start (ISO date)

Example:

"2026-03-10"

periodEnd
string

Inclusive period end (ISO date)

Example:

"2026-03-10"

payDate
string

Pay date (ISO date); defaults to periodEnd

Example:

"2026-03-16"

runType
enum<string>
default:SCHEDULED
Available options:
SCHEDULED,
OFF_CYCLE
offCycleReason
string

Reason for off-cycle payroll

Maximum string length: 255
Example:

"Termination payout"

clientIdempotencyKey
string

Client idempotency key for safe retries

Maximum string length: 128
forceRecalculate
boolean
default:false

If true, recompute when prior run failed/processing (immutability preserved after validation)

employeeIds
string<uuid>[]

Payroll employee UUIDs to include. Omit for all active employees. Must match an existing run unless forceRecalculate is true.

Minimum array length: 1
cycleId
string<uuid>

Reusable payroll cycle template to seed period and roster

Response

Successful response