Saltar al contenido

Update a rate card line

Módulo Crew

PATCH/rate-card-lines/{id}rateCardLines.update

A rate card line by role. 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.rate_card.write.
  • 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

rateCardLines.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the rate card line.

Cuerpo de la solicitud: RateCardLineUpdate

rateCardLines.update: RateCardLineUpdate
CampoTipoObligatorioDescripción
role_codeRoleCodeNoWorkforce role code from `xpms.dim_role`, on URID grammar.Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
rate_minorinteger (int64) | nullNoRate. Integer minor units of the resource currency; null means unpriced, never zero.
worker_classificationstringNoWorker classification priced, from xpms.worker_classification.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
pay_basisstringNoPay basis; with the classification a permitted pair.Restricciones: length 1 to 300
arrangementstringNoArrangement; with the classification a permitted pair.Restricciones: length 1 to 300
overtime_rule_idstringNoCanon overtime rule whose multipliers apply.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
canon_rate_card_idstring | nullNoCanon rate card the line was adopted from.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "rate_minor": 4500,
  "worker_classification": "EMPLOYEE",
  "pay_basis": "Hourly",
  "arrangement": "Per Engagement",
  "overtime_rule_id": "OTR-001",
  "canon_rate_card_id": "LRC-001"
}

Respuesta 200: RateCardLine

rateCardLines.update: RateCardLine
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the rate card line.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
rate_card_idstring (uuid)SíIdentifier of the rate card.
role_codeRoleCodeSíWorkforce role code from `xpms.dim_role`, on URID grammar.Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
rate_minorinteger | Masked | nullSí
worker_classificationstringSíWorker classification priced, from xpms.worker_classification.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
pay_basisstringSíPay basis; with the classification a permitted pair.Restricciones: length 1 to 300
arrangementstringSíArrangement; with the classification a permitted pair.Restricciones: length 1 to 300
overtime_rule_idstringSíCanon overtime rule whose multipliers apply.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
canon_rate_card_idstring | nullSíCanon rate card the line was adopted from.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "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",
  "rate_card_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "role_code": "5000.50.01",
  "rate_minor": 4500,
  "worker_classification": "EMPLOYEE",
  "pay_basis": "Hourly",
  "arrangement": "Per Engagement",
  "overtime_rule_id": "OTR-001",
  "canon_rate_card_id": "LRC-001"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/rate-card-lines/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 '{"rate_minor":4500,"worker_classification":"EMPLOYEE","pay_basis":"Hourly","arrangement":"Per Engagement","overtime_rule_id":"OTR-001","canon_rate_card_id":"LRC-001"}'
const { data, etag } = await xos.rateCardLines.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "rate_minor": 4500,
    "worker_classification": "EMPLOYEE",
    "pay_basis": "Hourly",
    "arrangement": "Per Engagement",
    "overtime_rule_id": "OTR-001",
    "canon_rate_card_id": "LRC-001"
  }, { ifMatch: etag });
response = xos.rate_card_lines.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"rate_minor": 4500, "worker_classification": "EMPLOYEE", "pay_basis": "Hourly", "arrangement": "Per Engagement", "overtime_rule_id": "OTR-001", "canon_rate_card_id": "LRC-001"}, if_match=etag)
xos rate-card-lines update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"rate_minor":4500,"worker_classification":"EMPLOYEE","pay_basis":"Hourly","arrangement":"Per Engagement","overtime_rule_id":"OTR-001","canon_rate_card_id":"LRC-001"}' --if-match auto