7S7shifts
Reports

Retrieve Worked Hours and Wages

Changed on
get/v2/reports/hours_and_wages

Request

Query parameters

punchesboolean required

Whether or not to use the punch labour source

company_idinteger required

The company id to pull the report for.

fromstring required

Starting date for which you want the report to start.

tostring required

Ending date for which you want the report to end.

location_idinteger

The location id for which you want the report for.

department_idinteger

The department id for the report.

role_idinteger

The role id for the report

user_idinteger

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

include_tipsboolean nullable

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

include_qualified_otboolean nullable

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

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Response

OK

show_exception_costsboolean required

Whether compliance exceptions and their costs should be shown

tip_tracking_enabledboolean required

Whether tips from integrations should be shown

show_tipsboolean required

Whether we should render the tips column

startstring date required

Start date of report date range

endstring date required

End date of report date range

Example response

{
  "users": [
    {
      "user": {
        "id": 123,
        "employee_id": "82848183",
        "first_name": "Bob",
        "last_name": "Loblaw"
      },
      "weeks": [
        {
          "week": "2021-01-10",
          "shifts": [
            {
              "user_id": 123,
              "date": "2020-01-12 13:45:00",
              "week_label": "2020-01-10",
              "day_label": "Dec 2",
              "label": "1:45PM - 7:28PM",
              "breaks": [
                "Coffee break (Paid) - 10 min (4:18pm - 4:28pm)"
              ],
              "location_id": 408,
              "location_label": "Quacker's",
              "role_id": 604,
              "role_label": "Cook",
              "wage": 15.5,
              "compliance_exceptions": [
                {
                  "date": "2021-01-30T00:00:00.000Z",
                  "violation_type": "spread_of_hours, split_shift",
                  "cost": 15.75
                }
              ],
              "total": {
                "regular_hours": 1.5,
                "regular_pay": 15.75,
                "overtime_hours": 2.5,
                "premium_overtime_hours": 2.5,
                "non_premium_overtime_hours": 2.5,
                "overtime_pay": 35.5,
                "premium_overtime_pay": 35.5,
                "non_premium_overtime_pay": 35.5,
                "holiday_hours": 3.5,
                "holiday_pay": 40.25,
                "compliance_exceptions_pay": 33.5,
                "total_hours": 7.5,
                "total_pay": 123.5,
                "total_tips": 123.5,
                "cash_tips": 123.5,
                "credit_card_tips": 123.5,
                "total_payment_tips": 123.5,
                "declared_tips": 123.5,
                "pos_declared_tips": 123.5,
                "auto_gratuity": 123.5,
                "withheld_cc_amount": 123.5,
                "tip_in": 123.5,
                "tip_out": 123.5,
                "earned_tips": 123.5,
                "tips_paid": 123.45,
                "tips_paid_on_shift": 123.45,
                "tips_paid_on_payouts": 123.45,
                "tips_to_be_paid": 123.45
              }
            }
          ]
        }
      ],
      "roles": [
        {
          "role_id": 604,
          "role_label": "Cook",
          "total": {
            "regular_hours": 1.5,
            "regular_pay": 15.75,
            "overtime_hours": 2.5,
            "premium_overtime_hours": 2.5,
            "non_premium_overtime_hours": 2.5,
            "overtime_pay": 35.5,
            "premium_overtime_pay": 35.5,
            "non_premium_overtime_pay": 35.5,
            "holiday_hours": 3.5,
            "holiday_pay": 40.25,
            "compliance_exceptions_pay": 33.5,
            "total_hours": 7.5,
            "total_pay": 123.5,
            "total_tips": 123.5,
            "cash_tips": 123.5,
            "credit_card_tips": 123.5,
            "total_payment_tips": 123.5,
            "declared_tips": 123.5,
            "pos_declared_tips": 123.5,
            "auto_gratuity": 123.5,
            "withheld_cc_amount": 123.5,
            "tip_in": 123.5,
            "tip_out": 123.5,
            "earned_tips": 123.5,
            "tips_paid": 123.45,
            "tips_paid_on_shift": 123.45,
            "tips_paid_on_payouts": 123.45,
            "tips_to_be_paid": 123.45
          },
          "location_label": "Quacker's"
        }
      ],
      "total": {
        "regular_hours": 1.5,
        "regular_pay": 15.75,
        "overtime_hours": 2.5,
        "premium_overtime_hours": 2.5,
        "non_premium_overtime_hours": 2.5,
        "overtime_pay": 35.5,
        "premium_overtime_pay": 35.5,
        "non_premium_overtime_pay": 35.5,
        "holiday_hours": 3.5,
        "holiday_pay": 40.25,
        "compliance_exceptions_pay": 33.5,
        "total_hours": 7.5,
        "total_pay": 123.5,
        "total_tips": 123.5,
        "cash_tips": 123.5,
        "credit_card_tips": 123.5,
        "total_payment_tips": 123.5,
        "declared_tips": 123.5,
        "pos_declared_tips": 123.5,
        "auto_gratuity": 123.5,
        "withheld_cc_amount": 123.5,
        "tip_in": 123.5,
        "tip_out": 123.5,
        "earned_tips": 123.5,
        "tips_paid": 123.45,
        "tips_paid_on_shift": 123.45,
        "tips_paid_on_payouts": 123.45,
        "tips_to_be_paid": 123.45
      }
    }
  ],
  "show_exception_costs": true,
  "tip_tracking_enabled": true,
  "show_tips": true,
  "total": {
    "regular_hours": 1.5,
    "regular_pay": 15.75,
    "overtime_hours": 2.5,
    "premium_overtime_hours": 2.5,
    "non_premium_overtime_hours": 2.5,
    "overtime_pay": 35.5,
    "premium_overtime_pay": 35.5,
    "non_premium_overtime_pay": 35.5,
    "holiday_hours": 3.5,
    "holiday_pay": 40.25,
    "compliance_exceptions_pay": 33.5,
    "total_hours": 7.5,
    "total_pay": 123.5,
    "total_tips": 123.5,
    "cash_tips": 123.5,
    "credit_card_tips": 123.5,
    "total_payment_tips": 123.5,
    "declared_tips": 123.5,
    "pos_declared_tips": 123.5,
    "auto_gratuity": 123.5,
    "withheld_cc_amount": 123.5,
    "tip_in": 123.5,
    "tip_out": 123.5,
    "earned_tips": 123.5,
    "tips_paid": 123.45,
    "tips_paid_on_shift": 123.45,
    "tips_paid_on_payouts": 123.45,
    "tips_to_be_paid": 123.45
  },
  "start": "2021-01-01",
  "end": "2021-01-31"
}

Changes

  • 40e0ef40dfcdRevision changes
    • info

      added the required property ///// to the response with the status

    • info

      added the required property /////// to the response with the status