Skip to content
XOS Developers

Delete an earning code

Crew module

DELETE/earning-codes/{id}earningCodes.delete

An earning code mapped to the payroll provider. Soft-deletes the earning code: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability org.payroll.write.
  • OAuth scopes: org.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

earningCodes.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the earning code.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/earning-codes/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.earningCodes.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.earning_codes.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos earning-codes delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f