---
title: "POST /api/tenants/{tenantId}/payruns/jobs/preview"
method: POST
path: "/api/tenants/{tenantId}/payruns/jobs/preview"
tags: ["Payrun jobs"]
---

# POST /api/tenants/{tenantId}/payruns/jobs/preview

`POST /api/tenants/{tenantId}/payruns/jobs/preview`

## Path parameters

- `tenantId` integer, required

## Request body

- PayrunJobInvocation
  - `id` integer
  - `status` 'Active' | 'Inactive'
  - `created` string, date-time
  - `updated` string, date-time
  - `payrunName` string, required
  - `userIdentifier` string, required
  - `payrunJobId` integer
  - `parentJobId` integer, nullable
  - `name` string, required
  - `owner` string, nullable
  - `retroJobs` RetroPayrunJob[], nullable
    - `id` integer
    - `status` 'Active' | 'Inactive'
    - `created` string, date-time
    - `updated` string, date-time
    - `scheduleDate` string, date-time, required
    - `resultTags` string[], nullable
  - `tags` string[], nullable
  - `forecast` string, nullable
  - `retroPayMode` 'ValueChange' | 'None'
  - `jobResult` 'Full' | 'Incremental'
  - `jobStatus` 'Draft' | 'Release' | 'Process' | 'Complete' | 'Forecast' | 'Abort' | 'Cancel'
  - `completedJobStatus` 'Draft' | 'Release' | 'Process' | 'Complete' | 'Forecast' | 'Abort' | 'Cancel'
  - `periodStart` string, date-time, required
  - `evaluationDate` string, date-time, nullable
  - `reason` string, required
  - `storeEmptyResults` boolean
  - `logLevel` 'Verbose' | 'Debug' | 'Information' | 'Warning' | 'Error' | 'Fatal'
  - `employeeIdentifiers` string[], nullable
  - `attributes` object, nullable

## Response `200`

OK

- PayrollResultSet
  - `id` integer
  - `status` 'Active' | 'Inactive'
  - `created` string, date-time
  - `updated` string, date-time
  - `payrollId` integer, required
  - `payrollName` string, nullable
  - `payrunId` integer
  - `payrunName` string, nullable
  - `payrunJobId` integer, required
  - `payrunJobName` string, nullable
  - `employeeId` integer, required
  - `employeeIdentifier` string, nullable
  - `divisionId` integer, required
  - `divisionName` string, nullable
  - `cycleName` string, required
  - `cycleStart` string, date-time, required
  - `cycleEnd` string, date-time, required
  - `periodName` string, required
  - `periodStart` string, date-time, required
  - `periodEnd` string, date-time
  - `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` CollectorResultSet[], 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
    - `customResults` CollectorCustomResult[], nullable
      - `id` integer
      - `status` 'Active' | 'Inactive'
      - `created` string, date-time
      - `updated` string, date-time
      - `collectorResultId` integer
      - `tenantId` integer
      - `employeeId` integer
      - `divisionId` integer
      - `collectorName` string, required
      - `collectorNameLocalizations` object, nullable
      - `source` string, 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
- `422` — Unprocessable Content

---

[API](https://skmtc.net/payroll-engine/apis/payroll-engine-backend-api-v1.md) · [All operations](https://skmtc.net/payroll-engine/apis/payroll-engine-backend-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payroll-engine/payroll-engine-backend-api-v1/versions/34e260deaa2c/schema)