HRMS · Compensation
Total Rewards
The whole package: pay, bonus target, what the employer puts into benefits and taxes, equity and leave.
/api/hrms/total-rewardsPublished as /api/v1/total-rewardsOverview
| 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 › Total Rewards 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.total_rewards · kept per company (and organisational unit where it has one) |
| Record | Read only; key employee_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/total-rewardsList total rewards
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": [
{
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_no": "EMP-000001",
"employee_name": "Example",
"currency": "USD",
"base_pay": "1250.00",
"bonus_target_percent": "1250.00",
"bonus_target": "1250.00",
"employer_benefits": "1250.00",
"employee_benefit_cost": "1250.00",
"employer_taxes": "1250.00",
"equity_units": "1250.00",
"leave_days_available": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/total-rewards?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/total-rewards/{employee_id}Read one total rewards
Path parameters
| Name | Type | Description |
|---|---|---|
employee_id | string (uuid) | The record's employee_id, as a list returns it. |
Response 200
{
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_no": "EMP-000001",
"employee_name": "Example",
"currency": "USD",
"base_pay": "1250.00",
"bonus_target_percent": "1250.00",
"bonus_target": "1250.00",
"employer_benefits": "1250.00",
"employee_benefit_cost": "1250.00",
"employer_taxes": "1250.00",
"equity_units": "1250.00",
"leave_days_available": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/total-rewards/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/total-rewardsPost total rewards
No body is required.
Response
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/total-rewards" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/total-rewards/{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/total-rewards/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/hrms/total-rewards/{id}Put total rewards
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
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 PUT "https://demo.tranxact.ai/api/hrms/total-rewards/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/hrms/total-rewards/{id}Delete total rewards
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
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 DELETE "https://demo.tranxact.ai/api/hrms/total-rewards/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a total rewards, 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 |
|---|---|---|---|
employee_id | uuid | read only | Employee id |
org_id | uuid | read only | Org id |
employee_no | text | read only | Employee no |
employee_name | text | read only | Employee name |
currency | text | read only | Currency |
base_pay | numeric | read only | Base pay |
bonus_target_percent | numeric | read only | Bonus target percent |
bonus_target | numeric | read only | Bonus target |
employer_benefits | numeric | read only | Employer benefits |
employee_benefit_cost | numeric | read only | Employee benefit cost |
employer_taxes | numeric | read only | Employer taxes |
equity_units | numeric | read only | Equity units |
leave_days_available | numeric | read only | Leave days available |
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 › Total Rewards 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.