--- updatedAt: 2026-09-29T22:13:43.000Z agentTools: projectIndex: https://developers.7shifts.com/llms.txt --- # Retrieve Worked Hours and Wages **[Minimum Plan Required](https://developers.7shifts.com/docs/plan-requirements):** 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 [api-support@7shifts.com](mailto:api-support@7shifts.com). #### Sample Response ```json { "users": [ { "user": { "id": 7713791, "employee_id": "", "first_name": "James 007", "last_name": "Bond" }, "weeks": [ { "week": "2026-09-07", "salaried": false, "shifts": [ { "user_id": 7713791, "date": "2026-09-07 09:23:00", "week_label": "2026-09-07", "day_label": "Sep 7", "label": "9:23AM - 2:38PM", "breaks": [ "Paid Break - 10 min (11:23am - 11:33am)", "Unpaid Break - 30 min (12:23pm - 12:53pm)" ], "location_id": 389857, "location_label": "Restaurant", "role_id": 1948836, "role_label": "Line Cook", "role_color": "6A4C93", "wage": 11.89, "status": 3, "salaried": false, "compliance_exceptions": [], "total": { "regular_hours": 4.75, "regular_pay": 56.48, "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": 4.75, "total_pay": 56.48, "qualified_ot_premium": 0, "total_tips": 0, "cash_tips": 0, "credit_card_tips": 0, "total_payment_tips": 0, "withheld_cc_amount": 0, "auto_gratuity": 0, "tip_in": 0, "tip_out": 5.3, "earned_tips": 5.3, "declared_tips": 0, "pos_declared_tips": 0, "tips_paid": 0, "tips_paid_on_shift": 0, "tips_paid_on_payouts": 0, "tips_to_be_paid": 5.3, "tip_credit": 0, "tip_shortage": 0, "shifts_count": 1 }, "custom_flag_name": null, "custom_flag_color": null } ], "lone_compliance_exceptions": [], "total": { "regular_hours": 4.75, "regular_pay": 56.48, "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": 4.75, "total_pay": 56.48, "qualified_ot_premium": 0, "total_tips": 0, "cash_tips": 0, "credit_card_tips": 0, "total_payment_tips": 0, "withheld_cc_amount": 0, "auto_gratuity": 0, "tip_in": 0, "tip_out": 5.3, "earned_tips": 5.3, "declared_tips": 0, "pos_declared_tips": 0, "tips_paid": 0, "tips_paid_on_shift": 0, "tips_paid_on_payouts": 0, "tips_to_be_paid": 5.3, "tip_credit": 0, "tip_shortage": 0, "shifts_count": 1 } } ], "roles": [ { "role_id": 1948836, "role_label": "Line Cook", "total": { "regular_hours": 4.75, "regular_pay": 56.48, "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": 4.75, "total_pay": 56.48, "qualified_ot_premium": 0, "total_tips": 0, "cash_tips": 0, "credit_card_tips": 0, "total_payment_tips": 0, "withheld_cc_amount": 0, "auto_gratuity": 0, "tip_in": 0, "tip_out": 5.3, "earned_tips": 5.3, "declared_tips": 0, "pos_declared_tips": 0, "tips_paid": 0, "tips_paid_on_shift": 0, "tips_paid_on_payouts": 0, "tips_to_be_paid": 5.3, "tip_credit": 0, "tip_shortage": 0, "shifts_count": 1 }, "location_label": "Restaurant" } ], "total": { "regular_hours": 4.75, "regular_pay": 56.48, "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": 4.75, "total_pay": 56.48, "qualified_ot_premium": 0, "total_tips": 0, "cash_tips": 0, "credit_card_tips": 0, "total_payment_tips": 0, "withheld_cc_amount": 0, "auto_gratuity": 0, "tip_in": 0, "tip_out": 5.3, "earned_tips": 5.3, "declared_tips": 0, "pos_declared_tips": 0, "tips_paid": 0, "tips_paid_on_shift": 0, "tips_paid_on_payouts": 0, "tips_to_be_paid": 5.3, "tip_credit": 0, "tip_shortage": 0, "shifts_count": 1 }, "salaried": false } ], "show_exception_costs": true, "tip_tracking_enabled": true, "show_tips": true, "total": { "regular_hours": 4.75, "regular_pay": 56.48, "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": 4.75, "total_pay": 56.48, "qualified_ot_premium": 0, "total_tips": 0, "cash_tips": 0, "credit_card_tips": 0, "total_payment_tips": 0, "withheld_cc_amount": 0, "auto_gratuity": 0, "tip_in": 0, "tip_out": 5.3, "earned_tips": 5.3, "declared_tips": 0, "pos_declared_tips": 0, "tips_paid": 0, "tips_paid_on_shift": 0, "tips_paid_on_payouts": 0, "tips_to_be_paid": 5.3, "tip_credit": 0, "tip_shortage": 0, "shifts_count": 1 }, "start": "2026-09-07", "end": "2026-09-07" } ``` # OpenAPI definition ```json { "openapi": "3.0.2", "info": { "title": "7shifts API", "contact": { "email": "api-support@7shifts.com" }, "version": "2026-06-01" }, "servers": [ { "url": "https://api.7shifts.com", "description": "Production server" } ], "paths": { "/v2/reports/hours_and_wages": { "get": { "tags": [ "Reports" ], "summary": "Retrieve Worked Hours and Wages", "operationId": "getHoursAndWages", "x-public-api": true, "parameters": [ { "name": "x-api-version", "in": "header", "description": "7shifts API version", "required": false, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "An API version", "example": "2022-05-01" } }, { "name": "x-company-guid", "in": "header", "description": "Company GUID", "required": false, "schema": { "type": "string", "format": "uuid" }, "example": "1310bfe1-cb3f-4f24-98a2-fde2bc504108" }, { "name": "punches", "in": "query", "description": "Whether or not to use the punch labour source", "required": true, "schema": { "type": "boolean" } }, { "name": "company_id", "in": "query", "description": "The company id to pull the report for.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "from", "in": "query", "description": "Starting date for which you want the report to start.", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "example": "2019-12-01" }, { "name": "to", "in": "query", "description": "Ending date for which you want the report to end.", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "example": "2019-12-01" }, { "name": "location_id", "in": "query", "description": "The location id for which you want the report for.", "required": false, "schema": { "type": "integer", "format": "int64" }, "example": 1234 }, { "name": "department_id", "in": "query", "description": "The department id for the report.", "required": false, "schema": { "type": "integer", "format": "int64" }, "example": 1234 }, { "name": "role_id", "in": "query", "description": "The role id for the report", "required": false, "schema": { "type": "integer", "format": "int64" }, "example": 1234 }, { "name": "user_id", "in": "query", "description": "The user id the report should be fetched for - internal use only", "required": false, "schema": { "type": "integer", "format": "int64" }, "example": 1234 }, { "name": "include_tips", "in": "query", "description": "When true (default) tips data is included in the response. When false tips are not included in the response.", "required": false, "schema": { "type": "boolean", "nullable": true, "default": true }, "example": false }, { "name": "include_qualified_ot", "in": "query", "description": "When true (default) qualified overtime data is included in the response. When false qualified overtime is not included in the response.", "required": false, "schema": { "type": "boolean", "nullable": true, "default": true }, "example": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "users": { "type": "array", "description": "Report data for each employee", "items": { "type": "object", "properties": { "user": { "type": "object", "description": "Employee info", "properties": { "id": { "type": "number", "description": "User ID", "example": 123 }, "employee_id": { "type": "string", "description": "Employee payroll ID", "example": "82848183" }, "first_name": { "type": "string", "description": "First name", "example": "Bob" }, "last_name": { "type": "string", "description": "Last name", "example": "Loblaw" } } }, "weeks": { "type": "array", "description": "Report data for each work week", "items": { "type": "object", "properties": { "week": { "type": "string", "description": "Work week (first day of week)", "example": "2021-01-10" }, "salaried": { "type": "boolean", "description": "Whether employee is salaried during the entire week", "example": false }, "shifts": { "type": "array", "description": "Report data for each shift or time punch", "items": { "type": "object", "properties": { "user_id": { "type": "number", "description": "User ID", "example": 123 }, "date": { "type": "string", "description": "Date and time the shift or time punch started on", "example": "2020-01-12 13:45:00" }, "week_label": { "type": "string", "description": "Work week the shift or time punch occurred in", "example": "2020-01-10" }, "day_label": { "type": "string", "description": "Formatted day the shift or time punch started on", "example": "Dec 2" }, "label": { "type": "string", "description": "Start and end times of shift or time punch", "example": "1:45PM - 7:28PM" }, "breaks": { "type": "array", "description": "Breaks", "items": { "type": "string", "description": "Description of break", "example": "Coffee break (Paid) - 10 min (4:18pm - 4:28pm)" } }, "location_id": { "type": "number", "description": "Location ID", "example": 408 }, "location_label": { "type": "string", "description": "Location name", "example": "Quacker's" }, "role_id": { "type": "number", "description": "Role ID", "example": 604 }, "role_label": { "type": "string", "description": "Role name", "example": "Cook" }, "wage": { "type": "number", "description": "Hourly wage", "example": 15.5 }, "status": { "type": "number", "description": "Shift flag (late, no-show, sick)", "example": 0 }, "salaried": { "type": "boolean", "description": "Whether the employee was salaried during this shift", "example": false }, "compliance_exceptions": { "type": "array", "description": "Compliance exceptions for the shift", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "Exception date", "example": "2021-01-30T00:00:00.000Z" }, "violation_type": { "type": "string", "description": "Violation type of this exception", "example": "spread_of_hours, split_shift" }, "cost": { "type": "number", "description": "The cost of this exception (in dollars)", "example": 15.75 } } } }, "total": { "type": "object", "description": "Hours and pay info for a shift or group of shifts", "properties": { "regular_hours": { "type": "number", "description": "Regular hours", "example": 1.5 }, "regular_pay": { "type": "number", "description": "Regular pay", "example": 15.75 }, "overtime_hours": { "type": "number", "description": "Overtime hours", "example": 2.5 }, "premium_overtime_hours": { "type": "number", "description": "Premium / Double overtime hours", "example": 2.5 }, "non_premium_overtime_hours": { "type": "number", "description": "Daily + Weekly + Consecutive overtime hours", "example": 2.5 }, "overtime_pay": { "type": "number", "description": "Overtime pay", "example": 35.5 }, "premium_overtime_pay": { "type": "number", "description": "Premium / Double overtime pay", "example": 35.5 }, "non_premium_overtime_pay": { "type": "number", "description": "Daily + Weekly + Consecutive overtime pay", "example": 35.5 }, "holiday_hours": { "type": "number", "description": "Holiday hours", "example": 3.5 }, "holiday_pay": { "type": "number", "description": "Holiday pay", "example": 40.25 }, "compliance_exceptions_pay": { "type": "number", "description": "Compliance exceptions pay", "example": 33.5 }, "total_hours": { "type": "number", "description": "Total hours", "example": 7.5 }, "qualified_ot_premium": { "type": "string", "description": "Qualified overtime earned" }, "total_pay": { "type": "number", "description": "Total pay", "example": 123.5 }, "total_tips": { "type": "number", "description": "Tips declared by employee through 7punches", "example": 123.5 }, "cash_tips": { "type": "number", "description": "Cash tips", "example": 123.5 }, "credit_card_tips": { "type": "number", "description": "Credit card tips", "example": 123.5 }, "total_payment_tips": { "type": "number", "description": "DEPRECATED - same value as credit_card_tips", "example": 123.5 }, "declared_tips": { "type": "number", "description": "Declared tips either from 7punches or POS", "example": 123.5 }, "pos_declared_tips": { "type": "number", "description": "Declared tips from POS", "example": 123.5 }, "auto_gratuity": { "type": "number", "description": "Autogratuity", "example": 123.5 }, "withheld_cc_amount": { "type": "number", "description": "Withheld CC amount", "example": 123.5 }, "tip_in": { "type": "number", "description": "Tip in amount", "example": 123.5 }, "tip_out": { "type": "number", "description": "Tip out amount", "example": 123.5 }, "earned_tips": { "type": "number", "description": "Earned Tips", "example": 123.5 }, "tips_paid": { "type": "number", "description": "Tips that have been paid by employer", "example": 123.45 }, "tips_paid_on_shift": { "type": "number", "description": "Tips that have been paid on shift", "example": 123.45 }, "tips_paid_on_payouts": { "type": "number", "nullable": true, "description": "Tips that have been paid through tip payouts", "example": 123.45 }, "tips_to_be_paid": { "type": "number", "description": "Tips owed that have not been paid by employer", "example": 123.45 } }, "required": [ "regular_hours", "regular_pay", "overtime_hours", "overtime_pay", "holiday_hours", "holiday_pay", "compliance_exceptions_pay", "total_hours", "total_pay", "total_tips", "cash_tips", "credit_card_tips", "total_payment_tips", "declared_tips", "auto_gratuity", "withheld_cc_amount", "tip_in", "tip_out", "earned_tips", "tips_paid", "tips_paid_on_shift", "tips_to_be_paid", "qualified_ot_premium" ] } } } }, "lone_compliance_exceptions": { "type": "array", "description": "Compliance exceptions that aren't associated with any shift or time punch", "items": { "type": "object" } } } } }, "roles": { "type": "array", "description": "Hours and pay totals for each role the employee worked", "items": { "type": "object", "properties": { "role_id": { "type": "number", "description": "Role ID", "example": 604 }, "role_label": { "type": "string", "description": "Role name", "example": "Cook" }, "total": { "type": "object", "description": "Hours and pay info for a shift or group of shifts", "properties": { "regular_hours": { "type": "number", "description": "Regular hours", "example": 1.5 }, "regular_pay": { "type": "number", "description": "Regular pay", "example": 15.75 }, "overtime_hours": { "type": "number", "description": "Overtime hours", "example": 2.5 }, "premium_overtime_hours": { "type": "number", "description": "Premium / Double overtime hours", "example": 2.5 }, "non_premium_overtime_hours": { "type": "number", "description": "Daily + Weekly + Consecutive overtime hours", "example": 2.5 }, "overtime_pay": { "type": "number", "description": "Overtime pay", "example": 35.5 }, "premium_overtime_pay": { "type": "number", "description": "Premium / Double overtime pay", "example": 35.5 }, "non_premium_overtime_pay": { "type": "number", "description": "Daily + Weekly + Consecutive overtime pay", "example": 35.5 }, "holiday_hours": { "type": "number", "description": "Holiday hours", "example": 3.5 }, "holiday_pay": { "type": "number", "description": "Holiday pay", "example": 40.25 }, "compliance_exceptions_pay": { "type": "number", "description": "Compliance exceptions pay", "example": 33.5 }, "total_hours": { "type": "number", "description": "Total hours", "example": 7.5 }, "total_pay": { "type": "number", "description": "Total pay", "example": 123.5 }, "qualified_ot_premium": { "type": "string", "description": "Qualified overtime earned" }, "total_tips": { "type": "number", "description": "Tips declared by employee through 7punches", "example": 123.5 }, "cash_tips": { "type": "number", "description": "Cash tips", "example": 123.5 }, "credit_card_tips": { "type": "number", "description": "Credit card tips", "example": 123.5 }, "total_payment_tips": { "type": "number", "description": "DEPRECATED - same value as credit_card_tips", "example": 123.5 }, "declared_tips": { "type": "number", "description": "Declared tips either from 7punches or POS", "example": 123.5 }, "pos_declared_tips": { "type": "number", "description": "Declared tips from POS", "example": 123.5 }, "auto_gratuity": { "type": "number", "description": "Autogratuity", "example": 123.5 }, "withheld_cc_amount": { "type": "number", "description": "Withheld CC amount", "example": 123.5 }, "tip_in": { "type": "number", "description": "Tip in amount", "example": 123.5 }, "tip_out": { "type": "number", "description": "Tip out amount", "example": 123.5 }, "earned_tips": { "type": "number", "description": "Earned Tips", "example": 123.5 }, "tips_paid": { "type": "number", "description": "Tips that have been paid by employer", "example": 123.45 }, "tips_paid_on_shift": { "type": "number", "description": "Tips that have been paid on shift", "example": 123.45 }, "tips_paid_on_payouts": { "type": "number", "nullable": true, "description": "Tips that have been paid through tip payouts", "example": 123.45 }, "tips_to_be_paid": { "type": "number", "description": "Tips owed that have not been paid by employer", "example": 123.45 } }, "required": [ "regular_hours", "regular_pay", "overtime_hours", "overtime_pay", "holiday_hours", "holiday_pay", "compliance_exceptions_pay", "total_hours", "total_pay", "total_tips", "cash_tips", "credit_card_tips", "total_payment_tips", "declared_tips", "auto_gratuity", "withheld_cc_amount", "tip_in", "tip_out", "earned_tips", "tips_paid", "tips_paid_on_shift", "tips_to_be_paid", "qualified_ot_premium" ] }, "location_label": { "type": "string", "description": "Location name", "example": "Quacker's" } } } }, "total": { "type": "object", "description": "Hours and pay info for a shift or group of shifts", "properties": { "regular_hours": { "type": "number", "description": "Regular hours", "example": 1.5 }, "regular_pay": { "type": "number", "description": "Regular pay", "example": 15.75 }, "overtime_hours": { "type": "number", "description": "Overtime hours", "example": 2.5 }, "premium_overtime_hours": { "type": "number", "description": "Premium / Double overtime hours", "example": 2.5 }, "non_premium_overtime_hours": { "type": "number", "description": "Daily + Weekly + Consecutive overtime hours", "example": 2.5 }, "overtime_pay": { "type": "number", "description": "Overtime pay", "example": 35.5 }, "premium_overtime_pay": { "type": "number", "description": "Premium / Double overtime pay", "example": 35.5 }, "non_premium_overtime_pay": { "type": "number", "description": "Daily + Weekly + Consecutive overtime pay", "example": 35.5 }, "holiday_hours": { "type": "number", "description": "Holiday hours", "example": 3.5 }, "holiday_pay": { "type": "number", "description": "Holiday pay", "example": 40.25 }, "compliance_exceptions_pay": { "type": "number", "description": "Compliance exceptions pay", "example": 33.5 }, "total_hours": { "type": "number", "description": "Total hours", "example": 7.5 }, "total_pay": { "type": "number", "description": "Total pay", "example": 123.5 }, "total_tips": { "type": "number", "description": "Tips declared by employee through 7punches", "example": 123.5 }, "cash_tips": { "type": "number", "description": "Cash tips", "example": 123.5 }, "credit_card_tips": { "type": "number", "description": "Credit card tips", "example": 123.5 }, "total_payment_tips": { "type": "number", "description": "DEPRECATED - same value as credit_card_tips", "example": 123.5 }, "declared_tips": { "type": "number", "description": "Declared tips either from 7punches or POS", "example": 123.5 }, "pos_declared_tips": { "type": "number", "description": "Declared tips from POS", "example": 123.5 }, "auto_gratuity": { "type": "number", "description": "Autogratuity", "example": 123.5 }, "withheld_cc_amount": { "type": "number", "description": "Withheld CC amount", "example": 123.5 }, "tip_in": { "type": "number", "description": "Tip in amount", "example": 123.5 }, "tip_out": { "type": "number", "description": "Tip out amount", "example": 123.5 }, "earned_tips": { "type": "number", "description": "Earned Tips", "example": 123.5 }, "tips_paid": { "type": "number", "description": "Tips that have been paid by employer", "example": 123.45 }, "tips_paid_on_shift": { "type": "number", "description": "Tips that have been paid on shift", "example": 123.45 }, "tips_paid_on_payouts": { "type": "number", "nullable": true, "description": "Tips that have been paid through tip payouts", "example": 123.45 }, "tips_to_be_paid": { "type": "number", "description": "Tips owed that have not been paid by employer", "example": 123.45 } }, "required": [ "regular_hours", "regular_pay", "overtime_hours", "overtime_pay", "holiday_hours", "holiday_pay", "compliance_exceptions_pay", "total_hours", "total_pay", "total_tips", "cash_tips", "credit_card_tips", "total_payment_tips", "declared_tips", "auto_gratuity", "withheld_cc_amount", "tip_in", "tip_out", "earned_tips", "tips_paid", "tips_paid_on_shift", "tips_to_be_paid" ] }, "salaried": { "type": "boolean", "description": "Whether employee is salaried during the entire date range of the report", "example": false } } } }, "show_exception_costs": { "type": "boolean", "description": "Whether compliance exceptions and their costs should be shown", "example": true }, "tip_tracking_enabled": { "type": "boolean", "description": "Whether tips from integrations should be shown", "example": true }, "show_tips": { "type": "boolean", "description": "Whether we should render the tips column", "example": true }, "total": { "type": "object", "description": "Hours and pay info for a shift or group of shifts", "properties": { "regular_hours": { "type": "number", "description": "Regular hours", "example": 1.5 }, "regular_pay": { "type": "number", "description": "Regular pay", "example": 15.75 }, "overtime_hours": { "type": "number", "description": "Overtime hours", "example": 2.5 }, "premium_overtime_hours": { "type": "number", "description": "Premium / Double overtime hours", "example": 2.5 }, "non_premium_overtime_hours": { "type": "number", "description": "Daily + Weekly + Consecutive overtime hours", "example": 2.5 }, "overtime_pay": { "type": "number", "description": "Overtime pay", "example": 35.5 }, "premium_overtime_pay": { "type": "number", "description": "Premium / Double overtime pay", "example": 35.5 }, "non_premium_overtime_pay": { "type": "number", "description": "Daily + Weekly + Consecutive overtime pay", "example": 35.5 }, "holiday_hours": { "type": "number", "description": "Holiday hours", "example": 3.5 }, "holiday_pay": { "type": "number", "description": "Holiday pay", "example": 40.25 }, "compliance_exceptions_pay": { "type": "number", "description": "Compliance exceptions pay", "example": 33.5 }, "total_hours": { "type": "number", "description": "Total hours", "example": 7.5 }, "total_pay": { "type": "number", "description": "Total pay", "example": 123.5 }, "total_tips": { "type": "number", "description": "Tips declared by employee through 7punches", "example": 123.5 }, "cash_tips": { "type": "number", "description": "Cash tips", "example": 123.5 }, "credit_card_tips": { "type": "number", "description": "Credit card tips", "example": 123.5 }, "total_payment_tips": { "type": "number", "description": "DEPRECATED - same value as credit_card_tips", "example": 123.5 }, "declared_tips": { "type": "number", "description": "Declared tips either from 7punches or POS", "example": 123.5 }, "pos_declared_tips": { "type": "number", "description": "Declared tips from POS", "example": 123.5 }, "auto_gratuity": { "type": "number", "description": "Autogratuity", "example": 123.5 }, "withheld_cc_amount": { "type": "number", "description": "Withheld CC amount", "example": 123.5 }, "tip_in": { "type": "number", "description": "Tip in amount", "example": 123.5 }, "tip_out": { "type": "number", "description": "Tip out amount", "example": 123.5 }, "earned_tips": { "type": "number", "description": "Earned Tips", "example": 123.5 }, "tips_paid": { "type": "number", "description": "Tips that have been paid by employer", "example": 123.45 }, "tips_paid_on_shift": { "type": "number", "description": "Tips that have been paid on shift", "example": 123.45 }, "tips_paid_on_payouts": { "type": "number", "nullable": true, "description": "Tips that have been paid through tip payouts", "example": 123.45 }, "tips_to_be_paid": { "type": "number", "description": "Tips owed that have not been paid by employer", "example": 123.45 } }, "required": [ "regular_hours", "regular_pay", "overtime_hours", "overtime_pay", "holiday_hours", "holiday_pay", "compliance_exceptions_pay", "total_hours", "total_pay", "total_tips", "cash_tips", "credit_card_tips", "total_payment_tips", "declared_tips", "auto_gratuity", "withheld_cc_amount", "tip_in", "tip_out", "earned_tips", "tips_paid", "tips_paid_on_shift", "tips_to_be_paid" ] }, "start": { "type": "string", "format": "date", "description": "Start date of report date range", "example": "2021-01-01" }, "end": { "type": "string", "format": "date", "description": "End date of report date range", "example": "2021-01-31" } }, "required": [ "users", "show_exception_costs", "tip_tracking_enabled", "show_tips", "total", "start", "end" ] } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "The primary identifier for the problem type (URI reference)." }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization." }, "status": { "type": "integer", "description": "The HTTP status code." }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem." }, "code": { "type": "integer", "description": "The error code can be used to look up the reason why the request failed." }, "param": { "type": "string", "description": "The request parameter that this error is related to." } }, "required": [ "type", "title", "status", "detail" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "The primary identifier for the problem type (URI reference)." }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization." }, "status": { "type": "integer", "description": "The HTTP status code." }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem." }, "code": { "type": "integer", "description": "The error code can be used to look up the reason why the request failed." }, "param": { "type": "string", "description": "The request parameter that this error is related to." } }, "required": [ "type", "title", "status", "detail" ] } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "The primary identifier for the problem type (URI reference)." }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization." }, "status": { "type": "integer", "description": "The HTTP status code." }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem." }, "code": { "type": "integer", "description": "The error code can be used to look up the reason why the request failed." }, "param": { "type": "string", "description": "The request parameter that this error is related to." } }, "required": [ "type", "title", "status", "detail" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "The primary identifier for the problem type (URI reference)." }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization." }, "status": { "type": "integer", "description": "The HTTP status code." }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem." }, "code": { "type": "integer", "description": "The error code can be used to look up the reason why the request failed." }, "param": { "type": "string", "description": "The request parameter that this error is related to." } }, "required": [ "type", "title", "status", "detail" ] } } } } } } } }, "components": { "securitySchemes": { "OAuth2": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://app.7shifts.com/oauth2/token", "refreshUrl": "https://app.7shifts.com/oauth2/token", "scopes": { "v1_access": "Required to access APIv1 endpoints." } }, "password": { "tokenUrl": "https://app.7shifts.com/oauth2/token", "refreshUrl": "https://app.7shifts.com/oauth2/token", "scopes": { "v1_access": "Required to access APIv1 endpoints." } }, "authorizationCode": { "authorizationUrl": "https://app.7shifts.com/oauth2/authorize", "tokenUrl": "https://app.7shifts.com/oauth2/token", "refreshUrl": "https://app.7shifts.com/oauth2/token", "scopes": { "v1_access": "Required to access APIv1 endpoints." } } } }, "cookieAuth": { "type": "apiKey", "in": "cookie", "name": "7session" } } }, "security": [ { "OAuth2": [] }, { "cookieAuth": [] } ], "tags": [ { "name": "Reports" } ] } ```