Query payrun jobs
Retrieves payrun jobs for your tenant with filtering and pagination support.
query Parameters
filterThe OData filter expression (with support for attribute fields)
orderByThe OData order-by expression (with support for attribute fields)
resultThe query result type: items, count or items with count (default: result items)
The query result type
selectThe OData field selection expression
skipThe number of items in the queried collection that are to be skipped
statusThe object status (default: all status)
The object status
topThe number of items in the queried collection
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query payrun jobs › Responses
OK
namepayrunIdpayrollIdcreatedUserIdcycleNamecycleStartcycleEndperiodNameperiodStartperiodEndevaluationDatecreatedReasonjobStartidstatusThe object status
createdupdatedownerdivisionIdparentJobIdreleasedUserIdprocessedUserIdfinishedUserIdretroPayModeThe payrun retro pay mode
jobStatusThe payrun job status
jobResultThe payrun job result
tagsforecastculturereleasedprocessedfinishedreleasedReasonprocessedReasonfinishedReasontotalEmployeeCountprocessedEmployeeCountjobEndmessageerrorMessageStart a payrun job (launch forecast calculation)
Starts a new payrun job for forecast calculation. This initiates the payroll calculation process for the specified parameters.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Start a payrun job (launch forecast calculation) › Request Body
payrunIduserIdnameperiodStartreasonidpayrunJobIdparentJobIdownertagsforecastretroPayModeThe payrun retro pay mode
jobResultThe payrun job result
evaluationDatestoreEmptyResultslogLevelSpecifies the meaning and relative importance of a log event
employeeIdentifiersStart a payrun job (launch forecast calculation) › Responses
Created
namepayrunIdpayrollIdcreatedUserIdcycleNamecycleStartcycleEndperiodNameperiodStartperiodEndevaluationDatecreatedReasonjobStartidstatusThe object status
createdupdatedownerdivisionIdparentJobIdreleasedUserIdprocessedUserIdfinishedUserIdretroPayModeThe payrun retro pay mode
jobStatusThe payrun job status
jobResultThe payrun job result
tagsforecastculturereleasedprocessedfinishedreleasedReasonprocessedReasonfinishedReasontotalEmployeeCountprocessedEmployeeCountjobEndmessageerrorMessageGet payrun job details and status
Retrieves the details and current status of a specific payrun job.
path Parameters
payrunJobIdThe payrun job identifier
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get payrun job details and status › Responses
OK
namepayrunIdpayrollIdcreatedUserIdcycleNamecycleStartcycleEndperiodNameperiodStartperiodEndevaluationDatecreatedReasonjobStartidstatusThe object status
createdupdatedownerdivisionIdparentJobIdreleasedUserIdprocessedUserIdfinishedUserIdretroPayModeThe payrun retro pay mode
jobStatusThe payrun job status
jobResultThe payrun job result
tagsforecastculturereleasedprocessedfinishedreleasedReasonprocessedReasonfinishedReasontotalEmployeeCountprocessedEmployeeCountjobEndmessageerrorMessage