HRMS · Tax & Filing
State Rates
How each state withholds: no tax, a flat rate, its graduated scale (State Brackets) or California’s DE 44. The note says which year each figure is from — check it against the state’s employer guide before a live run.
/api/hrms/state-tax-ratesPublished as /api/v1/state-tax-ratesOverview
| 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 › State Rates 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.state_tax_rates |
| 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/state-tax-ratesList state rates
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",
"tax_year": 10,
"state_code": "STA-000001",
"state_name": "Example",
"has_income_tax": true,
"flat_rate": "1250.00",
"personal_exemption": "1250.00",
"standard_deduction": "1250.00",
"supplemental_rate": "1250.00",
"suta_rate": "1250.00",
"suta_wage_base": "1250.00",
"disability_rate": "1250.00",
"disability_wage_base": "1250.00",
"paid_leave_rate": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/state-tax-rates?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/state-tax-rates/{id}Read one state tax rates
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",
"tax_year": 10,
"state_code": "STA-000001",
"state_name": "Example",
"has_income_tax": true,
"flat_rate": "1250.00",
"personal_exemption": "1250.00",
"standard_deduction": "1250.00",
"supplemental_rate": "1250.00",
"suta_rate": "1250.00",
"suta_wage_base": "1250.00",
"disability_rate": "1250.00",
"disability_wage_base": "1250.00",
"paid_leave_rate": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/state-tax-rates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/state-tax-ratesCreate a state tax rates
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
tax_year | integer | Yes | Tax year |
state_code | text | Yes | State code |
state_name | text | No | State name |
has_income_tax | boolean | No | Levies income tax |
flat_rate | numeric | No | Flat rate — For a flat state. As a fraction: 0.0495 for 4.95%. |
personal_exemption | numeric | No | Deduction per allowance |
standard_deduction | numeric | No | Standard deduction — single |
supplemental_rate | numeric | No | Supplemental rate |
suta_rate | numeric | No | SUTA rate |
suta_wage_base | numeric | No | SUTA wage base |
reciprocity_states | _text | No | Reciprocity states |
method | text | No | Method — graduated reads State Brackets; ca_de44 is California’s Method B. Allowed: none flat graduated ca_de44 |
standard_deduction_married | numeric | No | Standard deduction — married |
standard_deduction_hoh | numeric | No | Standard deduction — head of household |
allowance_credit | numeric | No | Credit per allowance — An annual tax credit (CA, DE, OR), as distinct from a deduction. |
dependent_exemption | numeric | No | Deduction per dependent |
low_income_exempt_single | numeric | No | Low-income exemption — single |
low_income_exempt_married | numeric | No | Low-income exemption — married / HOH |
federal_tax_deductible | boolean | No | Federal tax is deductible |
federal_deduction_cap | numeric | No | Federal deduction cap |
resident_credit | boolean | No | Credits tax withheld by a work state |
nonresidents_exempt | boolean | No | Does not tax non-residents |
source_note | text | No | Source |
Sample body
{
"tax_year": 10,
"state_code": "STA-000001",
"state_name": "Example",
"has_income_tax": true,
"flat_rate": "1250.00",
"personal_exemption": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tax_year": 10,
"state_code": "STA-000001",
"state_name": "Example",
"has_income_tax": true,
"flat_rate": "1250.00",
"personal_exemption": "1250.00",
"standard_deduction": "1250.00",
"supplemental_rate": "1250.00",
"suta_rate": "1250.00",
"suta_wage_base": "1250.00",
"disability_rate": "1250.00",
"disability_wage_base": "1250.00",
"paid_leave_rate": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/state-tax-rates" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"tax_year":10,"state_code":"STA-000001","state_name":"Example","has_income_tax":true,"flat_rate":"1250.00","personal_exemption":"1250.00"}'PUT/api/hrms/state-tax-rates/{id}Change a state tax rates
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 |
|---|---|---|---|
tax_year | integer | Yes | Tax year |
state_code | text | Yes | State code |
state_name | text | No | State name |
has_income_tax | boolean | No | Levies income tax |
flat_rate | numeric | No | Flat rate — For a flat state. As a fraction: 0.0495 for 4.95%. |
personal_exemption | numeric | No | Deduction per allowance |
standard_deduction | numeric | No | Standard deduction — single |
supplemental_rate | numeric | No | Supplemental rate |
suta_rate | numeric | No | SUTA rate |
suta_wage_base | numeric | No | SUTA wage base |
reciprocity_states | _text | No | Reciprocity states |
method | text | No | Method — graduated reads State Brackets; ca_de44 is California’s Method B. Allowed: none flat graduated ca_de44 |
standard_deduction_married | numeric | No | Standard deduction — married |
standard_deduction_hoh | numeric | No | Standard deduction — head of household |
allowance_credit | numeric | No | Credit per allowance — An annual tax credit (CA, DE, OR), as distinct from a deduction. |
dependent_exemption | numeric | No | Deduction per dependent |
low_income_exempt_single | numeric | No | Low-income exemption — single |
low_income_exempt_married | numeric | No | Low-income exemption — married / HOH |
federal_tax_deductible | boolean | No | Federal tax is deductible |
federal_deduction_cap | numeric | No | Federal deduction cap |
resident_credit | boolean | No | Credits tax withheld by a work state |
nonresidents_exempt | boolean | No | Does not tax non-residents |
source_note | text | No | Source |
Sample body
{
"tax_year": 10,
"state_code": "STA-000001"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tax_year": 10,
"state_code": "STA-000001",
"state_name": "Example",
"has_income_tax": true,
"flat_rate": "1250.00",
"personal_exemption": "1250.00",
"standard_deduction": "1250.00",
"supplemental_rate": "1250.00",
"suta_rate": "1250.00",
"suta_wage_base": "1250.00",
"disability_rate": "1250.00",
"disability_wage_base": "1250.00",
"paid_leave_rate": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/state-tax-rates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"tax_year":10,"state_code":"STA-000001"}'DELETE/api/hrms/state-tax-rates/{id}Delete a state tax rates
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/state-tax-rates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/state-tax-rates/{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/state-tax-rates/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 state tax rates, 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 |
tax_year | integer | read, write | Tax year |
state_code | text | read, write | State code |
state_name | text | read, write | State name |
has_income_tax | boolean | read, write | Levies income tax |
flat_rate | numeric | read, write | Flat rate — For a flat state. As a fraction: 0.0495 for 4.95%. |
personal_exemption | numeric | read, write | Deduction per allowance |
standard_deduction | numeric | read, write | Standard deduction — single |
supplemental_rate | numeric | read, write | Supplemental rate |
suta_rate | numeric | read, write | SUTA rate |
suta_wage_base | numeric | read, write | SUTA wage base |
disability_rate | numeric | read only | Disability rate |
disability_wage_base | numeric | read only | Disability wage base |
paid_leave_rate | numeric | read only | Paid leave rate |
reciprocity_states | _text | read, write | Reciprocity states |
method | text | read, write | Method — graduated reads State Brackets; ca_de44 is California’s Method B. Allowed: none flat graduated ca_de44 |
standard_deduction_married | numeric | read, write | Standard deduction — married |
standard_deduction_hoh | numeric | read, write | Standard deduction — head of household |
allowance_credit | numeric | read, write | Credit per allowance — An annual tax credit (CA, DE, OR), as distinct from a deduction. |
dependent_exemption | numeric | read, write | Deduction per dependent |
low_income_exempt_single | numeric | read, write | Low-income exemption — single |
low_income_exempt_married | numeric | read, write | Low-income exemption — married / HOH |
federal_tax_deductible | boolean | read, write | Federal tax is deductible |
federal_deduction_cap | numeric | read, write | Federal deduction cap |
resident_credit | boolean | read, write | Credits tax withheld by a work state |
nonresidents_exempt | boolean | read, write | Does not tax non-residents |
source_note | text | read, write | Source |
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_at | timestamp with time zone | read only | Created at |
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 › State Rates 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.