Create an earning code

Crew module

POST/earning-codesearningCodes.create

An earning code mapped to the payroll provider. Creates an earning code. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability org.payroll.write.
OAuth scopes: org.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: EarningCodeCreate

earningCodes.create: EarningCodeCreate
Field	Type	Required	Description
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	No	Whether it is an overtime code.

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

Response 201: EarningCode

earningCodes.create: 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 POST "$XOS_BASE_URL/earning-codes" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"code":"REG","name":"Regular Hours","is_overtime":false}'

const { data } = await xos.earningCodes.create({
    "code": "REG",
    "name": "Regular Hours",
    "is_overtime": false
  });

response = xos.earning_codes.create({"code": "REG", "name": "Regular Hours", "is_overtime": False})

xos earning-codes create --data '{"code":"REG","name":"Regular Hours","is_overtime":false}'