Retrieve calculation results and pay slip data
Query payroll results
Retrieves payroll results for your tenant with filtering and pagination support. Use payrunJobId to filter results by a specific payrun job.
query Parameters
payrunJobIdFilter by payrun job identifier to get results from a specific payrun execution
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 payroll results › Responses
OK
idUnique identifier
payrollIdpayrunIdpayrunJobIdemployeeIddivisionIdperiodStartperiodEndstatusThe object status
Query payroll result sets
Retrieves payroll result sets filtered by payrunJobId. Returns wage types, collectors, and payrun results.
query Parameters
payrunJobIdFilter by 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.
Query payroll result sets › Responses
OK
payrollIdpayrunJobIdemployeeIddivisionIdcycleNamecycleStartcycleEndperiodNameperiodStartidstatusThe object status
createdupdatedpayrunIdperiodEndGet detailed payroll result set by ID
Retrieves the complete result set for a specific payroll calculation by its ID, including wage types, collectors, and payrun results.
path Parameters
payrollResultIdThe payroll result 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 detailed payroll result set by ID › Responses
OK
payrollIdpayrunJobIdemployeeIddivisionIdcycleNamecycleStartcycleEndperiodNameperiodStartidstatusThe object status
createdupdatedpayrunIdperiodEnd