v1
latestOpenAPI 3.0.42026-07-17316155717.9 KBPayrun jobs
post/api/tenants/{tenantId}/payruns/jobs/preview
Path parameters
tenantIdinteger required
Request body
idinteger
status'Active' | 'Inactive'
createdstring date-time
updatedstring date-time
payrunNamestring required
userIdentifierstring required
payrunJobIdinteger
parentJobIdinteger nullable
namestring required
ownerstring nullable
tagsstring[] nullable
forecaststring nullable
retroPayMode'ValueChange' | 'None'
jobResult'Full' | 'Incremental'
jobStatus'Draft' | 'Release' | 'Process' | 'Complete' | 'Forecast' | 'Abort' | 'Cancel'
completedJobStatus'Draft' | 'Release' | 'Process' | 'Complete' | 'Forecast' | 'Abort' | 'Cancel'
periodStartstring date-time required
evaluationDatestring date-time nullable
reasonstring required
storeEmptyResultsboolean
logLevel'Verbose' | 'Debug' | 'Information' | 'Warning' | 'Error' | 'Fatal'
employeeIdentifiersstring[] nullable
attributesobject nullable
Response
OK
idinteger
status'Active' | 'Inactive'
createdstring date-time
updatedstring date-time
payrollIdinteger required
payrollNamestring nullable
payrunIdinteger
payrunNamestring nullable
payrunJobIdinteger required
payrunJobNamestring nullable
employeeIdinteger required
employeeIdentifierstring nullable
divisionIdinteger required
divisionNamestring nullable
cycleNamestring required
cycleStartstring date-time required
cycleEndstring date-time required
periodNamestring required
periodStartstring date-time required
periodEndstring date-time