Skip to content
XOS Developers

earningCodes

Crew module · 5 operations

List earning code rows

GET/earning-codes

An earning code mapped to the payroll provider. Returns a cursor page of earning code rows the caller may see. Coded list: the default order is numeric code order by `code`. Supports sparse fieldsets and the filter grammar.

Create an earning code

POST/earning-codes

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.

Get an earning code

GET/earning-codes/{id}

An earning code mapped to the payroll provider. Returns one earning code with its `ETag`. A earning code the caller may not see returns 404.

Update an earning code

PATCH/earning-codes/{id}

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.

Delete an earning code

DELETE/earning-codes/{id}

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.