Retrieves payroll summaries for a date range, filtered by location or legal entity
Security
The requesting user must have all of the following permissions:
- Administration → Legal Entities → View Legal Entities
- Locations → View Locations
- Labor → Employees → View Employees
- Labor → Jobs → View Jobs
- Time & Attendance → Timecards → View Timecards
Identifies the R365 tenant the request applies to. Required on every request.
Starting business date for the payroll period (inclusive). Required if businessDateEnd is provided
Ending business date for the payroll period (inclusive). Required if businessDateStart is provided
Location identifier. If omitted, returns data for all locations the API user has access to
Legal entity identifier. If omitted, returns data for all legal entities the API user has access to
Payroll summary rows aggregated by employee, job code, and earning type. Each row represents labor on a single business date for a single employee/job/earning-type combination. Returned as a raw array — no pagination wrapper.
A single payroll summary row aggregating labor by employee, job code, and earning type for a business date.
Business date of the labor record.
Legal entity associated with the labor record.
Unique identifier of the legal entity.
Display name of the legal entity.
Legal entity number.
External payroll provider identifier for the legal entity.
Location where the labor was performed.
Unique identifier of the location.
Display name of the location.
Location number.
External payroll location identifier.
Employee who performed the labor.
Unique identifier of the employee.
Display name of the employee.
External payroll identifier for the employee.
Earning type code for the labor record.
Display name of the earning type.
Job code associated with the labor record.
Unique identifier of the job code.
Display name of the job code.
Job code value.
Department the job code belongs to.
Total duration of labor in seconds.
Pay rate applied to the labor record.
Total cost of the labor record (rate × totalSeconds, in currency units).
Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.
Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.
Forbidden — the caller lacks the permission required for this operation.
Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.
Conflict — the request conflicts with the current state of the resource and cannot be applied.
Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.
Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.
Internal Server Error — an unexpected error occurred while processing the request.