TRANXACT.AI Help

HRMS · Pay Setup

Deduction Codes

What comes out, in what order, and which taxes it reduces before it does.

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

Download specification (OpenAPI 3.1) Screen: Deduction 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 › Deduction 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.deduction_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/deduction-codesList deduction 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": "flat_amount",
      "amount": "1250.00",
      "percent": "1250.00",
      "reduces_fit": true,
      "reduces_fica": true,
      "reduces_sit": true,
      "employer_paid": true,
      "employer_match_percent": "1250.00",
      "employer_match_limit_percent": "1250.00",
      "annual_limit": "1250.00"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/hrms/deduction-codes?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/deduction-codes/{id}Read one deduction 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": "flat_amount",
  "amount": "1250.00",
  "percent": "1250.00",
  "reduces_fit": true,
  "reduces_fica": true,
  "reduces_sit": true,
  "employer_paid": true,
  "employer_match_percent": "1250.00",
  "employer_match_limit_percent": "1250.00",
  "annual_limit": "1250.00"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/hrms/deduction-codes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/deduction-codesCreate a deduction codes

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
categorytextNoCategory
calculationtextNoWorked out as
Allowed: flat_amount percent_of_gross percent_of_net tiered schedule formula
amountnumericNoAmount
percentnumericNoPercent
reduces_fitbooleanNoReduces federal income tax
reduces_ficabooleanNoReduces FICA
reduces_sitbooleanNoReduces state income tax
employer_paidbooleanNoPaid by the employer
employer_match_percentnumericNoEmployer match %
employer_match_limit_percentnumericNoMatch capped at % of pay
annual_limitnumericNoAnnual limit
priorityintegerNoOrder taken — Lower is taken first. Garnishments come before voluntary deductions.
max_percent_of_disposablenumericNoCap as % of disposable earnings
w2_boxtextNoW-2 box
gl_account_notextNoGl account no
is_activebooleanNoActive
tax_treatmenttextNoTax treatment — Optional. When set it decides which taxes the deduction comes off, in place of the boxes above.
Allowed: section125 hsa dependent_care commuter pretax_401k pretax_403b pretax_457b roth_401k roth_403b roth_457b posttax group_term_life
required_by_lawbooleanNoRequired by law

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "category": "text",
  "calculation": "flat_amount",
  "amount": "1250.00",
  "percent": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "category": "text",
  "calculation": "flat_amount",
  "amount": "1250.00",
  "percent": "1250.00",
  "reduces_fit": true,
  "reduces_fica": true,
  "reduces_sit": true,
  "employer_paid": true,
  "employer_match_percent": "1250.00",
  "employer_match_limit_percent": "1250.00",
  "annual_limit": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/deduction-codes" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","category":"text","calculation":"flat_amount","amount":"1250.00","percent":"1250.00"}'
PUT/api/hrms/deduction-codes/{id}Change a deduction 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: flat_amount percent_of_gross percent_of_net tiered schedule formula
amountnumericNoAmount
percentnumericNoPercent
reduces_fitbooleanNoReduces federal income tax
reduces_ficabooleanNoReduces FICA
reduces_sitbooleanNoReduces state income tax
employer_paidbooleanNoPaid by the employer
employer_match_percentnumericNoEmployer match %
employer_match_limit_percentnumericNoMatch capped at % of pay
annual_limitnumericNoAnnual limit
priorityintegerNoOrder taken — Lower is taken first. Garnishments come before voluntary deductions.
max_percent_of_disposablenumericNoCap as % of disposable earnings
w2_boxtextNoW-2 box
gl_account_notextNoGl account no
is_activebooleanNoActive
tax_treatmenttextNoTax treatment — Optional. When set it decides which taxes the deduction comes off, in place of the boxes above.
Allowed: section125 hsa dependent_care commuter pretax_401k pretax_403b pretax_457b roth_401k roth_403b roth_457b posttax group_term_life
required_by_lawbooleanNoRequired by law

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "category": "text",
  "calculation": "flat_amount",
  "amount": "1250.00",
  "percent": "1250.00",
  "reduces_fit": true,
  "reduces_fica": true,
  "reduces_sit": true,
  "employer_paid": true,
  "employer_match_percent": "1250.00",
  "employer_match_limit_percent": "1250.00",
  "annual_limit": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/deduction-codes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/hrms/deduction-codes/{id}Delete a deduction 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/deduction-codes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/deduction-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/deduction-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 deduction 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: flat_amount percent_of_gross percent_of_net tiered schedule formula
amountnumericread, writeAmount
percentnumericread, writePercent
reduces_fitbooleanread, writeReduces federal income tax
reduces_ficabooleanread, writeReduces FICA
reduces_sitbooleanread, writeReduces state income tax
employer_paidbooleanread, writePaid by the employer
employer_match_percentnumericread, writeEmployer match %
employer_match_limit_percentnumericread, writeMatch capped at % of pay
annual_limitnumericread, writeAnnual limit
priorityintegerread, writeOrder taken — Lower is taken first. Garnishments come before voluntary deductions.
max_percent_of_disposablenumericread, writeCap as % of disposable earnings
w2_boxtextread, writeW-2 box
gl_account_notextread, writeGl account no
is_activebooleanread, writeActive
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
tax_treatmenttextread, writeTax treatment — Optional. When set it decides which taxes the deduction comes off, in place of the boxes above.
Allowed: section125 hsa dependent_care commuter pretax_401k pretax_403b pretax_457b roth_401k roth_403b roth_457b posttax group_term_life
required_by_lawbooleanread, writeRequired by law

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 › Deduction 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.