TRANXACT.AI Help

HRMS · Tax & Filing

Withholding Tables

The percentage-method brackets. "Multiple jobs" is the standard table with every threshold halved, which is what step 2(c) of the W-4 selects.

Type REST6 operationsBase path /api/hrms/tax-bracketsPublished as /api/v1/tax-brackets

Download specification (OpenAPI 3.1) Screen: Withholding Tables

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 Tables 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.tax_brackets
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/tax-bracketsList withholding tables

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",
      "tax_year": 10,
      "jurisdiction": "text",
      "filing_status": "draft",
      "table_variant": "standard",
      "bracket_no": 10,
      "income_from": "1250.00",
      "income_to": "1250.00",
      "base_tax": "1250.00",
      "rate": "1250.00",
      "xf_text_1": "text",
      "xf_text_2": "text",
      "xf_text_3": "text",
      "xf_text_4": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_year": 10,
  "jurisdiction": "text",
  "filing_status": "draft",
  "table_variant": "standard",
  "bracket_no": 10,
  "income_from": "1250.00",
  "income_to": "1250.00",
  "base_tax": "1250.00",
  "rate": "1250.00",
  "xf_text_1": "text",
  "xf_text_2": "text",
  "xf_text_3": "text",
  "xf_text_4": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
tax_yearintegerYesTax year
jurisdictiontextNoJurisdiction
filing_statustextYesFiling status
table_varianttextNoTable
Allowed: standard multiple_jobs
bracket_nointegerYesBracket
income_fromnumericYesFrom
income_tonumericNoTo
base_taxnumericNoBase tax
ratenumericYesRate

Sample body

{
  "tax_year": 10,
  "filing_status": "draft",
  "bracket_no": 10,
  "income_from": "1250.00",
  "rate": "1250.00",
  "jurisdiction": "text",
  "table_variant": "standard",
  "income_to": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_year": 10,
  "jurisdiction": "text",
  "filing_status": "draft",
  "table_variant": "standard",
  "bracket_no": 10,
  "income_from": "1250.00",
  "income_to": "1250.00",
  "base_tax": "1250.00",
  "rate": "1250.00",
  "xf_text_1": "text",
  "xf_text_2": "text",
  "xf_text_3": "text",
  "xf_text_4": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/tax-brackets" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tax_year":10,"filing_status":"draft","bracket_no":10,"income_from":"1250.00","rate":"1250.00","jurisdiction":"text","table_variant":"standard","income_to":"1250.00"}'
PUT/api/hrms/tax-brackets/{id}Change a tax brackets

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
tax_yearintegerYesTax year
jurisdictiontextNoJurisdiction
filing_statustextYesFiling status
table_varianttextNoTable
Allowed: standard multiple_jobs
bracket_nointegerYesBracket
income_fromnumericYesFrom
income_tonumericNoTo
base_taxnumericNoBase tax
ratenumericYesRate

Sample body

{
  "tax_year": 10,
  "filing_status": "draft"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_year": 10,
  "jurisdiction": "text",
  "filing_status": "draft",
  "table_variant": "standard",
  "bracket_no": 10,
  "income_from": "1250.00",
  "income_to": "1250.00",
  "base_tax": "1250.00",
  "rate": "1250.00",
  "xf_text_1": "text",
  "xf_text_2": "text",
  "xf_text_3": "text",
  "xf_text_4": "text"
}

Sample request

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

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/tax-brackets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/tax-brackets/{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/tax-brackets/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 tax brackets, 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
tax_yearintegerread, writeTax year
jurisdictiontextread, writeJurisdiction
filing_statustextread, writeFiling status
table_varianttextread, writeTable
Allowed: standard multiple_jobs
bracket_nointegerread, writeBracket
income_fromnumericread, writeFrom
income_tonumericread, writeTo
base_taxnumericread, writeBase tax
ratenumericread, writeRate
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 › Withholding Tables 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.