Get Company Tax Codes
Returns a paginated list of tax codes configured for companies. A company tax code identifies a tax jurisdiction or withholding obligation the company is registered for (e.g., a state income tax or local withholding code).
Optional Filters:
organization-id— limit to tax codes for companies belonging to these organizationscompany-ids— limit to tax codes for these companiesinclude-federal— set totrueto include federal tax codes alongside state and local codes
Multiple filters combine with AND logic; values within one parameter combine with OR.
Access control: Results are limited to companies your integration has access to. When organization-id is supplied, only results from organizations containing at least one accessible company are included. Inaccessible IDs in filter parameters are silently excluded; if none match, an empty list is returned.
Authorization
XApiKey Your API key.
In: header
Query Parameters
API version
"3.0""3.0"Limit results to tax codes for companies belonging to this organization.
uuidLimit results to tax codes for these companies.
Page number (1-based). Defaults to 1 if not specified.
int321 <= value <= 2147483647Number of items per page. Defaults to 100 if not specified. Maximum 500.
int321 <= value <= 500When true, includes federal tax codes in the results. Defaults to false when omitted.
Response Body
curl -X GET "https://external-app-prod.netchexonline.net/company-tax-codes?api-version=3.0"{
"pageNumber": 0,
"pageSize": 0,
"totalItemsCount": 0,
"items": [
{
"companyId": 0,
"companyCode": "string",
"taxCodeId": 0,
"taxCode": "string",
"taxTableCode": "string",
"taxDescription": "string",
"taxType": "string",
"payeeCode": "string",
"symmetry": {
"taxCodeId": 0,
"taxCode": "string",
"taxDescription": "string",
"psdCode": "string"
},
"w2Id": "string",
"sutaTaxRateAmount": 0.1
}
]
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}Get Company Earnings GET
Returns a paginated list of earning types configured for companies. A company earning is a pay code that defines how employees are compensated (e.g., Regular, Overtime, or Bonus). **Optional Filters:** - `organization-id` — limit to earnings for companies belonging to these organizations - `company-ids` — limit to earnings for these companies Multiple filters combine with AND logic; values within one parameter combine with OR. **Access control:** Results are limited to companies your integration has access to. When `organization-id` is supplied, only results from organizations containing at least one accessible company are included. Inaccessible IDs in filter parameters are silently excluded; if none match, an empty list is returned.
Get Employee Scheduled Deductions GET
Returns a paginated list of scheduled deductions for employees. A scheduled deduction is a recurring or one-time amount withheld from an employee's paycheck for a specific deduction type (e.g., a weekly 401k contribution). **Optional Filters:** - `organization-id` — limit to deductions for employees in companies belonging to these organizations - `company-ids` — limit to deductions for employees in these companies - `employee-ids` — limit to deductions for these employees - `company-deduction-ids` — limit to deductions of these deduction types - `status` — `Active` returns active deductions; `InActive` returns stopped deductions only - `effective-from` / `effective-to` — inclusive date bounds. **Required** when filtering by `organization-id` or `company-ids` only. Date range cannot exceed 365 days. **Date range behavior:** When both dates are provided, returns deductions that started on or after `effective-from` AND ended on or before `effective-to` (or have no end date). One-time deductions are included if their start date falls within the range. **EffectiveTo behavior:** `effectiveTo` is always `null` for one-time deductions. For recurring deductions, it is returned when set. Multiple filters combine with AND logic; values within one parameter combine with OR. **Access control:** Results are limited to companies your integration has access to. When `organization-id` is supplied, only results from organizations containing at least one accessible company are included. Inaccessible IDs in filter parameters are silently excluded; if none match, an empty list is returned. **Error Details:** - **400 Bad Request** — `effective-from` is after `effective-to`, or the date range exceeds 365 days