DocumentationAPI Reference
Request Access
Organization structure

Get Organizations

GET
/organizations

Returns a paginated list of organizations. Each organization has one or more companies.

Optional Filters:

  • organization-ids — limit to these organizations (max 100)
  • company-ids — limit to organizations containing these companies (max 100)

Multiple filters combine with AND logic; values within one parameter combine with OR.

Access control: Only organizations containing at least one company your integration can access are returned. Inaccessible IDs in company-ids are silently excluded; if none match, an empty list is returned. Each organization in the response includes only the companies your integration can access.

Error Details:

  • 400 Bad Request — more than 100 IDs supplied to organization-ids or company-ids, or page-size outside 1–500

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"
page-number?integer

Page number (1-based). Defaults to 1 if not specified.

Formatint32
Range1 <= value <= 2147483647
page-size?integer

Number of items per page. Defaults to 100 if not specified. Maximum 500.

Formatint32
Range1 <= value <= 500
organization-ids?array<>

Optional. Return only organizations with these IDs. Maximum 100 IDs per request.

Itemsitems <= 100
company-ids?array<>

Optional. Return only organizations that contain these companies. Maximum 100 IDs per request.

Itemsitems <= 100

Response Body

curl -X GET "https://external-app-prod.netchexonline.net/organizations?api-version=3.0"
{
  "pageNumber": 0,
  "pageSize": 0,
  "totalItemsCount": 0,
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "companies": [
        {
          "id": 0,
          "code": "string",
          "name": "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 Organization GET

Returns a single organization by ID. The response includes only the companies within it that your integration has access to. **Access control:** Returns 404 if the organization does not exist or your integration does not have access to any company within it. The response includes only the companies your integration can access. **Error Details:** - **404 Not Found** — organization does not exist or your integration has no accessible company within it

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