TRANXACT.AI Help

HRMS · Pay Setup

Earning Codes

What money is called, how each kind is worked out, and whether it counts as wages.

Type REST6 operationsBase path /api/hrms/earning-codesPublished as /api/v1/earning-codes

Download specification (OpenAPI 3.1) Screen: Earning Codes

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 › 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.
Tablehr.earning_codes · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key 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/earning-codesList earning codes

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": [
    {
      "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

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

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
categorytextNoCategory
calculationtextNoWorked out as
Allowed: rate_times_hours flat_amount percent_of_base salary_proration unit_rate formula
multipliernumericNoMultiplier — 1.5 for overtime, 2 for double time.
subject_to_fitbooleanNoSubject to federal income tax
subject_to_ficabooleanNoSubject to FICA
subject_to_futabooleanNoSubject to FUTA
subject_to_sitbooleanNoSubject to state income tax
is_imputedbooleanNoImputed income — Counted as pay but never paid out — the private use of a company car, for example.
includes_in_regular_ratebooleanNoCounts toward the overtime regular rate
supplementalbooleanNoSupplemental — Withheld at the flat supplemental rate rather than through the tables.
w2_boxtextNoW-2 box
gl_account_notextNoGL account
is_activebooleanNoActive
sort_orderintegerNoSort 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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
categorytextNoCategory
calculationtextNoWorked out as
Allowed: rate_times_hours flat_amount percent_of_base salary_proration unit_rate formula
multipliernumericNoMultiplier — 1.5 for overtime, 2 for double time.
subject_to_fitbooleanNoSubject to federal income tax
subject_to_ficabooleanNoSubject to FICA
subject_to_futabooleanNoSubject to FUTA
subject_to_sitbooleanNoSubject to state income tax
is_imputedbooleanNoImputed income — Counted as pay but never paid out — the private use of a company car, for example.
includes_in_regular_ratebooleanNoCounts toward the overtime regular rate
supplementalbooleanNoSupplemental — Withheld at the flat supplemental rate rather than through the tables.
w2_boxtextNoW-2 box
gl_account_notextNoGL account
is_activebooleanNoActive
sort_orderintegerNoSort 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

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
codetextread, writeCode
nametextread, writeName
categorytextread, writeCategory
calculationtextread, writeWorked out as
Allowed: rate_times_hours flat_amount percent_of_base salary_proration unit_rate formula
multipliernumericread, writeMultiplier — 1.5 for overtime, 2 for double time.
subject_to_fitbooleanread, writeSubject to federal income tax
subject_to_ficabooleanread, writeSubject to FICA
subject_to_futabooleanread, writeSubject to FUTA
subject_to_sitbooleanread, writeSubject to state income tax
is_imputedbooleanread, writeImputed income — Counted as pay but never paid out — the private use of a company car, for example.
includes_in_regular_ratebooleanread, writeCounts toward the overtime regular rate
supplementalbooleanread, writeSupplemental — Withheld at the flat supplemental rate rather than through the tables.
w2_boxtextread, writeW-2 box
gl_account_notextread, writeGL account
is_activebooleanread, writeActive
sort_orderintegerread, writeSort order
org_unit_iduuidread onlyOrg unit id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 › Earning Codes 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.