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 organizationscompany-ids— limit to deductions for these companiescategory— 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 Your API key.
In: header
Query Parameters
API version
"3.0""3.0"Limit results to deductions for companies belonging to this organization.
uuidLimit results to deductions for these companies.
Limit results to deductions of this category.
"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 (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 <= 500Response 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 Pending Paycheck Earnings DELETE
Deletes pending paycheck earnings in a batch. **Access control:** All ids must reference pending paycheck earnings belonging to companies your integration has access to. **Error Details:** - **400 Bad Request** — request body is empty, batch exceeds 500 items, or one or more ids do not exist or reference companies the user does not have access to
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. **acceptedAmountTypes:** Tells you which request-body field(s) — `flatAmount`, `unitsAmount`, and/or `unitsAndRateAmount` — this earning accepts on `POST /pending-paycheck-earnings`, so you don't have to guess or trial-and-error. Empty if this earning's calculation method isn't supported by that endpoint.