---
title: "GET /api/tenants/{tenantId}/payrollresults/consolidated/collectors"
method: GET
path: "/api/tenants/{tenantId}/payrollresults/consolidated/collectors"
tags: ["Payroll consolidated results"]
---

# GET /api/tenants/{tenantId}/payrollresults/consolidated/collectors

`GET /api/tenants/{tenantId}/payrollresults/consolidated/collectors`

## Request

- The document declares no server URL.
- Auth: none declared
- TypeScript: <https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/docs/api/tenants/:tenantId/payrollresults/consolidated/collectors/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantId` integer, required

## Query parameters

- `employeeId` integer, required
- `periodStarts` string[], required
- `divisionId` integer
- `collectorNames` string[]
- `evaluationDate` string, date-time
- `forecast` string
- `jobStatus` 'Draft' | 'Release' | 'Process' | 'Complete' | 'Forecast' | 'Abort' | 'Cancel': The payrun job status Supported state changes: - *: Draft | Forecast | Abort - Draft: Release | Abort - Release: Process | Abort - Process: Complete | Cancel
- `tags` string[]

## Response `200`

OK

- CollectorResult[]
  - `id` integer
  - `status` 'Active' | 'Inactive': The object status
  - `created` string, date-time
  - `updated` string, date-time
  - `payrollResultId` integer
  - `tenantId` integer
  - `employeeId` integer
  - `divisionId` integer
  - `payrunJobId` integer
  - `forecast` string, nullable
  - `parentJobId` integer, nullable
  - `payDate` string, date-time
  - `collectorId` integer, required
  - `collectorName` string, required
  - `collectorNameLocalizations` object, nullable
  - `collectMode` 'Summary' | 'Minimum' | 'Maximum' | 'Average' | 'Range' | 'Count', required: The collect mode
  - `negated` boolean, required
  - `valueType` 'String' | 'Boolean' | 'Integer' | 'NumericBoolean' | 'Decimal' | 'DateTime' | 'None' | 'Date' | 'Weekday' | 'Month' | 'Year' | 'Money' | 'Percent' | 'WebResource', required: The payroll value types for cases
  - `value` number, double, required
  - `culture` string, nullable
  - `start` string, date-time, required
  - `end` string, date-time, required
  - `tags` string[], nullable
  - `attributes` object, nullable

## Other responses

- `404`: Not Found

## Changes

- **2026-10-13** `e3e4305cbb92`: 1 info
  - added the optional property `items/payDate` to the response with the `200` status
- **2026-04-01** `34e260deaa2c`: 3 info
  - added the optional property `items/forecast` to the response with the `200` status
  - added the optional property `items/parentJobId` to the response with the `200` status
  - added the optional property `items/payrunJobId` to the response with the `200` status
- **2026-03-09** `97ae205209e8`: 3 info
  - added the optional property `items/divisionId` to the response with the `200` status
  - added the optional property `items/employeeId` to the response with the `200` status
  - added the optional property `items/tenantId` to the response with the `200` status
- **2025-09-14** `7432139da659`: 1 info
  - added the optional property `items/culture` to the response with the `200` status
- **2023-07-23** `fd1b5146be4a`: 7 warning
  - removed the optional property `items/culture` from the response with the `200` status
  - removed the optional property `items/divisionId` from the response with the `200` status
  - removed the optional property `items/employeeId` from the response with the `200` status
  - removed the optional property `items/forecast` from the response with the `200` status
  - …3 more

[Operation history](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/changes/api/tenants/:tenantId/payrollresults/consolidated/collectors/get.md)

---

[API](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1.md) - [All operations](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/revisions/d1227845e767?raw)