Get Pending Paycheck Earnings
Returns a paginated list of pending paycheck earnings. 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).
Optional Filters:
organization-id— limit to earnings for companies belonging to these organizationscompany-ids— limit to earnings for these companiesemployee-ids— limit to earnings for these employees. Employees belonging to companies that your integration cannot access are automatically excluded by the company-level access check; no error is returned for inaccessible employee IDs.company-earning-id— limit to a specific earning typepending-paycheck-earning-ids— look up specific records by ID; when supplied, date filters are ignoredexternal-unique-id+data-source— look up a record by the ID assigned by the originating system (both must be provided together)effective-date-from/effective-date-to— inclusive date bounds. Required unless filtering bypending-paycheck-earning-ids. Both dates must be supplied together. Date range cannot exceed 365 days.
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-date-fromis aftereffective-date-to, or the date range exceeds 365 days
Authorization
XApiKey Your API key.
In: header
Query Parameters
API version
"3.0""3.0"Limit results to earnings for employees in companies belonging to this organization.
uuidLimit results to earnings for employees in these companies.
Limit results to earnings for these employees.
Limit results to earnings of this earning type.
int64Limit results to these specific pending paycheck earning records.
Look up a record by the ID assigned by the originating system. Must be used together with data-source.
uuidThe name of the originating system. Must be used together with external-unique-id.
Start of the effective date range (inclusive, YYYY-MM-DD). Required unless filtering by pending-paycheck-earning-ids.
date-timeEnd of the effective date range (inclusive, YYYY-MM-DD). Required unless filtering by pending-paycheck-earning-ids.
date-timePage 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/pending-paycheck-earnings?api-version=3.0"{
"pageNumber": 0,
"pageSize": 0,
"totalItemsCount": 0,
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"externalUniqueId": "b3ff0c58-1ba3-4d2b-a686-e5afec0c4690",
"employeeId": 0,
"companyId": 0,
"companyEarningId": 0,
"laborDistributedDepartmentId": 0,
"laborDistributedClientProject": {
"clientId": 0,
"projectId": 0
},
"laborDistributedJobCode": "string",
"workersCompensationCode": "string",
"flatAmount": {
"amount": 0.1
},
"unitsAmount": {
"hours": 0.1
},
"unitsAndRateAmount": {
"hours": 0.1,
"rate": 0.1
},
"date": "2019-08-24",
"dataSource": "string"
}
]
}{
"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
}Get Pending Paycheck Deductions GET
Returns a paginated list of pending paycheck deductions. A pending paycheck deduction is a one-time amount to be withheld from an employee's current or upcoming payroll run for a specific deduction type (e.g., a one-time benefit deduction). **Optional Filters:** - `organization-id` — limit to deductions for companies belonging to these organizations - `company-ids` — limit to deductions for these companies - `employee-ids` — limit to deductions for these employees. Employees belonging to companies that your integration cannot access are automatically excluded by the company-level access check; no error is returned for inaccessible employee IDs. - `company-deduction-id` — limit to a specific deduction type - `pending-paycheck-deduction-ids` — look up specific records by ID; when supplied, date filters are ignored - `external-unique-id` + `data-source` — look up a record by the ID assigned by the originating system (both must be provided together) - `effective-date-from` / `effective-date-to` — inclusive date bounds. **Required** unless filtering by `pending-paycheck-deduction-ids`. Both dates must be supplied together. Date range cannot exceed 365 days. 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-date-from` is after `effective-date-to`, or the date range exceeds 365 days
Update Employee Scheduled Deductions PUT
Creates or updates employee scheduled deductions in a batch. A scheduled deduction is a recurring or one-time amount withheld from an employee's paycheck for a specific deduction type. If an employee already has a deduction for the specified type, it is updated; otherwise, a new one is created. Currently supports **Voluntary** deductions only. All changes within a single request succeed or fail together (transactional). Maximum of 500 deductions per request. **Error Details:** - **400 Bad Request** — request body is empty, batch exceeds 500 items, or validation errors in individual items