Run payroll calculations for multiple salary scenarios without persisting results.
Intended for quote/preview UIs, HR tools, and compensation planning:
Important: simulation results are NOT payroll records. They are never
stored and do not appear in any reports or audit logs. The response includes
is_simulation: true as an explicit flag.
Supports 1–20 scenarios per request. Each scenario can vary salary and enable/disable optional perceptions independently.
API key authentication. Send your API key as: Authorization: Bearer <your_api_key>
Request body for POST /v1/payroll/simulate.
Identical computation to /calculate but:
The simulation flag is enforced at the route handler level, not here.
^[A-Z]{2}$"MX"
"ordinario"
2020 <= x <= 20302024
Payroll period definition.
Employee-side inputs for a payroll calculation.
Employer-side inputs for a payroll calculation.
Simulation configuration: one or more salary scenarios.
Options that affect what the engine returns (not the calculation itself).
Simulation results for all scenarios.
Multi-scenario simulation response. Results are never persisted.
Simulation ID (ULID). Not persisted — for correlation only.
"success"