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

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

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

## 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/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantId` integer, required

## Query parameters

- `employeeId` integer, required
- `periodStart` string, date-time, required
- `periodEnd` string, date-time, required
- `divisionId` integer
- `forecast` string
- `jobStatus` 'Draft' | 'Release' | 'Process' | 'Complete' | 'Forecast' | 'Abort' | 'Cancel'
- `tags` string[]

## Response `200`

OK

- ConsolidatedPayrollResult
  - `wageTypeResults` WageTypeResultSet[], nullable
    - `id` integer
    - `status` 'Active' | 'Inactive'
    - `created` string, date-time
    - `updated` string, date-time
    - `payrollResultId` integer
    - `tenantId` integer
    - `employeeId` integer
    - `divisionId` integer
    - `payrunJobId` integer
    - `forecast` string, nullable
    - `parentJobId` integer, nullable
    - `wageTypeId` integer, required
    - `wageTypeNumber` number, double, required
    - `wageTypeName` string, required
    - `wageTypeNameLocalizations` object, nullable
    - `valueType` 'String' | 'Boolean' | 'Integer' | 'NumericBoolean' | 'Decimal' | 'DateTime' | 'None' | 'Date' | 'Weekday' | 'Month' | 'Year' | 'Money' | 'Percent' | 'WebResource'
    - `value` number, double, required
    - `culture` string, nullable
    - `start` string, date-time, required
    - `end` string, date-time, required
    - `tags` string[], nullable
    - `attributes` object, nullable
    - `customResults` WageTypeCustomResult[], nullable
      - `id` integer
      - `status` 'Active' | 'Inactive'
      - `created` string, date-time
      - `updated` string, date-time
      - `wageTypeResultId` integer
      - `tenantId` integer
      - `employeeId` integer
      - `divisionId` integer
      - `wageTypeNumber` number, double, required
      - `wageTypeName` string, nullable
      - `wageTypeNameLocalizations` object, nullable
      - `source` string, required
      - `valueType` 'String' | 'Boolean' | 'Integer' | 'NumericBoolean' | 'Decimal' | 'DateTime' | 'None' | 'Date' | 'Weekday' | 'Month' | 'Year' | 'Money' | 'Percent' | 'WebResource'
      - `value` number, double, required
      - `culture` string, nullable
      - `start` string, date-time, required
      - `end` string, date-time, required
      - `tags` string[], nullable
      - `attributes` object, nullable
  - `collectorResults` CollectorResult[], nullable
    - `id` integer
    - `status` 'Active' | 'Inactive'
    - `created` string, date-time
    - `updated` string, date-time
    - `payrollResultId` integer
    - `tenantId` integer
    - `employeeId` integer
    - `divisionId` integer
    - `payrunJobId` integer
    - `forecast` string, nullable
    - `parentJobId` integer, nullable
    - `collectorId` integer, required
    - `collectorName` string, required
    - `collectorNameLocalizations` object, nullable
    - `collectMode` 'Summary' | 'Minimum' | 'Maximum' | 'Average' | 'Range' | 'Count', required
    - `negated` boolean, required
    - `valueType` 'String' | 'Boolean' | 'Integer' | 'NumericBoolean' | 'Decimal' | 'DateTime' | 'None' | 'Date' | 'Weekday' | 'Month' | 'Year' | 'Money' | 'Percent' | 'WebResource', required
    - `value` number, double, required
    - `culture` string, nullable
    - `start` string, date-time, required
    - `end` string, date-time, required
    - `tags` string[], nullable
    - `attributes` object, nullable
  - `payrunResults` PayrunResult[], nullable
    - `id` integer
    - `status` 'Active' | 'Inactive'
    - `created` string, date-time
    - `updated` string, date-time
    - `payrollResultId` integer
    - `tenantId` integer
    - `employeeId` integer
    - `divisionId` integer
    - `payrunJobId` integer
    - `forecast` string, nullable
    - `parentJobId` integer, nullable
    - `source` string, required
    - `name` string, required
    - `nameLocalizations` object, nullable
    - `slot` string, nullable
    - `valueType` 'String' | 'Boolean' | 'Integer' | 'NumericBoolean' | 'Decimal' | 'DateTime' | 'None' | 'Date' | 'Weekday' | 'Month' | 'Year' | 'Money' | 'Percent' | 'WebResource', required
    - `value` string, required
    - `culture` string, nullable
    - `numericValue` number, double, nullable
    - `start` string, date-time, required
    - `end` string, date-time, required
    - `tags` string[], nullable
    - `attributes` object, nullable

## Other responses

- `404`: Not Found

## Changes

- **2026-04-01** `34e260deaa2c`: 9 info
  - added the optional property `collectorResults/items/forecast` to the response with the `200` status
  - added the optional property `collectorResults/items/parentJobId` to the response with the `200` status
  - added the optional property `collectorResults/items/payrunJobId` to the response with the `200` status
  - added the optional property `payrunResults/items/forecast` to the response with the `200` status
  - …5 more
- **2026-03-09** `97ae205209e8`: 12 info
  - added the optional property `collectorResults/items/divisionId` to the response with the `200` status
  - added the optional property `collectorResults/items/employeeId` to the response with the `200` status
  - added the optional property `collectorResults/items/tenantId` to the response with the `200` status
  - added the optional property `payrunResults/items/divisionId` to the response with the `200` status
  - …8 more
- **2025-09-14** `7432139da659`: 4 info
  - added the optional property `collectorResults/items/culture` to the response with the `200` status
  - added the optional property `payrunResults/items/culture` to the response with the `200` status
  - added the optional property `wageTypeResults/items/culture` to the response with the `200` status
  - added the optional property `wageTypeResults/items/customResults/items/culture` to the response with the `200` status
- …earlier changes not shown

[Operation history](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/changes/api/tenants/:tenantId/payrollresults/consolidated/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/7e8994a2c5bb?raw)