Sign in

v1

latestOpenAPI 3.0.42026-07-17316155717.9 KB
Payroll consolidated results

get/api/tenants/{tenantId}/payrollresults/consolidated/collectors

Path parameters

tenantIdinteger required

Query parameters

employeeIdinteger required
periodStartsstring[] required
divisionIdinteger
collectorNamesstring[]
evaluationDatestring date-time
forecaststring
jobStatus'Draft' | 'Release' | 'Process' | 'Complete' | 'Forecast' | 'Abort' | 'Cancel'
tagsstring[]

Response

OK

idinteger
status'Active' | 'Inactive'
createdstring date-time
updatedstring date-time
payrollResultIdinteger
tenantIdinteger
employeeIdinteger
divisionIdinteger
payrunJobIdinteger
forecaststring nullable
parentJobIdinteger nullable
collectorIdinteger required
collectorNamestring required
collectorNameLocalizationsobject nullable
collectMode'Summary' | 'Minimum' | 'Maximum' | 'Average' | 'Range' | 'Count' required
negatedboolean required
valueType'String' | 'Boolean' | 'Integer' | 'NumericBoolean' | 'Decimal' | 'DateTime' | 'None' | 'Date' | 'Weekday' | 'Month' | 'Year' | 'Money' | 'Percent' | 'WebResource' required
valuenumber double required
culturestring nullable
startstring date-time required
endstring date-time required
tagsstring[] nullable
attributesobject nullable