Prepare payroll run
Returns the run of a pay period, creating it when none exists: one run per PeriodicidadPago and period start. A run keeps its period after the pay calendar changes and is found by its own start. Receipts are calculated in the background from each active employee's salary; read the run until calculating is false. A date that starts no period returns 400 naming the start of the period that contains it; a period overlapping another run of the same frequency returns 409 conflict naming that run's period. The status is 200 whether the run was created or already existed.
- Endpoint
POST /v1/payroll/runs- Authorization
- Required permission: `employees:manage`.
- Environments
- Production and sandbox
- Idempotency
- Required for safe retries.
List payroll runs GET
Lists payroll runs, latest period first, optionally of one PeriodicidadPago. Each run reports its receipts' count and net per state, and how many receipts wait for a salary (missingSalary).
Get payroll run GET
Returns one payroll run with its receipt count and net per state, how many receipts wait for a salary (missingSalary), whether its receipts are still being calculated, and stampBlock while stamping is held: the plan or wallet ran out, background work was interrupted, or a published tax-rule change awaits confirmation.