TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/hrms/state-tax-ratesPublished as /api/v1/state-tax-rates

Download specification (OpenAPI 3.1) Screen: State Rates

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 › 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.
Tablehr.state_tax_rates
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/state-tax-ratesList state rates

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,
      "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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
tax_yearintegerYesTax year
state_codetextYesState code
state_nametextNoState name
has_income_taxbooleanNoLevies income tax
flat_ratenumericNoFlat rate — For a flat state. As a fraction: 0.0495 for 4.95%.
personal_exemptionnumericNoDeduction per allowance
standard_deductionnumericNoStandard deduction — single
supplemental_ratenumericNoSupplemental rate
suta_ratenumericNoSUTA rate
suta_wage_basenumericNoSUTA wage base
reciprocity_states_textNoReciprocity states
methodtextNoMethod — graduated reads State Brackets; ca_de44 is California’s Method B.
Allowed: none flat graduated ca_de44
standard_deduction_marriednumericNoStandard deduction — married
standard_deduction_hohnumericNoStandard deduction — head of household
allowance_creditnumericNoCredit per allowance — An annual tax credit (CA, DE, OR), as distinct from a deduction.
dependent_exemptionnumericNoDeduction per dependent
low_income_exempt_singlenumericNoLow-income exemption — single
low_income_exempt_marriednumericNoLow-income exemption — married / HOH
federal_tax_deductiblebooleanNoFederal tax is deductible
federal_deduction_capnumericNoFederal deduction cap
resident_creditbooleanNoCredits tax withheld by a work state
nonresidents_exemptbooleanNoDoes not tax non-residents
source_notetextNoSource

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

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
state_codetextYesState code
state_nametextNoState name
has_income_taxbooleanNoLevies income tax
flat_ratenumericNoFlat rate — For a flat state. As a fraction: 0.0495 for 4.95%.
personal_exemptionnumericNoDeduction per allowance
standard_deductionnumericNoStandard deduction — single
supplemental_ratenumericNoSupplemental rate
suta_ratenumericNoSUTA rate
suta_wage_basenumericNoSUTA wage base
reciprocity_states_textNoReciprocity states
methodtextNoMethod — graduated reads State Brackets; ca_de44 is California’s Method B.
Allowed: none flat graduated ca_de44
standard_deduction_marriednumericNoStandard deduction — married
standard_deduction_hohnumericNoStandard deduction — head of household
allowance_creditnumericNoCredit per allowance — An annual tax credit (CA, DE, OR), as distinct from a deduction.
dependent_exemptionnumericNoDeduction per dependent
low_income_exempt_singlenumericNoLow-income exemption — single
low_income_exempt_marriednumericNoLow-income exemption — married / HOH
federal_tax_deductiblebooleanNoFederal tax is deductible
federal_deduction_capnumericNoFederal deduction cap
resident_creditbooleanNoCredits tax withheld by a work state
nonresidents_exemptbooleanNoDoes not tax non-residents
source_notetextNoSource

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

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/state-tax-rates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/state-tax-rates/{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/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.

FieldTypeAccessDescription
iduuidread onlyId
tax_yearintegerread, writeTax year
state_codetextread, writeState code
state_nametextread, writeState name
has_income_taxbooleanread, writeLevies income tax
flat_ratenumericread, writeFlat rate — For a flat state. As a fraction: 0.0495 for 4.95%.
personal_exemptionnumericread, writeDeduction per allowance
standard_deductionnumericread, writeStandard deduction — single
supplemental_ratenumericread, writeSupplemental rate
suta_ratenumericread, writeSUTA rate
suta_wage_basenumericread, writeSUTA wage base
disability_ratenumericread onlyDisability rate
disability_wage_basenumericread onlyDisability wage base
paid_leave_ratenumericread onlyPaid leave rate
reciprocity_states_textread, writeReciprocity states
methodtextread, writeMethod — graduated reads State Brackets; ca_de44 is California’s Method B.
Allowed: none flat graduated ca_de44
standard_deduction_marriednumericread, writeStandard deduction — married
standard_deduction_hohnumericread, writeStandard deduction — head of household
allowance_creditnumericread, writeCredit per allowance — An annual tax credit (CA, DE, OR), as distinct from a deduction.
dependent_exemptionnumericread, writeDeduction per dependent
low_income_exempt_singlenumericread, writeLow-income exemption — single
low_income_exempt_marriednumericread, writeLow-income exemption — married / HOH
federal_tax_deductiblebooleanread, writeFederal tax is deductible
federal_deduction_capnumericread, writeFederal deduction cap
resident_creditbooleanread, writeCredits tax withheld by a work state
nonresidents_exemptbooleanread, writeDoes not tax non-residents
source_notetextread, writeSource
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 › State Rates 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.