TRANXACT.AI Help

HRMS · US Employment Forms

W-4 Submissions

Forms W-4 employees signed in self service. Each took effect from the next pay period as a new withholding record (Employee Tax Setup); the old one is kept. A W-4 needs no approval -- acknowledge that HR has seen it.

Type REST8 operationsBase path /api/hrms/w4-submissionsPublished as /api/v1/w4-submissions

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

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 › W-4 Submissions 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.w4_submissions · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

8 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/hrms/w4-submissionsList w-4 submissions

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",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "submission_no": "SUB-000001",
      "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tax_year": 10,
      "filing_status": "draft",
      "multiple_jobs": true,
      "children_under17": 10,
      "other_dependents": 10,
      "dependents_amount": "1250.00",
      "other_income": "1250.00",
      "deductions": "1250.00",
      "extra_withholding": "1250.00",
      "exempt": true
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/hrms/w4-submissions?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/w4-submissions/{id}Read one form w-4

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "submission_no": "SUB-000001",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_year": 10,
  "filing_status": "draft",
  "multiple_jobs": true,
  "children_under17": 10,
  "other_dependents": 10,
  "dependents_amount": "1250.00",
  "other_income": "1250.00",
  "deductions": "1250.00",
  "extra_withholding": "1250.00",
  "exempt": true
}

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

Sample request

curl "https://demo.tranxact.ai/api/hrms/w4-submissions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/w4-submissions/{id}/acknowledgeAcknowledge

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):

note

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/w4-submissions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/acknowledge" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"note":"value"}'
GET/api/hrms/w4-submissions/{id}/pdfPdf

Path parameters

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

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/w4-submissions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/pdf" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/w4-submissionsPost w-4 submissions

No body is required.

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/w4-submissions" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/w4-submissions/{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/w4-submissions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/hrms/w4-submissions/{id}Put w-4 submissions

Path parameters

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

No body is required.

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 PUT "https://demo.tranxact.ai/api/hrms/w4-submissions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/hrms/w4-submissions/{id}Delete w-4 submissions

Path parameters

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

No body is required.

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 DELETE "https://demo.tranxact.ai/api/hrms/w4-submissions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a form w-4, 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
org_unit_iduuidread onlyOrg unit id
submission_notextread onlySubmission no
employee_iduuidread onlyEmployee id
tax_yearintegerread onlyTax year
filing_statustextread onlyFiling status
multiple_jobsbooleanread onlyMultiple jobs
children_under17integerread onlyChildren under17
other_dependentsintegerread onlyOther dependents
dependents_amountnumericread onlyDependents amount
other_incomenumericread onlyOther income
deductionsnumericread onlyDeductions
extra_withholdingnumericread onlyExtra withholding
exemptbooleanread onlyExempt
effective_fromdateread onlyEffective from
tax_setup_iduuidread onlyTax setup id
previous_setup_iduuidread onlyPrevious setup id
tax_form_iduuidread onlyTax form id
document_iduuidread onlyDocument id
signed_nametextread onlySigned name
signed_attimestamp with time zoneread onlySigned at
signed_iptextread onlySigned ip
signed_user_agenttextread onlySigned user agent
attestationtextread onlyAttestation
content_sha256textread onlyContent sha256
statustextread onlyStatus
acknowledged_byuuidread onlyAcknowledged by
acknowledged_attimestamp with time zoneread onlyAcknowledged at
hr_notetextread onlyHr note
submitted_byuuidread onlySubmitted by
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 › W-4 Submissions 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.