Transition the payroll run state

Módulo Crew

POST/payroll-runs/{id}/transitionspayrollRuns.transition

Moves the payroll run lifecycle to another state through its transition RPC, which writes the transition ledger. Uses compare-and-set on `expected_state`; a disallowed transition returns a 422 refusal. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requiere la capacidad crew.pay_period.manage.
Alcances de OAuth: crew.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

payrollRuns.transition: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the payroll run.

Cuerpo de la solicitud: PayrollRunTransitionRequest

payrollRuns.transition: PayrollRunTransitionRequest
Campo	Tipo	Obligatorio	Descripción
expected_state	string	Sí	The state the caller believes the row is in (compare-and-set).Restricciones: pattern ^[A-Z][A-Za-z]( [A-Z][A-Za-z])*$
to_state	string	Sí	Target state.Restricciones: pattern ^[A-Z][A-Za-z]( [A-Z][A-Za-z])*$
reason	string	No	Reason, required by some transitions.Restricciones: length 1 to any

{
  "expected_state": "Exported",
  "to_state": "Accepted",
  "reason": "Client approved the revised scope."
}

Respuesta 200: PayrollRun

payrollRuns.transition: PayrollRun
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the payroll run.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
pay_period_id	string (uuid)	Sí	Identifier of the pay period.
payroll_run_state	"Draft" \| "Calculated" \| "Approved" \| "Exported" \| "Accepted" \| "Canceled"	Sí	Payroll run state.
currency_code	string	Sí	ISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "pay_period_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "payroll_run_state": "Draft",
  "currency_code": "USD"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/payroll-runs/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/transitions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"expected_state":"Exported","to_state":"Accepted","reason":"Client approved the revised scope."}'

const { data } = await xos.payrollRuns.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "expected_state": "Exported",
    "to_state": "Accepted",
    "reason": "Client approved the revised scope."
  });

response = xos.payroll_runs.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"expected_state": "Exported", "to_state": "Accepted", "reason": "Client approved the revised scope."})

xos payroll-runs transition 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"expected_state":"Exported","to_state":"Accepted","reason":"Client approved the revised scope."}'