Documentation Index

Fetch the complete documentation index at: https://docs.restaurant365.com/llms.txt

Use this file to discover all available pages before exploring further.

Payroll Summaries

Prev Next
Get
/public/v1/labor/payroll-summaries

Retrieves payroll summaries for a date range, optionally filtered by location or legal entity

Security
HTTP
Type Bearer

Put ONLY your JWT Bearer token on textbox below!

Query parameters
businessDateStart
string (date)

Starting business date for the payroll period (inclusive). Required if businessDateEnd is provided

businessDateEnd
string (date)

Ending business date for the payroll period (inclusive). Required if businessDateStart is provided

locationId
string (uuid)

Location identifier. If omitted, returns data for all locations the API user has access to

legalEntityId
string (uuid)

Legal entity identifier. If omitted, returns data for all legal entities the API user has access to

pageSize
integer (int32)

Number of results per page. Default: 250

Minimum1.0
Maximum250.0
Default250
Responses
200

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.

Array of object
object

A single payroll summary row aggregating labor by employee, job code, and earning type for a business date.

businessDate
string (date)

Business date of the labor record.

legalEntity
object (R365.TimeAndAttendance.Labor.Contracts.LaborExternal.Apis.ExternalLegalEntity)

Legal entity associated with the labor record.

id
string (uuid)

Unique identifier of the legal entity.

name
string | null

Display name of the legal entity.

number
string | null

Legal entity number.

payrollProviderId
string | null

External payroll provider identifier for the legal entity.

location
object (R365.TimeAndAttendance.Labor.Contracts.LaborExternal.Apis.ExternalLocation)

Location where the labor was performed.

id
string (uuid)

Unique identifier of the location.

name
string | null

Display name of the location.

number
string | null

Location number.

payrollLocationId
string | null

External payroll location identifier.

employee
object (R365.TimeAndAttendance.Labor.Contracts.LaborExternal.Apis.ExternalEmployee)

Employee who performed the labor.

id
string (uuid)

Unique identifier of the employee.

name
string | null

Display name of the employee.

payrollId
string | null

External payroll identifier for the employee.

earningType
string | null

Earning type code for the labor record.

earningTypeName
string | null

Display name of the earning type.

jobCode
object (R365.TimeAndAttendance.Labor.Contracts.LaborExternal.Apis.JobCode)

Job code associated with the labor record.

id
string (uuid)

Unique identifier of the job code.

name
string | null

Display name of the job code.

code
string | null

Job code value.

department
string | null

Department the job code belongs to.

totalSeconds
integer (int32)

Total duration of labor in seconds.

rate
number (double)

Pay rate applied to the labor record.

cost
number (double)

Total cost of the labor record (rate × totalSeconds, in currency units).