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.
/api/hrms/employee-tax-setupPublished as /api/v1/employee-tax-setupDownload specification (OpenAPI 3.1) Screen: Withholding (W-4)
Overview
| 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 › 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. |
| Table | hr.employee_tax_setup · 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/employee-tax-setupList withholding (w-4)
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",
"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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Required | Description |
|---|---|---|---|
employee_id | uuid | Yes | Employee |
jurisdiction | text | No | Jurisdiction — 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. |
authority | text | No | Authority |
effective_from | date | No | Effective from |
effective_to | date | No | Effective to |
filing_status | text | No | Filing status |
multiple_jobs | boolean | No | Multiple jobs or spouse works (step 2c) |
dependents_amount | numeric | No | Dependents claimed (step 3) |
other_income | numeric | No | Other income (step 4a) |
deductions | numeric | No | Deductions (step 4b) |
extra_withholding | numeric | No | Extra withholding a period (step 4c) |
allowances | integer | No | State allowances — State certificate only. Empty: one for a single filer, two for married. |
is_legacy_w4 | boolean | No | Is legacy w4 |
exempt_from_withholding | boolean | No | Claims exemption |
additional_percent | numeric | No | Additional percent |
signed_on | date | No | Signed on |
source | text | No | Source |
additional_allowances | integer | No | Additional / estimated deduction allowances — California DE 4 line 1b, Illinois IL-W-4 line 2, and the like. |
dependents_count | integer | No | Dependents (state) |
elected_rate | numeric | No | Elected rate (Arizona A-4) — As a fraction: 0.025 for 2.5%. |
reciprocity_waived | boolean | No | Withhold 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
| 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 |
|---|---|---|---|
employee_id | uuid | Yes | Employee |
jurisdiction | text | No | Jurisdiction — 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. |
authority | text | No | Authority |
effective_from | date | No | Effective from |
effective_to | date | No | Effective to |
filing_status | text | No | Filing status |
multiple_jobs | boolean | No | Multiple jobs or spouse works (step 2c) |
dependents_amount | numeric | No | Dependents claimed (step 3) |
other_income | numeric | No | Other income (step 4a) |
deductions | numeric | No | Deductions (step 4b) |
extra_withholding | numeric | No | Extra withholding a period (step 4c) |
allowances | integer | No | State allowances — State certificate only. Empty: one for a single filer, two for married. |
is_legacy_w4 | boolean | No | Is legacy w4 |
exempt_from_withholding | boolean | No | Claims exemption |
additional_percent | numeric | No | Additional percent |
signed_on | date | No | Signed on |
source | text | No | Source |
additional_allowances | integer | No | Additional / estimated deduction allowances — California DE 4 line 1b, Illinois IL-W-4 line 2, and the like. |
dependents_count | integer | No | Dependents (state) |
elected_rate | numeric | No | Elected rate (Arizona A-4) — As a fraction: 0.025 for 2.5%. |
reciprocity_waived | boolean | No | Withhold 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
| 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/employee-tax-setup/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/employee-tax-setup/{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/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.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
employee_id | uuid | read, write | Employee |
jurisdiction | text | read, write | Jurisdiction — 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. |
authority | text | read, write | Authority |
effective_from | date | read, write | Effective from |
effective_to | date | read, write | Effective to |
filing_status | text | read, write | Filing status |
multiple_jobs | boolean | read, write | Multiple jobs or spouse works (step 2c) |
dependents_amount | numeric | read, write | Dependents claimed (step 3) |
other_income | numeric | read, write | Other income (step 4a) |
deductions | numeric | read, write | Deductions (step 4b) |
extra_withholding | numeric | read, write | Extra withholding a period (step 4c) |
allowances | integer | read, write | State allowances — State certificate only. Empty: one for a single filer, two for married. |
is_legacy_w4 | boolean | read, write | Is legacy w4 |
exempt_from_withholding | boolean | read, write | Claims exemption |
additional_percent | numeric | read, write | Additional percent |
signed_on | date | read, write | Signed on |
source | text | read, write | Source |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
additional_allowances | integer | read, write | Additional / estimated deduction allowances — California DE 4 line 1b, Illinois IL-W-4 line 2, and the like. |
dependents_count | integer | read, write | Dependents (state) |
elected_rate | numeric | read, write | Elected rate (Arizona A-4) — As a fraction: 0.025 for 2.5%. |
reciprocity_waived | boolean | read, write | Withhold the work state despite reciprocity — Tick when the employee has not filed the non-residence certificate. |
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_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 › Withholding (W-4) 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.