TRANXACT.AI Help

HRMS · Pay Setup

Withholding (W-4)

What each employee has told the employer to withhold. Nothing can be calculated for somebody with no setup on file.

Type REST6 operationsBase path /api/hrms/employee-tax-setupPublished as /api/v1/employee-tax-setup

Download specification (OpenAPI 3.1) Screen: Withholding (W-4)

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 › Withholding (W-4) 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.employee_tax_setup · 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/employee-tax-setupList withholding (w-4)

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",
      "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "jurisdiction": "text",
      "authority": "text",
      "effective_from": "2026-10-30",
      "effective_to": "2026-10-30",
      "filing_status": "draft",
      "multiple_jobs": true,
      "dependents_amount": "1250.00",
      "other_income": "1250.00",
      "deductions": "1250.00",
      "extra_withholding": "1250.00",
      "allowances": 10,
      "is_legacy_w4": true
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/hrms/employee-tax-setup?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/employee-tax-setup/{id}Read one employee tax setup

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "jurisdiction": "text",
  "authority": "text",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "filing_status": "draft",
  "multiple_jobs": true,
  "dependents_amount": "1250.00",
  "other_income": "1250.00",
  "deductions": "1250.00",
  "extra_withholding": "1250.00",
  "allowances": 10,
  "is_legacy_w4": true
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
employee_iduuidYesEmployee
jurisdictiontextNoJurisdiction — federal for the Form W-4, or a state code (CA, NY, NJ…) for that state’s own certificate — DE 4, IT-2104, NJ-W4.
authoritytextNoAuthority
effective_fromdateNoEffective from
effective_todateNoEffective to
filing_statustextNoFiling status
multiple_jobsbooleanNoMultiple jobs or spouse works (step 2c)
dependents_amountnumericNoDependents claimed (step 3)
other_incomenumericNoOther income (step 4a)
deductionsnumericNoDeductions (step 4b)
extra_withholdingnumericNoExtra withholding a period (step 4c)
allowancesintegerNoState allowances — State certificate only. Empty: one for a single filer, two for married.
is_legacy_w4booleanNoIs legacy w4
exempt_from_withholdingbooleanNoClaims exemption
additional_percentnumericNoAdditional percent
signed_ondateNoSigned on
sourcetextNoSource
additional_allowancesintegerNoAdditional / estimated deduction allowances — California DE 4 line 1b, Illinois IL-W-4 line 2, and the like.
dependents_countintegerNoDependents (state)
elected_ratenumericNoElected rate (Arizona A-4) — As a fraction: 0.025 for 2.5%.
reciprocity_waivedbooleanNoWithhold the work state despite reciprocity — Tick when the employee has not filed the non-residence certificate.

Sample body

{
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "jurisdiction": "text",
  "authority": "text",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "jurisdiction": "text",
  "authority": "text",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "filing_status": "draft",
  "multiple_jobs": true,
  "dependents_amount": "1250.00",
  "other_income": "1250.00",
  "deductions": "1250.00",
  "extra_withholding": "1250.00",
  "allowances": 10,
  "is_legacy_w4": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/employee-tax-setup" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","jurisdiction":"text","authority":"text","effective_from":"2026-10-30","effective_to":"2026-10-30"}'
PUT/api/hrms/employee-tax-setup/{id}Change a employee tax setup

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
employee_iduuidYesEmployee
jurisdictiontextNoJurisdiction — federal for the Form W-4, or a state code (CA, NY, NJ…) for that state’s own certificate — DE 4, IT-2104, NJ-W4.
authoritytextNoAuthority
effective_fromdateNoEffective from
effective_todateNoEffective to
filing_statustextNoFiling status
multiple_jobsbooleanNoMultiple jobs or spouse works (step 2c)
dependents_amountnumericNoDependents claimed (step 3)
other_incomenumericNoOther income (step 4a)
deductionsnumericNoDeductions (step 4b)
extra_withholdingnumericNoExtra withholding a period (step 4c)
allowancesintegerNoState allowances — State certificate only. Empty: one for a single filer, two for married.
is_legacy_w4booleanNoIs legacy w4
exempt_from_withholdingbooleanNoClaims exemption
additional_percentnumericNoAdditional percent
signed_ondateNoSigned on
sourcetextNoSource
additional_allowancesintegerNoAdditional / estimated deduction allowances — California DE 4 line 1b, Illinois IL-W-4 line 2, and the like.
dependents_countintegerNoDependents (state)
elected_ratenumericNoElected rate (Arizona A-4) — As a fraction: 0.025 for 2.5%.
reciprocity_waivedbooleanNoWithhold the work state despite reciprocity — Tick when the employee has not filed the non-residence certificate.

Sample body

{
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "jurisdiction": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "jurisdiction": "text",
  "authority": "text",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "filing_status": "draft",
  "multiple_jobs": true,
  "dependents_amount": "1250.00",
  "other_income": "1250.00",
  "deductions": "1250.00",
  "extra_withholding": "1250.00",
  "allowances": 10,
  "is_legacy_w4": true
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/employee-tax-setup/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","jurisdiction":"text"}'
DELETE/api/hrms/employee-tax-setup/{id}Delete a employee tax setup

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/employee-tax-setup/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/employee-tax-setup/{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/employee-tax-setup/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 employee tax setup, 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
employee_iduuidread, writeEmployee
jurisdictiontextread, writeJurisdiction — federal for the Form W-4, or a state code (CA, NY, NJ…) for that state’s own certificate — DE 4, IT-2104, NJ-W4.
authoritytextread, writeAuthority
effective_fromdateread, writeEffective from
effective_todateread, writeEffective to
filing_statustextread, writeFiling status
multiple_jobsbooleanread, writeMultiple jobs or spouse works (step 2c)
dependents_amountnumericread, writeDependents claimed (step 3)
other_incomenumericread, writeOther income (step 4a)
deductionsnumericread, writeDeductions (step 4b)
extra_withholdingnumericread, writeExtra withholding a period (step 4c)
allowancesintegerread, writeState allowances — State certificate only. Empty: one for a single filer, two for married.
is_legacy_w4booleanread, writeIs legacy w4
exempt_from_withholdingbooleanread, writeClaims exemption
additional_percentnumericread, writeAdditional percent
signed_ondateread, writeSigned on
sourcetextread, writeSource
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
additional_allowancesintegerread, writeAdditional / estimated deduction allowances — California DE 4 line 1b, Illinois IL-W-4 line 2, and the like.
dependents_countintegerread, writeDependents (state)
elected_ratenumericread, writeElected rate (Arizona A-4) — As a fraction: 0.025 for 2.5%.
reciprocity_waivedbooleanread, writeWithhold the work state despite reciprocity — Tick when the employee has not filed the non-residence certificate.
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_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 › Withholding (W-4) 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.