Team Management

Labor API

Capture team member working hours with breaks and hourly pay rate.

The Labor API is the timekeeping component of the suite of Team Management APIs provided by Square. Use the Labor API to integrate Square Point of Sale timekeeping with applications for labor cost reporting, payroll, and overtime management. The Labor API can also be used to integrate a time-clock application with a Square account for Square Seller Dashboard labor reporting or Square Payroll. The API supports multiple breaks per shift. Use the Team API to set multiple wage levels per team member.

Manage team member time tracking Permalink Get a link to this section

The Labor API can be used to track team member labor hours or import and export timekeeping data to applications.

Track labor hours Permalink Get a link to this section

Create a timekeeping application for Square account team members by providing the following:

  • Record the start time, end time, and breaks for a team member's work shift to compensate the team member for the actual time worked.

  • Set an hourly wage rate for a shift based on the job that a team member is doing on that shift.

  • Set break templates with a human-readable title, default duration, and payroll status to standardize team member shifts.

Import or export labor hours Permalink Get a link to this section

Import and export team member labor hours for time-clock, labor and sales reporting, and overtime management solutions by providing the following:

  • Export Square account labor hours. Use the Labor API shift search endpoint to get labor hours data in a pay period for use in an existing payroll system.

  • Import timekeeping data. Track team member labor hours in an existing time-clock application and import the data into a Square account as Shift records. Generate labor and sales reports in the Seller Dashboard or pay team members using Square Payroll.

The Labor API is available for server-side development as a set of REST endpoints.

Note

A shift is a record of a team member's start and end time for a work period on a specific day. A shift records the hourly pay rate for the work period and the duration of any breaks taken. Shifts in the Labor API replace deprecated Timecards in the Connect v1 API.

Requirements and limitations Permalink Get a link to this section

Applications using OAuth require the following permissions:

  • Retrieving team members: EMPLOYEES_READ.

  • Retrieving workweek configurations, team member wages, and break types: TIMECARDS_SETTINGS_READ and TIMECARD_SETTINGS_WRITE.

  • Creating, updating, retrieving, and deleting shifts: TIMECARDS_WRITE and TIMECARDS_READ.

The Labor API also has the following limitations:

  • The Labor API cannot be used to assign job-based wages to a team member.

  • The Labor API cannot be used to create new team members.

Related topics Permalink Get a link to this section