HRMS · Tax & Filing
Local Tax Jurisdictions
Cities, counties, school districts, PA political subdivisions and transit districts, with their resident and non-resident rates and the rule that decides between them.
/api/hrms/local-tax-jurisdictionsPublished as /api/v1/local-tax-jurisdictionsDownload specification (OpenAPI 3.1) Screen: Local Tax Jurisdictions
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 › Local Tax Jurisdictions 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.local_tax_jurisdictions |
| 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/local-tax-jurisdictionsList local tax jurisdictions
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,
"code": "COD-000001",
"name": "Example",
"state_code": "STA-000001",
"jurisdiction_type": "city",
"psd_code": "PSD-000001",
"tax_kind": "income",
"method": "flat_rate",
"wage_basis": "state_wages",
"resident_rate": "1250.00",
"nonresident_rate": "1250.00",
"resident_applies": true,
"nonresident_applies": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/local-tax-jurisdictions?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/local-tax-jurisdictions/{id}Read one local tax jurisdictions
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,
"code": "COD-000001",
"name": "Example",
"state_code": "STA-000001",
"jurisdiction_type": "city",
"psd_code": "PSD-000001",
"tax_kind": "income",
"method": "flat_rate",
"wage_basis": "state_wages",
"resident_rate": "1250.00",
"nonresident_rate": "1250.00",
"resident_applies": true,
"nonresident_applies": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/local-tax-jurisdictions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/local-tax-jurisdictionsCreate a local tax jurisdictions
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
tax_year | integer | Yes | Tax year |
code | text | Yes | Code — NYC, PA-510101, OH-COLUMBUS… |
name | text | Yes | Name |
state_code | text | Yes | State code |
jurisdiction_type | text | No | Type Allowed: city county school_district municipal transit_district state_district |
psd_code | text | No | PSD / district number |
tax_kind | text | No | Tax Allowed: income occupational lst head_tax transit surcharge |
method | text | No | Resident tax worked out as Allowed: flat_rate graduated flat_amount percent_of_state_tax percent_of_state_taxable |
wage_basis | text | No | Charged on Allowed: state_wages fica_wages gross fit_wages |
resident_rate | numeric | No | Resident rate |
nonresident_rate | numeric | No | Non-resident rate |
resident_applies | boolean | No | Taxes residents |
nonresident_applies | boolean | No | Taxes non-residents |
nonresident_out_of_state_only | boolean | No | Non-residents only when out of state — Indiana counties. |
resident_requires_work_here | boolean | No | Residents only for work done here — Kentucky occupational licence taxes. |
pa_act32 | boolean | No | Pennsylvania Act 32 (higher of home and work) |
flat_amount | numeric | No | Flat amount (employee) |
employer_flat_amount | numeric | No | Flat amount (employer) |
flat_frequency | text | No | Flat amount is Allowed: annual monthly per_period |
exempt_below | numeric | No | Exempt below |
exempt_below_period | text | No | Exempt below, per Allowed: annual monthly |
employer_rate | numeric | No | Employer rate |
wage_base | numeric | No | Annual wage base |
annual_max | numeric | No | Annual maximum |
exemption_amount | numeric | No | Exemption per allowance |
standard_deduction_single | numeric | No | Deduction — single |
standard_deduction_married | numeric | No | Deduction — married |
credit_factor | numeric | No | Residence credit share — Of the tax a work locality took: 1 for all of it, 0.5 for half. |
credit_rate_limit | numeric | No | Residence credit limited to rate |
auto_apply | text | No | Applies without an assignment to Allowed: none work_state resident_state work_or_resident work_state_nonresident |
collector | text | No | Collector |
w2_locality_name | text | No | W-2 box 20 name |
source_note | text | No | Source |
is_active | boolean | No | Active |
Sample body
{
"tax_year": 10,
"code": "COD-000001",
"name": "Example",
"state_code": "STA-000001",
"jurisdiction_type": "city",
"psd_code": "PSD-000001",
"tax_kind": "income",
"method": "flat_rate"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tax_year": 10,
"code": "COD-000001",
"name": "Example",
"state_code": "STA-000001",
"jurisdiction_type": "city",
"psd_code": "PSD-000001",
"tax_kind": "income",
"method": "flat_rate",
"wage_basis": "state_wages",
"resident_rate": "1250.00",
"nonresident_rate": "1250.00",
"resident_applies": true,
"nonresident_applies": true
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/local-tax-jurisdictions" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"tax_year":10,"code":"COD-000001","name":"Example","state_code":"STA-000001","jurisdiction_type":"city","psd_code":"PSD-000001","tax_kind":"income","method":"flat_rate"}'PUT/api/hrms/local-tax-jurisdictions/{id}Change a local tax jurisdictions
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 |
code | text | Yes | Code — NYC, PA-510101, OH-COLUMBUS… |
name | text | Yes | Name |
state_code | text | Yes | State code |
jurisdiction_type | text | No | Type Allowed: city county school_district municipal transit_district state_district |
psd_code | text | No | PSD / district number |
tax_kind | text | No | Tax Allowed: income occupational lst head_tax transit surcharge |
method | text | No | Resident tax worked out as Allowed: flat_rate graduated flat_amount percent_of_state_tax percent_of_state_taxable |
wage_basis | text | No | Charged on Allowed: state_wages fica_wages gross fit_wages |
resident_rate | numeric | No | Resident rate |
nonresident_rate | numeric | No | Non-resident rate |
resident_applies | boolean | No | Taxes residents |
nonresident_applies | boolean | No | Taxes non-residents |
nonresident_out_of_state_only | boolean | No | Non-residents only when out of state — Indiana counties. |
resident_requires_work_here | boolean | No | Residents only for work done here — Kentucky occupational licence taxes. |
pa_act32 | boolean | No | Pennsylvania Act 32 (higher of home and work) |
flat_amount | numeric | No | Flat amount (employee) |
employer_flat_amount | numeric | No | Flat amount (employer) |
flat_frequency | text | No | Flat amount is Allowed: annual monthly per_period |
exempt_below | numeric | No | Exempt below |
exempt_below_period | text | No | Exempt below, per Allowed: annual monthly |
employer_rate | numeric | No | Employer rate |
wage_base | numeric | No | Annual wage base |
annual_max | numeric | No | Annual maximum |
exemption_amount | numeric | No | Exemption per allowance |
standard_deduction_single | numeric | No | Deduction — single |
standard_deduction_married | numeric | No | Deduction — married |
credit_factor | numeric | No | Residence credit share — Of the tax a work locality took: 1 for all of it, 0.5 for half. |
credit_rate_limit | numeric | No | Residence credit limited to rate |
auto_apply | text | No | Applies without an assignment to Allowed: none work_state resident_state work_or_resident work_state_nonresident |
collector | text | No | Collector |
w2_locality_name | text | No | W-2 box 20 name |
source_note | text | No | Source |
is_active | boolean | No | Active |
Sample body
{
"tax_year": 10,
"code": "COD-000001"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tax_year": 10,
"code": "COD-000001",
"name": "Example",
"state_code": "STA-000001",
"jurisdiction_type": "city",
"psd_code": "PSD-000001",
"tax_kind": "income",
"method": "flat_rate",
"wage_basis": "state_wages",
"resident_rate": "1250.00",
"nonresident_rate": "1250.00",
"resident_applies": true,
"nonresident_applies": true
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/local-tax-jurisdictions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"tax_year":10,"code":"COD-000001"}'DELETE/api/hrms/local-tax-jurisdictions/{id}Delete a local tax jurisdictions
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/local-tax-jurisdictions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/local-tax-jurisdictions/{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/local-tax-jurisdictions/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 local tax jurisdictions, 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 |
code | text | read, write | Code — NYC, PA-510101, OH-COLUMBUS… |
name | text | read, write | Name |
state_code | text | read, write | State code |
jurisdiction_type | text | read, write | Type Allowed: city county school_district municipal transit_district state_district |
psd_code | text | read, write | PSD / district number |
tax_kind | text | read, write | Tax Allowed: income occupational lst head_tax transit surcharge |
method | text | read, write | Resident tax worked out as Allowed: flat_rate graduated flat_amount percent_of_state_tax percent_of_state_taxable |
wage_basis | text | read, write | Charged on Allowed: state_wages fica_wages gross fit_wages |
resident_rate | numeric | read, write | Resident rate |
nonresident_rate | numeric | read, write | Non-resident rate |
resident_applies | boolean | read, write | Taxes residents |
nonresident_applies | boolean | read, write | Taxes non-residents |
nonresident_out_of_state_only | boolean | read, write | Non-residents only when out of state — Indiana counties. |
resident_requires_work_here | boolean | read, write | Residents only for work done here — Kentucky occupational licence taxes. |
pa_act32 | boolean | read, write | Pennsylvania Act 32 (higher of home and work) |
flat_amount | numeric | read, write | Flat amount (employee) |
employer_flat_amount | numeric | read, write | Flat amount (employer) |
flat_frequency | text | read, write | Flat amount is Allowed: annual monthly per_period |
exempt_below | numeric | read, write | Exempt below |
exempt_below_period | text | read, write | Exempt below, per Allowed: annual monthly |
employer_rate | numeric | read, write | Employer rate |
wage_base | numeric | read, write | Annual wage base |
annual_max | numeric | read, write | Annual maximum |
exemption_amount | numeric | read, write | Exemption per allowance |
standard_deduction_single | numeric | read, write | Deduction — single |
standard_deduction_married | numeric | read, write | Deduction — married |
credit_factor | numeric | read, write | Residence credit share — Of the tax a work locality took: 1 for all of it, 0.5 for half. |
credit_rate_limit | numeric | read, write | Residence credit limited to rate |
auto_apply | text | read, write | Applies without an assignment to Allowed: none work_state resident_state work_or_resident work_state_nonresident |
collector | text | read, write | Collector |
w2_locality_name | text | read, write | W-2 box 20 name |
source_note | text | read, write | Source |
is_active | boolean | read, write | Active |
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 › Local Tax Jurisdictions 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.