Update an earning code

Crew module

PATCH/earning-codes/{id}earningCodes.update

An earning code mapped to the payroll provider. 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.

Requires the capability org.payroll.write.
OAuth scopes: org.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

earningCodes.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the earning code.

Request body: EarningCodeUpdate

earningCodes.update: EarningCodeUpdate
Field	Type	Required	Description
code	string	No	Earning code.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
name	string	No	Earning name.Constraints: length 1 to 300
is_overtime	boolean	No	Whether it is an overtime code.

{
  "code": "REG",
  "name": "Regular Hours",
  "is_overtime": false
}

Response 200: EarningCode

earningCodes.update: EarningCode
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the earning code.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
code	string	Yes	Earning code.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
name	string	Yes	Earning name.Constraints: length 1 to 300
is_overtime	boolean	Yes	Whether it is an overtime code.

{
  "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",
  "code": "REG",
  "name": "Regular Hours",
  "is_overtime": false
}

Code samples

curl -X PATCH "$XOS_BASE_URL/earning-codes/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 '{"code":"REG","name":"Regular Hours","is_overtime":false}'

const { data, etag } = await xos.earningCodes.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "code": "REG",
    "name": "Regular Hours",
    "is_overtime": false
  }, { ifMatch: etag });

response = xos.earning_codes.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"code": "REG", "name": "Regular Hours", "is_overtime": False}, if_match=etag)

xos earning-codes update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"code":"REG","name":"Regular Hours","is_overtime":false}' --if-match auto