Retrieve Worked Hours & Wages

🚧

Performance Limits on Endpoint

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": "123456",
                "first_name": "Jane",
                "last_name": "Dane"
            },
            "weeks": [
                {
                    "week": "2022-07-03",
                    "salaried": false,
                    "shifts": [
                        {
                            "user_id": 112233,
                            "date": "2022-07-06 17:01:00",
                            "week_label": "2022-07-03",
                            "day_label": "Jul 6",
                            "label": "5:01PM - 10:45PM",
                            "breaks": [
                                "Paid Break - 30 min (7:00pm - 7:30pm)"
                            ],
                            "location_id": 9876,
                            "location_label": "Restaurant",
                            "role_id": 4320,
                            "role_label": "Host",
                            "wage": 18,
                            "status": 0,
                            "salaried": false,
                            "compliance_exceptions": [],
                            "total": {
                                "regular_hours": 0,
                                "regular_pay": 0,
                                "overtime_hours": 5.73,
                                "overtime_pay": 90.62,
                                "holiday_hours": 0,
                                "holiday_pay": 0,
                                "compliance_exceptions_pay": 0,
                                "total_hours": 5.73,
                                "total_pay": 90.62,
                                "total_tips": 0,
                                "cash_tips": 0,
                                "credit_card_tips": 0,
                                "total_payment_tips": 0,
                                "pos_declared_tips": 0,
                                "tip_in": 0,
                                "tip_out": 0
                            }
                        }
                    ],
                    "lone_compliance_exceptions": [],
                    "total": {
                        "regular_hours": 0,
                        "regular_pay": 0,
                        "overtime_hours": 5.73,
                        "overtime_pay": 90.62,
                        "holiday_hours": 0,
                        "holiday_pay": 0,
                        "compliance_exceptions_pay": 0,
                        "total_hours": 5.73,
                        "total_pay": 90.62,
                        "total_tips": 0,
                        "cash_tips": 0,
                        "credit_card_tips": 0,
                        "total_payment_tips": 0,
                        "pos_declared_tips": 0,
                        "tip_in": 0,
                        "tip_out": 0
                    }
                }
            ],
            "roles": [
                {
                    "role_id": 4320,
                    "role_label": "Host",
                    "total": {
                        "regular_hours": 0,
                        "regular_pay": 0,
                        "overtime_hours": 5.73,
                        "overtime_pay": 90.62,
                        "holiday_hours": 0,
                        "holiday_pay": 0,
                        "compliance_exceptions_pay": 0,
                        "total_hours": 5.73,
                        "total_pay": 90.62,
                        "total_tips": 0,
                        "cash_tips": 0,
                        "credit_card_tips": 0,
                        "total_payment_tips": 0,
                        "pos_declared_tips": 0,
                        "tip_in": 0,
                        "tip_out": 0
                    },
                    "location_label": "Restaurant"
                }
            ],
            "total": {
                "regular_hours": 0,
                "regular_pay": 0,
                "overtime_hours": 5.73,
                "overtime_pay": 90.62,
                "holiday_hours": 0,
                "holiday_pay": 0,
                "compliance_exceptions_pay": 0,
                "total_hours": 5.73,
                "total_pay": 90.62,
                "total_tips": 0,
                "cash_tips": 0,
                "credit_card_tips": 0,
                "total_payment_tips": 0,
                "pos_declared_tips": 0,
                "tip_in": 0,
                "tip_out": 0
            },
            "salaried": false
        }
    ],
    "show_exception_costs": true,
    "tip_tracking_enabled": false,
    "show_tips": true,
    "total": {
        "regular_hours": 0,
        "regular_pay": 0,
        "overtime_hours": 5.73,
        "overtime_pay": 90.62,
        "holiday_hours": 0,
        "holiday_pay": 0,
        "compliance_exceptions_pay": 0,
        "total_hours": 5.73,
        "total_pay": 90.62,
        "total_tips": 0,
        "cash_tips": 0,
        "credit_card_tips": 0,
        "total_payment_tips": 0,
        "pos_declared_tips": 0,
        "tip_in": 0,
        "tip_out": 0
    },
    "start": "2022-07-03",
    "end": "2022-07-09"
}
Language
Authorization
Click Try It! to start a request and see the response here!