TRANXACT.AI Help

HRMS · Compensation

Total Rewards

The whole package: pay, bonus target, what the employer puts into benefits and taxes, equity and leave.

Type REST6 operationsBase path /api/hrms/total-rewardsPublished as /api/v1/total-rewards

Download specification (OpenAPI 3.1) Screen: Total Rewards

Overview

PackageHRMS
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablehr.total_rewards · kept per company (and organisational unit where it has one)
RecordRead only; key employee_id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
employee_idstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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.

FieldTypeAccessDescription
employee_iduuidread onlyEmployee id
org_iduuidread onlyOrg id
employee_notextread onlyEmployee no
employee_nametextread onlyEmployee name
currencytextread onlyCurrency
base_paynumericread onlyBase pay
bonus_target_percentnumericread onlyBonus target percent
bonus_targetnumericread onlyBonus target
employer_benefitsnumericread onlyEmployer benefits
employee_benefit_costnumericread onlyEmployee benefit cost
employer_taxesnumericread onlyEmployer taxes
equity_unitsnumericread onlyEquity units
leave_days_availablenumericread onlyLeave days available

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold HRMS › Total Rewards for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.