Delete Employee Scheduled Deductions
Deletes employee scheduled deductions in a batch.
Error Details:
- 400 Bad Request — request body is empty or contains no IDs
- 404 Not Found — one or more EmployeeDeductionIds do not exist or reference deductions you do not have access to
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
}{
"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) Not every earning accepts every amount type — check `acceptedAmountTypes` on the corresponding entry from `GET /company-earnings` to see which one(s) this earning allows. **Access control:** All items must belong to companies your integration has access to. In addition, each item's `employeeId` must belong to that same `companyId` — items where the employee doesn't resolve, or resolves to a different company, are silently excluded from creation. **Error Details:** - **400 Bad Request** — request body is empty, batch exceeds 500 items, a company is inaccessible, or amount validation fails
Delete Pending Paycheck Deductions DELETE
Deletes pending paycheck deductions in a batch. **Access control:** All ids must reference pending paycheck deductions 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