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.

Labor Punches

Prev Next
Get
/public/v1/labor/labor-punches

Retrieves a paginated list of labor punches filtered by date-of-business and/or modified-on date range. At least one date filter must be provided; otherwise the endpoint returns HTTP 422. Results are ordered by labor identifier ascending; use the nextLink in the response to fetch subsequent pages.

Security
HTTP
Type Bearer

Put ONLY your JWT Bearer token on textbox below!

Query parameters
dateOfBusinessStart
string (date)

Start of the date-of-business range, inclusive (yyyy-MM-dd). When supplied alone, scopes the query to that single day

dateOfBusinessEnd
string (date)

End of the date-of-business range, inclusive (yyyy-MM-dd). When supplied alone, scopes the query to that single day

modifiedOnStart
string (date-time)

Start of the modified-on range, inclusive (UTC). When supplied alone, scopes the query to that single day

modifiedOnEnd
string (date-time)

End of the modified-on range, inclusive (UTC). When supplied alone, scopes the query to that single day

locations
array of string

Optional list of location identifiers to filter by. When omitted, all locations the caller has access to are returned

legalEntities
array of string

Optional list of legal entity identifiers to filter by. When omitted, all legal entities the caller has access to are returned. Combined with locations as an additional AND filter

pageSize
integer (int32)

Number of results per page. Optional. Defaults to 250. Values above 250 are clamped; values of zero or less are treated as the default

continuationToken
string

Opaque continuation token from a prior response NextLink. Omit on the first request; required to fetch each subsequent page. An invalid token returns HTTP 422

Responses
200

OK

Expand All
object
data
Array of object (R365.TimeAndAttendance.Public.Contracts.LaborPunches.Models.LaborPunch) | null

Labor punches for the requested page.

object
laborId
string (uuid)

Unique identifier of the labor punch.

dateWorked
string (date)

Date worked (date of business).

startTime
string (date-time) | null

Punch-in time (UTC).

endTime
string (date-time) | null

Punch-out time (UTC).

hours
number (double) | null

Hours worked.

payRate
number (double) | null

Pay rate applied to the punch.

total
number (double) | null

Gross pay for the punch (hours multiplied by pay rate).

tipDeclaredAmount
number (double) | null

Employee-declared tip amount on the punch.

employee
object (R365.TimeAndAttendance.Public.Contracts.LaborPunches.Models.EmployeeRef)
id
string (uuid)

R365 employee identifier.

name
string | null

Employee display name.

payrollId
string | null

Employee payroll identifier from the external payroll provider.

job
object (R365.TimeAndAttendance.Public.Contracts.LaborPunches.Models.JobRef)
id
string (uuid)

Job title identifier.

name
string | null

Job title name.

code
string | null

Job code value.

department
string | null

Department name the job belongs to.

location
object (R365.TimeAndAttendance.Contracts.LaborPunches.Models.EntityReference)
id
string (uuid)

Location identifier.

name
string | null

Location name.

number
string | null

Location number.

createdOn
string (date-time) | null

Date and time the record was created (UTC).

createdBy
object (R365.TimeAndAttendance.Public.Contracts.LaborPunches.Models.UserRef)
id
string (uuid)

User identifier.

name
string | null

User full name.

modifiedOn
string (date-time) | null

Date and time the record was last modified (UTC).

modifiedBy
object (R365.TimeAndAttendance.Public.Contracts.LaborPunches.Models.UserRef)
id
string (uuid)

User identifier.

name
string | null

User full name.

nextLink
string | null

Relative URL to retrieve the next page of results. Preserves the original query parameters and appends a fresh continuationToken. Null when this is the last page.

Expand All
object
data
Array of object (R365.TimeAndAttendance.Public.Contracts.LaborPunches.Models.LaborPunch) | null

Labor punches for the requested page.

object
laborId
string (uuid)

Unique identifier of the labor punch.

dateWorked
string (date)

Date worked (date of business).

startTime
string (date-time) | null

Punch-in time (UTC).

endTime
string (date-time) | null

Punch-out time (UTC).

hours
number (double) | null

Hours worked.

payRate
number (double) | null

Pay rate applied to the punch.

total
number (double) | null

Gross pay for the punch (hours multiplied by pay rate).

tipDeclaredAmount
number (double) | null

Employee-declared tip amount on the punch.

employee
object (R365.TimeAndAttendance.Public.Contracts.LaborPunches.Models.EmployeeRef)
id
string (uuid)

R365 employee identifier.

name
string | null

Employee display name.

payrollId
string | null

Employee payroll identifier from the external payroll provider.

job
object (R365.TimeAndAttendance.Public.Contracts.LaborPunches.Models.JobRef)
id
string (uuid)

Job title identifier.

name
string | null

Job title name.

code
string | null

Job code value.

department
string | null

Department name the job belongs to.

location
object (R365.TimeAndAttendance.Contracts.LaborPunches.Models.EntityReference)
id
string (uuid)

Location identifier.

name
string | null

Location name.

number
string | null

Location number.

createdOn
string (date-time) | null

Date and time the record was created (UTC).

createdBy
object (R365.TimeAndAttendance.Public.Contracts.LaborPunches.Models.UserRef)
id
string (uuid)

User identifier.

name
string | null

User full name.

modifiedOn
string (date-time) | null

Date and time the record was last modified (UTC).

modifiedBy
object (R365.TimeAndAttendance.Public.Contracts.LaborPunches.Models.UserRef)
id
string (uuid)

User identifier.

name
string | null

User full name.

nextLink
string | null

Relative URL to retrieve the next page of results. Preserves the original query parameters and appends a fresh continuationToken. Null when this is the last page.

Expand All
object
data
Array of object (R365.TimeAndAttendance.Public.Contracts.LaborPunches.Models.LaborPunch) | null

Labor punches for the requested page.

object
laborId
string (uuid)

Unique identifier of the labor punch.

dateWorked
string (date)

Date worked (date of business).

startTime
string (date-time) | null

Punch-in time (UTC).

endTime
string (date-time) | null

Punch-out time (UTC).

hours
number (double) | null

Hours worked.

payRate
number (double) | null

Pay rate applied to the punch.

total
number (double) | null

Gross pay for the punch (hours multiplied by pay rate).

tipDeclaredAmount
number (double) | null

Employee-declared tip amount on the punch.

employee
object (R365.TimeAndAttendance.Public.Contracts.LaborPunches.Models.EmployeeRef)
id
string (uuid)

R365 employee identifier.

name
string | null

Employee display name.

payrollId
string | null

Employee payroll identifier from the external payroll provider.

job
object (R365.TimeAndAttendance.Public.Contracts.LaborPunches.Models.JobRef)
id
string (uuid)

Job title identifier.

name
string | null

Job title name.

code
string | null

Job code value.

department
string | null

Department name the job belongs to.

location
object (R365.TimeAndAttendance.Contracts.LaborPunches.Models.EntityReference)
id
string (uuid)

Location identifier.

name
string | null

Location name.

number
string | null

Location number.

createdOn
string (date-time) | null

Date and time the record was created (UTC).

createdBy
object (R365.TimeAndAttendance.Public.Contracts.LaborPunches.Models.UserRef)
id
string (uuid)

User identifier.

name
string | null

User full name.

modifiedOn
string (date-time) | null

Date and time the record was last modified (UTC).

modifiedBy
object (R365.TimeAndAttendance.Public.Contracts.LaborPunches.Models.UserRef)
id
string (uuid)

User identifier.

name
string | null

User full name.

nextLink
string | null

Relative URL to retrieve the next page of results. Preserves the original query parameters and appends a fresh continuationToken. Null when this is the last page.

401

Unauthorized - authentication credentials are missing or invalid.

403

Forbidden - the caller does not have the required scope or tenant access.

422

Unprocessable Content

Expand All
object
errorCode
string | null
innerError
object (R365.TimeAndAttendance.Public.Models.R365Error)
errorCode
string | null
innerError
object (R365.TimeAndAttendance.Public.Models.R365Error) Recursive
Expand All
object
errorCode
string | null
innerError
object (R365.TimeAndAttendance.Public.Models.R365Error)
errorCode
string | null
innerError
object (R365.TimeAndAttendance.Public.Models.R365Error) Recursive
Expand All
object
errorCode
string | null
innerError
object (R365.TimeAndAttendance.Public.Models.R365Error)
errorCode
string | null
innerError
object (R365.TimeAndAttendance.Public.Models.R365Error) Recursive
500

Internal Server Error - an unexpected error occurred while processing the request.