HRMS · Pay Setup
Earning Codes
What money is called, how each kind is worked out, and whether it counts as wages.
/api/hrms/earning-codesPublished as /api/v1/earning-codesOverview
| 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 › Earning Codes 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.earning_codes · 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/earning-codesList earning codes
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",
"code": "COD-000001",
"name": "Example",
"category": "text",
"calculation": "rate_times_hours",
"multiplier": "1250.00",
"subject_to_fit": true,
"subject_to_fica": true,
"subject_to_futa": true,
"subject_to_sit": true,
"is_imputed": true,
"includes_in_regular_rate": true,
"supplemental": true,
"w2_box": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/earning-codes?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/earning-codes/{id}Read one earning codes
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",
"code": "COD-000001",
"name": "Example",
"category": "text",
"calculation": "rate_times_hours",
"multiplier": "1250.00",
"subject_to_fit": true,
"subject_to_fica": true,
"subject_to_futa": true,
"subject_to_sit": true,
"is_imputed": true,
"includes_in_regular_rate": true,
"supplemental": true,
"w2_box": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/earning-codes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/earning-codesCreate a earning codes
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
category | text | No | Category |
calculation | text | No | Worked out as Allowed: rate_times_hours flat_amount percent_of_base salary_proration unit_rate formula |
multiplier | numeric | No | Multiplier — 1.5 for overtime, 2 for double time. |
subject_to_fit | boolean | No | Subject to federal income tax |
subject_to_fica | boolean | No | Subject to FICA |
subject_to_futa | boolean | No | Subject to FUTA |
subject_to_sit | boolean | No | Subject to state income tax |
is_imputed | boolean | No | Imputed income — Counted as pay but never paid out — the private use of a company car, for example. |
includes_in_regular_rate | boolean | No | Counts toward the overtime regular rate |
supplemental | boolean | No | Supplemental — Withheld at the flat supplemental rate rather than through the tables. |
w2_box | text | No | W-2 box |
gl_account_no | text | No | GL account |
is_active | boolean | No | Active |
sort_order | integer | No | Sort order |
Sample body
{
"code": "COD-000001",
"name": "Example",
"category": "text",
"calculation": "rate_times_hours",
"multiplier": "1250.00",
"subject_to_fit": true
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"category": "text",
"calculation": "rate_times_hours",
"multiplier": "1250.00",
"subject_to_fit": true,
"subject_to_fica": true,
"subject_to_futa": true,
"subject_to_sit": true,
"is_imputed": true,
"includes_in_regular_rate": true,
"supplemental": true,
"w2_box": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/earning-codes" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","category":"text","calculation":"rate_times_hours","multiplier":"1250.00","subject_to_fit":true}'PUT/api/hrms/earning-codes/{id}Change a earning codes
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 |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
category | text | No | Category |
calculation | text | No | Worked out as Allowed: rate_times_hours flat_amount percent_of_base salary_proration unit_rate formula |
multiplier | numeric | No | Multiplier — 1.5 for overtime, 2 for double time. |
subject_to_fit | boolean | No | Subject to federal income tax |
subject_to_fica | boolean | No | Subject to FICA |
subject_to_futa | boolean | No | Subject to FUTA |
subject_to_sit | boolean | No | Subject to state income tax |
is_imputed | boolean | No | Imputed income — Counted as pay but never paid out — the private use of a company car, for example. |
includes_in_regular_rate | boolean | No | Counts toward the overtime regular rate |
supplemental | boolean | No | Supplemental — Withheld at the flat supplemental rate rather than through the tables. |
w2_box | text | No | W-2 box |
gl_account_no | text | No | GL account |
is_active | boolean | No | Active |
sort_order | integer | No | Sort order |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"category": "text",
"calculation": "rate_times_hours",
"multiplier": "1250.00",
"subject_to_fit": true,
"subject_to_fica": true,
"subject_to_futa": true,
"subject_to_sit": true,
"is_imputed": true,
"includes_in_regular_rate": true,
"supplemental": true,
"w2_box": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/earning-codes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/hrms/earning-codes/{id}Delete a earning codes
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/earning-codes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/earning-codes/{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/earning-codes/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 earning codes, 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 |
code | text | read, write | Code |
name | text | read, write | Name |
category | text | read, write | Category |
calculation | text | read, write | Worked out as Allowed: rate_times_hours flat_amount percent_of_base salary_proration unit_rate formula |
multiplier | numeric | read, write | Multiplier — 1.5 for overtime, 2 for double time. |
subject_to_fit | boolean | read, write | Subject to federal income tax |
subject_to_fica | boolean | read, write | Subject to FICA |
subject_to_futa | boolean | read, write | Subject to FUTA |
subject_to_sit | boolean | read, write | Subject to state income tax |
is_imputed | boolean | read, write | Imputed income — Counted as pay but never paid out — the private use of a company car, for example. |
includes_in_regular_rate | boolean | read, write | Counts toward the overtime regular rate |
supplemental | boolean | read, write | Supplemental — Withheld at the flat supplemental rate rather than through the tables. |
w2_box | text | read, write | W-2 box |
gl_account_no | text | read, write | GL account |
is_active | boolean | read, write | Active |
sort_order | integer | read, write | Sort order |
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_at | timestamp with time zone | read only | Created at |
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 › Earning Codes 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.