Delete Employee Scheduled Deductions
Deletes employee scheduled deductions in a batch.
Error Details:
- 400 Bad Request — request body is empty or contains no IDs
Authorization
XApiKey Your API key.
In: header
Query Parameters
API version
"3.0""3.0"Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X DELETE "https://external-app-prod.netchexonline.net/employee-scheduled-deductions?api-version=3.0" \ -H "Content-Type: application/json" \ -d '{}'{
"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
}Create Pending Paycheck Earnings POST
Creates pending paycheck earnings in a batch. A pending paycheck earning is a one-time amount to be included in an employee's current or upcoming payroll run for a specific earning type (e.g., a bonus or additional hours). Each item must specify **exactly one** amount type: - `flatAmount` — a fixed dollar amount (`amount` must be non-zero) - `unitsAmount` — a number of units at the earning type's configured rate (`units` must be non-zero) - `unitsAndRateAmount` — a number of units at a custom rate (`units` must be non-zero; `rate` must be greater than zero) **Access control:** All items must belong to companies your integration has access to. **Error Details:** - **400 Bad Request** — request body is empty, batch exceeds 500 items, a company is inaccessible, or amount validation fails
Get Company Deductions GET
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.