Payroll results
Retrieve calculation results and pay slip data
Query payroll results (Partner)
Retrieves payroll results for your tenant with filtering and pagination support. Use payrunJobId to filter results by a specific payrun job. Partner must have access to the tenant.
path Parameters
tenantIdTenant identifier
partnerIdPartner identifier (must match your API key)
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 (Partner) › Responses
OK
idUnique identifier
payrollIdpayrunIdpayrunJobIdemployeeIddivisionIdcycleNameThe payroll cycle name (e.g., '2025')
cycleStartcycleEndperiodNameThe payroll period name (e.g., '2025-01')
periodStartperiodEndstatusThe object status
createdupdatedQuery payroll result sets (Partner)
Retrieves payroll result sets filtered by payrunJobId. Returns wage types, collectors, and payrun results. Result persistence is eventually consistent with terminal job status: clients must retry a transient empty 200 response with bounded backoff and must not fall back to another job. Partner must have access to the tenant.
path Parameters
tenantIdTenant identifier
partnerIdPartner identifier (must match your API key)
query Parameters
payrunJobIdFilter by payrun job identifier
topThe maximum number of result sets to return (for pagination). Recommended: 50 for large batches.
skipThe number of result sets to skip (for pagination offset)
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 (Partner) › Responses
OK
payrollIdpayrunJobIdemployeeIddivisionIdcycleNamecycleStartcycleEndperiodNameperiodStartidstatusThe object status
createdupdatedpayrunIdperiodEndGet detailed payroll result set by ID (Partner)
Retrieves the complete result set for a specific payroll calculation by its ID, including wage types, collectors, and payrun results. Partner must have access to the tenant.
path Parameters
tenantIdTenant identifier
partnerIdPartner identifier (must match your API key)
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 (Partner) › Responses
OK
payrollIdpayrunJobIdemployeeIddivisionIdcycleNamecycleStartcycleEndperiodNameperiodStartidstatusThe object status
createdupdatedpayrunIdperiodEndGet a stable payroll result summary
Returns a partner-facing JSON projection of a PayrollEngine result set. Conventional FR.Salaire totals are exposed under stable names and every source wage-type line remains available. A missing conventional total is returned as null, never guessed.
path Parameters
tenantIdNumeric PayrollEngine tenant identifier returned by onboarding
partnerIdPartner identifier (must match your API key)
resultSetIdPayrollEngine result-set 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 a stable payroll result summary › Responses
Stable payroll result summary
schemaVersionresultSetIdcurrencypayrollIdpayrunIdpayrunJobIdemployeeIddivisionId