DocumentationAPI Reference
Request Access
Payroll

Create Pending Paycheck Earnings

POST
/pending-paycheck-earnings

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

Authorization

XApiKey
X-API-KEY<token>

Your API key.

In: header

Query Parameters

api-version*string

API version

Default"3.0"
Value in"3.0"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://external-app-prod.netchexonline.net/pending-paycheck-earnings?api-version=3.0" \  -H "Content-Type: application/json" \  -d '[    {}  ]'
[
  {
    "ids": [
      "string"
    ],
    "externalUniqueId": "string",
    "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
}

Create Pending Paycheck Deductions POST

Creates pending paycheck deductions in a batch. 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). Each item must include a `flatAmount` (the only supported amount type for deductions). At least one of `flatAmount.employeeAmount` or `flatAmount.employerAmount` must be non-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

Delete Employee Scheduled Deductions DELETE

Deletes employee scheduled deductions in a batch. **Error Details:** - **400 Bad Request** — request body is empty or contains no IDs