HRMS · Compensation
Compensation Awards
What the matrix said and what the manager asked for. The gap between them is what a committee reviews.
/api/hrms/comp-awardsPublished as /api/v1/comp-awardsDownload specification (OpenAPI 3.1) Screen: Compensation Awards
Overview
| Package | HRMS |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold HRMS › Compensation Awards on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | hr.comp_awards · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/comp-awardsList compensation awards
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"award_type": "text",
"rating": "text",
"current_pay": "1250.00",
"current_grade_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"compa_ratio": "1250.00",
"quartile": 10,
"guideline_percent": "1250.00",
"guideline_amount": "1250.00",
"proposed_percent": "1250.00",
"proposed_amount": "1250.00",
"new_pay": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/comp-awards?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/comp-awards/{id}Read one comp awards
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"award_type": "text",
"rating": "text",
"current_pay": "1250.00",
"current_grade_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"compa_ratio": "1250.00",
"quartile": 10,
"guideline_percent": "1250.00",
"guideline_amount": "1250.00",
"proposed_percent": "1250.00",
"proposed_amount": "1250.00",
"new_pay": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/comp-awards/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/comp-awardsCreate a comp awards
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
cycle_id | uuid | Yes | Cycle id |
employee_id | uuid | Yes | Employee id |
award_type | text | No | Award type |
rating | text | No | Rating |
proposed_percent | numeric | No | Proposed percent |
proposed_amount | numeric | No | Proposed amount |
justification | text | No | Justification |
status | text | No | Status |
Sample body
{
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"award_type": "text",
"rating": "text",
"proposed_percent": "1250.00",
"proposed_amount": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"award_type": "text",
"rating": "text",
"current_pay": "1250.00",
"current_grade_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"compa_ratio": "1250.00",
"quartile": 10,
"guideline_percent": "1250.00",
"guideline_amount": "1250.00",
"proposed_percent": "1250.00",
"proposed_amount": "1250.00",
"new_pay": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/comp-awards" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"cycle_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","award_type":"text","rating":"text","proposed_percent":"1250.00","proposed_amount":"1250.00"}'PUT/api/hrms/comp-awards/{id}Change a comp awards
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
cycle_id | uuid | Yes | Cycle id |
employee_id | uuid | Yes | Employee id |
award_type | text | No | Award type |
rating | text | No | Rating |
proposed_percent | numeric | No | Proposed percent |
proposed_amount | numeric | No | Proposed amount |
justification | text | No | Justification |
status | text | No | Status |
Sample body
{
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"award_type": "text",
"rating": "text",
"current_pay": "1250.00",
"current_grade_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"compa_ratio": "1250.00",
"quartile": 10,
"guideline_percent": "1250.00",
"guideline_amount": "1250.00",
"proposed_percent": "1250.00",
"proposed_amount": "1250.00",
"new_pay": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/comp-awards/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"cycle_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/hrms/comp-awards/{id}Delete a comp awards
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/hrms/comp-awards/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/comp-awards/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/comp-awards/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a comp awards, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
cycle_id | uuid | read, write | Cycle id |
employee_id | uuid | read, write | Employee id |
award_type | text | read, write | Award type |
rating | text | read, write | Rating |
current_pay | numeric | read only | Current pay |
current_grade_id | uuid | read only | Current grade id |
compa_ratio | numeric | read only | Compa ratio |
quartile | integer | read only | Quartile |
guideline_percent | numeric | read only | Guideline percent |
guideline_amount | numeric | read only | Guideline amount |
proposed_percent | numeric | read, write | Proposed percent |
proposed_amount | numeric | read, write | Proposed amount |
new_pay | numeric | read only | New pay |
new_grade_id | uuid | read only | New grade id |
new_compa_ratio | numeric | read only | New compa ratio |
justification | text | read, write | Justification |
status | text | read, write | Status |
proposed_by | uuid | read only | Proposed by |
approved_by | uuid | read only | Approved by |
approved_at | timestamp with time zone | read only | Approved at |
applied_at | timestamp with time zone | read only | Applied at |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold HRMS › Compensation Awards for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.