Get Employee Scheduled Deductions

Server URLloading...

GET

/employee-scheduled-deductions

Send

Authorization

Query

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

Query Parameters

Response Body

curl -X GET "https://external-app-prod.netchexonline.net/employee-scheduled-deductions?api-version=3.0"

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalItemsCount": 0,
  "items": [
    {
      "employeeDeductionId": 0,
      "employeeId": 0,
      "companyDeductionId": 0,
      "companyId": 0,
      "categoryGroup": "voluntary",
      "isLocked": true,
      "isActive": true,
      "voluntaryDeduction": {
        "employeeContributionAmount": {
          "flatAmount": 0,
          "percentage": 0
        },
        "frequency": "oneTime",
        "effectiveFrom": "2019-08-24T14:15:22Z",
        "effectiveTo": "2019-08-24T14:15:22Z",
        "isEmployerContributionOverride": true,
        "employerContributionAmount": {
          "flatAmount": 0,
          "percentage": 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
}