Retrieve Worked Hours and Wages

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Minimum Plan Required: The Works

🚧

Performance Limitations

The Hours & Wages reports can take a significant amount of time to create and can result in 500 errors due to time outs. If you receive a 500 or 502 error it is recommended to add filters to limit the scope of the report.

It is recommended to always include a location_id to minimize the number of locations in the report. If you still receive a time out error, it is recommended to shorten the report period to a single week.

We are working on making performance improvements to increase the speed of the report creation to eliminate all 500 errors. If you still encounter errors please contact [email protected].

Sample Response

{
    "users": [
        {
            "user": {
                "id": 112233,
                "employee_id": "",
                "first_name": "James 007",
                "last_name": "Bond"
            },
            "weeks": [
                {
                    "week": "2022-07-03",
                    "salaried": false,
                    "shifts": [
                        {
                            "user_id": 112233,
                            "date": "2022-07-03 09:03:00",
                            "week_label": "2022-07-03",
                            "day_label": "Jul 3",
                            "label": "9:03AM - 3:06PM",
                            "breaks": [
                                "Paid Break - 30 min (7:00pm - 7:30pm)"
                            ],
                            "location_id": 9876,
                            "location_label": "Restaurant",
                            "role_id": 4320,
                            "role_label": "Host",
                            "wage": 2.13,
                            "status": 0,
                            "salaried": false,
                            "compliance_exceptions": [],
                            "total": {
                                "regular_hours": 6.05,
                                "regular_pay": 12.89,
                                "overtime_hours": 0,
                                "premium_overtime_hours": 0,
                                "non_premium_overtime_hours": 0,        
                                "overtime_pay": 0,
                                "premium_overtime_pay": 0,
                                "non_premium_overtime_pay": 0,        
                                "holiday_hours": 0,
                                "holiday_pay": 0,
                                "compliance_exceptions_pay": 0,
                                "total_hours": 6.05,
                                "total_pay": 12.89,
                                "total_tips": 39.24,
                                "cash_tips": 39.24,
                                "credit_card_tips": 0,
                                "total_payment_tips": 0,
                                "auto_gratuity": 0,
                                "withheld_cc_amount": 0,
                                "tip_in": 0,
                                "tip_out": 0,
                                "earned_tips": 39.24,
                                "declared_tips": 39.24,
                                "pos_declared_tips": 0
                            }
                        }
                    ],
                    "lone_compliance_exceptions": [],
                    "total": {
                        "regular_hours": 6.05,
                        "regular_pay": 12.89,
                        "overtime_hours": 0,
                        "premium_overtime_hours": 0,
                        "non_premium_overtime_hours": 0,                        
                        "overtime_pay": 0,
                        "premium_overtime_pay": 0,
                        "non_premium_overtime_pay": 0,
                        "holiday_hours": 0,
                        "holiday_pay": 0,
                        "compliance_exceptions_pay": 0,
                        "total_hours": 6.05,
                        "total_pay": 12.89,
                        "total_tips": 39.24,
                        "cash_tips": 39.24,
                        "credit_card_tips": 0,
                        "total_payment_tips": 0,
                        "auto_gratuity": 0,
                        "withheld_cc_amount": 0,
                        "tip_in": 0,
                        "tip_out": 0,
                        "earned_tips": 39.24,
                        "declared_tips": 39.24,
                        "pos_declared_tips": 0
                    }
                }
            ],
            "roles": [
                {
                    "role_id": 4320,
                    "role_label": "Host",
                    "total": {
                        "regular_hours": 6.05,
                        "regular_pay": 12.89,
                        "overtime_hours": 0,
                        "premium_overtime_hours": 0,
                        "non_premium_overtime_hours": 0,                        
                        "overtime_pay": 0,
                        "premium_overtime_pay": 0,
                        "non_premium_overtime_pay": 0,
                        "holiday_hours": 0,
                        "holiday_pay": 0,
                        "compliance_exceptions_pay": 0,
                        "total_hours": 6.05,
                        "total_pay": 12.89,
                        "total_tips": 39.24,
                        "cash_tips": 39.24,
                        "credit_card_tips": 0,
                        "total_payment_tips": 0,
                        "auto_gratuity": 0,
                        "withheld_cc_amount": 0,
                        "tip_in": 0,
                        "tip_out": 0,
                        "earned_tips": 39.24,
                        "declared_tips": 39.24,
                        "pos_declared_tips": 0
                    },
                    "location_label": "Cardos Pub - OG"
                }
            ],
            "total": {
                "regular_hours": 6.05,
                "regular_pay": 12.89,
                "overtime_hours": 0,
                "premium_overtime_hours": 0,
                "non_premium_overtime_hours": 0,                        
                "overtime_pay": 0,
                "premium_overtime_pay": 0,
                "non_premium_overtime_pay": 0,
                "holiday_hours": 0,
                "holiday_pay": 0,
                "compliance_exceptions_pay": 0,
                "total_hours": 6.05,
                "total_pay": 12.89,
                "total_tips": 39.24,
                "cash_tips": 39.24,
                "credit_card_tips": 0,
                "total_payment_tips": 0,
                "auto_gratuity": 0,
                "withheld_cc_amount": 0,
                "tip_in": 0,
                "tip_out": 0,
                "earned_tips": 39.24,
                "declared_tips": 39.24,
                "pos_declared_tips": 0
            },
            "salaried": false
        }
    ],
    "show_exception_costs": true,
    "tip_tracking_enabled": false,
    "show_tips": true,
    "total": {
        "regular_hours": 6.05,
        "regular_pay": 12.89,
        "overtime_hours": 0,
        "premium_overtime_hours": 0,
        "non_premium_overtime_hours": 0,                        
        "overtime_pay": 0,
        "premium_overtime_pay": 0,
        "non_premium_overtime_pay": 0,
        "holiday_hours": 0,
        "holiday_pay": 0,
        "compliance_exceptions_pay": 0,
        "total_hours": 6.05,
        "total_pay": 12.89,
        "total_tips": 39.24,
        "cash_tips": 39.24,
        "credit_card_tips": 0,
        "total_payment_tips": 0,
        "auto_gratuity": 0,
        "withheld_cc_amount": 0,
        "tip_in": 0,
        "tip_out": 0,
        "earned_tips": 39.24,
        "declared_tips": 39.24,
        "pos_declared_tips": 0
    },
    "start": "2022-07-03",
    "end": "2022-07-09"
}
Query Params
boolean
required

Whether or not to use the punch labour source

int64
required

The company id to pull the report for.

string
required

Starting date for which you want the report to start.

string
required

Ending date for which you want the report to end.

int64

The location id for which you want the report for.

int64

The department id for the report.

int64

The role id for the report

int64

The user id the report should be fetched for - internal use only

boolean | null
Defaults to true

When true (default) tips data is included in the response. When false tips are not included in the response.

boolean | null
Defaults to true

When true (default) qualified overtime data is included in the response. When false qualified overtime is not included in the response.

Headers
string

7shifts API version

uuid

Company GUID

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json