DocumentationAPI Reference
Request Access
Payroll

Get Company Deductions

GET
/company-deductions

Returns a paginated list of deduction types configured for companies. A company deduction is a deduction template defined at the company level (e.g., Health Insurance or 401k) that can be applied to employee paychecks.

Optional Filters:

  • organization-id — limit to deductions for companies belonging to these organizations
  • company-ids — limit to deductions for these companies
  • category — limit to deductions of a specific category

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
X-API-KEY<token>

Your API key.

In: header

Query Parameters

api-version*string

API version

Default"3.0"
Value in"3.0"
organization-id?string

Limit results to deductions for companies belonging to this organization.

Formatuuid
company-ids?array<>

Limit results to deductions for these companies.

category?string

Limit results to deductions of this category.

Value in"section125Dental" | "section125Dependent" | "section125EyeCare" | "section125HealthLTD" | "section125Health" | "section125HealthSTD" | "section125HSACard" | "section125Life" | "section125Misc" | "section125MiscOther" | "retirement401k" | "retirement401kCatchUp" | "retirement401kLoan" | "retirement401kLoan2" | "retirement401kLoan3" | "retirement401kLoan4" | "retirement401kOther" | "retirement401kRothCatchUp" | "retirement401kRoth" | "retirement403b" | "retirement403bCatchUp" | "retirement403bOther" | "retirement403bRothCatchUp" | "deferredComp409a" | "retirement457b" | "retirement457bOther" | "retirement457bRothCatchUp" | "retirement457bRoth" | "retirement501c18d" | "dentalInsurance" | "eyeCareInsurance" | "healthInsurance" | "healthInsuranceFSA" | "healthInsuranceHRA" | "healthInsuranceLTD" | "healthInsuranceSI" | "healthInsuranceSTD" | "lifeInsurance" | "hSACard" | "garnishment" | "garnishment2" | "garnishment3" | "garnishment4" | "garnishment5" | "charity" | "childSupport" | "deferredCompensation" | "dependent" | "dependentFSA" | "incomeTax" | "levy" | "miscellaneous" | "miscellaneousOther" | "movingExpense" | "rent" | "sERS" | "simpleIRA" | "simpleIRAOther" | "unionDues"
page-number?integer

Page number (1-based). Defaults to 1 if not specified.

Formatint32
Range1 <= value <= 2147483647
page-size?integer

Number of items per page. Defaults to 100 if not specified. Maximum 500.

Formatint32
Range1 <= value <= 500

Response Body

curl -X GET "https://external-app-prod.netchexonline.net/company-deductions?api-version=3.0"
{
  "pageNumber": 0,
  "pageSize": 0,
  "totalItemsCount": 0,
  "items": [
    {
      "id": 0,
      "code": "string",
      "name": "string",
      "calculationMethod": "percent401k",
      "category": "section125Dental",
      "companyId": 0
    }
  ]
}
{
  "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
}

Delete Employee Scheduled Deductions DELETE

Deletes employee scheduled deductions in a batch. **Error Details:** - **400 Bad Request** — request body is empty or contains no IDs

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.