Get Worker Time Tracking Summary

This endpoint serves the purpose of fetching worker time tracking summary based on unique worker UUID and date.

GET /time-tracking/worker-summary

Get Worker Time Tracking Summary

cURL

curl --request GET \
  --url https://api.roostedhr.com/api/1_12/time-tracking/worker-summary \
  --header 'X-API-KEY: <api-key>'

200

{
  "weeks": [
    {
      "start_of_week": "YYYY-MM-DD",
      "end_of_week": "YYYY-MM-DD",
      "start_of_week_nice": "<string>",
      "end_of_week_nice": "<string>",
      "week": {
        "[weekDayDate]": {
          "punches": [
            "<string>"
          ],
          "stats": {
            "total_hours": 123,
            "total_minutes": 123,
            "hours": 123,
            "minutes": 123,
            "ot_hours": 123,
            "ot_minutes": 123,
            "dt_hours": 123,
            "dt_minutes": 123,
            "punches": [
              "<string>"
            ],
            "ot_reason": {
              "daily": true,
              "weekly": true
            },
            "dt_reason": {
              "daily": true,
              "weekly": true
            },
            "problems": 123,
            "payroll_groups": {
              "[key]": {
                "total_hours": 123,
                "total_minutes": 123,
                "hours": 123,
                "minutes": 123,
                "ot_hours": 123,
                "ot_minutes": 123,
                "dt_hours": 123,
                "dt_minutes": 123,
                "punches": [
                  "<string>"
                ],
                "payroll_item_id": "<string>",
                "invoice_cost": "<string>"
              }
            },
            "client": {
              "[key]": {
                "total_hours": 123,
                "total_minutes": 123,
                "hours": 123,
                "minutes": 123,
                "ot_hours": 123,
                "ot_minutes": 123,
                "dt_hours": 123,
                "dt_minutes": 123,
                "punches": [
                  "<string>"
                ],
                "client_invoice_customer_id": "<string>"
              }
            },
            "client_payroll_group": {
              "[key]": {
                "total_hours": 123,
                "total_minutes": 123,
                "hours": 123,
                "minutes": 123,
                "ot_hours": 123,
                "ot_minutes": 123,
                "dt_hours": 123,
                "dt_minutes": 123,
                "punches": [
                  "<string>"
                ],
                "payroll_item_id": "<string>",
                "invoice_cost": "<string>",
                "client_invoice_customer_id": "<string>"
              }
            },
            "client_payroll_group_erf": {
              "[key]": {
                "total_hours": 123,
                "total_minutes": 123,
                "hours": 123,
                "minutes": 123,
                "ot_hours": 123,
                "ot_minutes": 123,
                "dt_hours": 123,
                "dt_minutes": 123,
                "punches": [
                  "<string>"
                ],
                "payroll_item_id": "<string>",
                "invoice_cost": "<string>",
                "client_invoice_customer_id": "<string>",
                "erf_id": "<string>"
              }
            },
            "linkedEventsGroup": {
              "[key]": {
                "total_hours": 123,
                "total_minutes": 123,
                "hours": 123,
                "minutes": 123,
                "ot_hours": 123,
                "ot_minutes": 123,
                "dt_hours": 123,
                "dt_minutes": 123,
                "punches": [
                  "<string>"
                ],
                "payroll_item_id": "<string>",
                "invoice_cost": "<string>",
                "client_invoice_customer_id": "<string>",
                "erf_id": "<string>"
              }
            }
          },
          "too_early": true,
          "too_late": true,
          "worked": true
        },
        "keyArray": [
          "<string>"
        ],
        "extraData": {
          "[weekDayDate]": {
            "niceDate": "<string>"
          }
        },
        "week_stats": {
          "total_hours": 123,
          "total_minutes": 123,
          "hours": 123,
          "minutes": 123,
          "ot_hours": 123,
          "ot_minutes": 123,
          "ot_reason": {
            "daily": true,
            "weekly": true
          },
          "dt_hours": 123,
          "dt_minutes": 123,
          "dt_reason": {
            "daily": true,
            "weekly": true
          },
          "r_hours": 123,
          "r_minutes": 123,
          "r_ot_hours": 123,
          "r_ot_minutes": 123,
          "r_dt_hours": 123,
          "r_dt_minutes": 123,
          "problems": 123,
          "days_worked": 123,
          "total_punches": 123,
          "wages": [
            {
              "hours": 123,
              "minutes": 123
            }
          ],
          "min_hours_additional": 123,
          "min_minutes_additional": 123,
          "finalized_hours": 123,
          "finalized_minutes": 123,
          "premium_hours": 123,
          "premium_minutes": 123,
          "premium_dt_hours": 123,
          "premium_dt_minutes": 123
        },
        "punches": [
          {
            "id": "<string>",
            "p_id": "<string>",
            "erf_id": "<string>",
            "ern_id": "<string>",
            "manager_id": "<string>",
            "events_roles_placeholders_id": "<string>",
            "latitude": "<string>",
            "longitude": "<string>",
            "source": "<string>",
            "punch_datetime": "<string>",
            "converted_punch_datetime": "<string>",
            "status": "<string>",
            "clock_picture_location": "<string>",
            "insert_date": "<string>",
            "override_max_shift_time": "<string>",
            "original_datetime": "<string>",
            "time_change_request": "<string>",
            "time_change_request_submitted": "<string>",
            "client_sign_datetime": "<string>",
            "delete_requested": "<string>",
            "open": "<string>",
            "bad_location": "<string>",
            "client_name": "<string>",
            "client_invoice_customer_id": "<string>",
            "client_daily_overtime_cutoff": "<string>",
            "role_daily_overtime_cutoff": "<string>",
            "client_daily_doubletime_cutoff": "<string>",
            "role_daily_doubletime_cutoff": "<string>",
            "spot_wage": "<string>",
            "shift_wage": "<string>",
            "personnel_pay_rate": "<string>",
            "client_pay_rate": "<string>",
            "role_pay_rate": "<string>",
            "spot_billing_rate": "<string>",
            "shift_billing": "<string>",
            "personnel_billing_rate": "<string>",
            "client_billing_rate": "<string>",
            "role_billing_rate": "<string>",
            "spot_billing_rate_hourly_type": "<string>",
            "shift_billing_rate_hourly_type": "<string>",
            "spot_wage_hourly_type": "<string>",
            "shift_wage_hourly_type": "<string>",
            "personnel_hourly_type": "<string>",
            "client_hourly_type": "<string>",
            "role_hourly_type": "<string>",
            "daily_overtime_cutoff": "<string>",
            "daily_doubletime_cutoff": "<string>",
            "client_advanced_payroll_rules": "<string>",
            "role_advanced_payroll_rules": "<string>",
            "first_shift_of_day": "<string>",
            "first_shift_of_day_id": "<string>",
            "first_skillset_shift_of_day": "<string>",
            "first_skillset_shift_of_day_id": "<string>",
            "rate_cards_id": "<string>",
            "signature_datetime": "<string>",
            "travel_hours_before": "<string>",
            "travel_hours_after": "<string>",
            "signature_name": "<string>",
            "signature_notes": "<string>",
            "signature_location": "<string>",
            "ern_link_id": "<string>",
            "job_link_id": "<string>",
            "time_tracking_manager_name": "<string>",
            "event_name": "<string>",
            "location_id": "<string>",
            "location": "<string>",
            "addy_city": "<string>",
            "timezone_name": "<string>",
            "companies_payroll_rulesets_id": "<string>",
            "payroll_ruleset_display": "<string>",
            "jobs_id": "<string>",
            "custom_event_id": "<string>",
            "areas": "<string>",
            "worker_areas": [
              "<string>"
            ],
            "tags": [
              "<string>"
            ],
            "client_id": "<string>",
            "event_tags": [
              "<string>"
            ],
            "ern_start": "<string>",
            "ern_date": "<string>",
            "ern_start_date": "<string>",
            "nice_ern_start": "<string>",
            "role_title": "<string>",
            "ern_end": "<string>",
            "payroll_groups_id": "<string>",
            "payroll_groups_name": "<string>",
            "rate_cards_name": "<string>",
            "payroll_item_id": "<string>",
            "payroll_groups_deleted": "<string>",
            "payroll_groups_cost": "<string>",
            "worker_signature_location": "<string>",
            "worker_signature_comments": "<string>",
            "worker_signature_datetime": "<string>",
            "worker_signature_custom_acknowledgement": "<string>",
            "payroll_rules_custom": [
              {}
            ],
            "timezone_data": "<string>",
            "nice_shiftedPunch": "<string>",
            "nice_shiftedPunch_ampm": "<string>",
            "worker_signature_missing": true,
            "worker_signature_datetime_display": "<string>",
            "punchDate": "<string>",
            "shiftedPunch": "<string>",
            "nicePunch": "<string>",
            "scheduledHours": 123,
            "clockType": "<string>",
            "in_punch": "<string>",
            "min_hours_rules": [
              {
                "id": "<string>",
                "new_id": "<string>",
                "company_id": "<string>",
                "name": "<string>",
                "importance": "<string>",
                "conflicts_with": "<string>",
                "type": "<string>",
                "holiday": "<string>",
                "day_of_week": "<string>",
                "date": "<string>",
                "start_time": "<string>",
                "end_time": "<string>",
                "minimum_hours": "<string>",
                "minimum_hours_min_cutoff": "<string>",
                "minimum_hours_max_cutoff": "<string>",
                "minimum_hours_first_shift_of_day": "<string>",
                "minimum_hours_first_shift_of_day_skillset": "<string>",
                "shift_length_minimum_hours": "<string>",
                "deleted": "<string>",
                "insert_date": "<string>",
                "deleted_date": "<string>",
                "late_allowance_minutes": "<string>",
                "start_only": "<string>",
                "punch_start_if_no_ern": "<string>",
                "punch_start_only": "<string>",
                "only_between": "<string>",
                "daily_overtime_hours": "<string>",
                "daily_doubletime_hours": "<string>",
                "never_use": "<string>",
                "all_payroll_groups": "<string>",
                "all_locations": "<string>",
                "midnight_reset": "<string>",
                "min_break_hours": "<string>",
                "max_break_hours": "<string>",
                "break_minutes": "<string>",
                "rounding_interval_minutes": "<string>",
                "premium_time": "<string>",
                "locations": [
                  {}
                ],
                "locations_excluded": [
                  {}
                ],
                "payroll_groups": [
                  {}
                ],
                "payroll_groups_excluded": [
                  {}
                ],
                "holiday_display": "<string>"
              }
            ],
            "difference": {
              "[weekDayDate]": {
                "hours": 123,
                "minutes": 123
              }
            },
            "possibleDuplicate": true,
            "brokenDown": {
              "[weekDayDate]": {
                "total_hours": 123,
                "total_minutes": 123,
                "hours": 123,
                "minutes": 123,
                "ot_hours": 123,
                "ot_minutes": 123,
                "dt_hours": 123,
                "dt_minutes": 123,
                "punches": [
                  "<string>"
                ]
              }
            },
            "brokenDownKeys": [
              "<string>"
            ],
            "too_early_start": "<string>",
            "too_early_daily": "<string>",
            "rules": [
              {
                "id": "<string>",
                "new_id": "<string>",
                "company_id": "<string>",
                "name": "<string>",
                "importance": "<string>",
                "conflicts_with": "<string>",
                "type": "<string>",
                "holiday": "<string>",
                "day_of_week": "<string>",
                "date": "<string>",
                "start_time": "<string>",
                "end_time": "<string>",
                "minimum_hours": "<string>",
                "minimum_hours_min_cutoff": null,
                "minimum_hours_max_cutoff": null,
                "minimum_hours_first_shift_of_day": "<string>",
                "minimum_hours_first_shift_of_day_skillset": "<string>",
                "shift_length_minimum_hours": "<string>",
                "deleted": "<string>",
                "insert_date": "<string>",
                "deleted_date": "<string>",
                "late_allowance_minutes": "<string>",
                "start_only": "<string>",
                "punch_start_if_no_ern": "<string>",
                "punch_start_only": "<string>",
                "only_between": "<string>",
                "daily_overtime_hours": "<string>",
                "daily_doubletime_hours": "<string>",
                "never_use": "<string>",
                "all_payroll_groups": "<string>",
                "all_locations": "<string>",
                "midnight_reset": "<string>",
                "min_break_hours": "<string>",
                "max_break_hours": "<string>",
                "break_minutes": "<string>",
                "rounding_interval_minutes": "<string>",
                "premium_time": "<string>",
                "locations": [
                  {}
                ],
                "locations_excluded": [
                  {}
                ],
                "payroll_groups": [
                  {}
                ],
                "payroll_groups_excluded": [
                  {}
                ],
                "holiday_display": "<string>"
              }
            ],
            "payrollRules": [
              {}
            ]
          }
        ],
        "days_worked": 123
      }
    }
  ],
  "pay_period_stats": {
    "total_hours": 123,
    "total_minutes": 123,
    "hours": 123,
    "minutes": 123,
    "ot_hours": 123,
    "ot_minutes": 123,
    "ot_reason": {
      "daily": true,
      "weekly": true
    },
    "dt_hours": 123,
    "dt_minutes": 123,
    "dt_reason": {
      "daily": true,
      "weekly": true
    },
    "r_hours": 123,
    "r_minutes": 123,
    "r_ot_hours": 123,
    "r_ot_minutes": 123,
    "r_dt_hours": 123,
    "r_dt_minutes": 123,
    "problems": 123,
    "days_worked": 123,
    "total_punches": 123,
    "wages": [
      {
        "hours": 123,
        "minutes": 123
      }
    ],
    "min_hours_additional": 123,
    "min_minutes_additional": 123,
    "finalized_hours": 123,
    "finalized_minutes": 123,
    "premium_hours": 123,
    "premium_minutes": 123,
    "premium_dt_hours": 123,
    "premium_dt_minutes": 123,
    "modify_punches": 123,
    "delete_punches": 123,
    "open_punches": 123,
    "pending_punches": 123,
    "pending_reimbursements": 123
  },
  "start": "<string>",
  "start_basic": "YYYY-MM-DD",
  "end": "<string>",
  "end_basic": "YYYY-MM-DD"
}

Authorizations

X-API-KEY · string · header · required

Query Parameters

worker_uuid · string · required

Worker UUID

Required string length: 10

Pattern: ^[a-zA-Z0-9]+$

date · string<date> · required

Date

Pattern: ^\d{4}-\d{2}-\d{2}$

Example:

"2020-12-20"

Response

200

application/json

OK

weeks · object[]

Show child attributes

pay_period_stats · object

Show child attributes

start · string

start_basic · string<date>

Example:

"YYYY-MM-DD"

end · string

end_basic · string<date>

Example:

"YYYY-MM-DD"