Update a pay period

Módulo Crew

PATCH/pay-periods/{id}payPeriods.update

A pay period. A posted pay period cannot reopen. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requiere la capacidad crew.pay_period.manage.
Alcances de OAuth: crew.
Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

payPeriods.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the pay period.

Cuerpo de la solicitud: PayPeriodUpdate

payPeriods.update: PayPeriodUpdate
Campo	Tipo	Obligatorio	Descripción
starts_on	string (date)	No	First day.
ends_on	string (date)	No	Last day.

{
  "starts_on": "2026-10-08",
  "ends_on": "2026-10-08"
}

Respuesta 200: PayPeriod

payPeriods.update: PayPeriod
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the pay period.
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.
starts_on	string (date)	Sí	First day.
ends_on	string (date)	Sí	Last day.
pay_period_state	string	Sí	Pay period state. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$

{
  "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",
  "starts_on": "2026-10-08",
  "ends_on": "2026-10-08",
  "pay_period_state": "Open"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/pay-periods/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"starts_on":"2026-10-08","ends_on":"2026-10-08"}'

const { data, etag } = await xos.payPeriods.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "starts_on": "2026-10-08",
    "ends_on": "2026-10-08"
  }, { ifMatch: etag });

response = xos.pay_periods.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"starts_on": "2026-10-08", "ends_on": "2026-10-08"}, if_match=etag)

xos pay-periods update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"starts_on":"2026-10-08","ends_on":"2026-10-08"}' --if-match auto