Time Punches

Time Punch objects are published with every clock action and contain child objects that describe included reference data.

Key Concepts and Clock Status

Shifts

At the top level is the concept of "shift," which is used as an envelope for the activities that capture time worked and time rested.

Work Time

Beneath Shifts, "WorkTime" records are Date/Time pairs, assigned to a type value in order to frame paid and unpaid time.

Structurally, this creates the following relationship between WorkTime and their parent shift.

Shift 1 (7a-3p)
- WorkTime 1 (Clock In - 7a, Break Out - 11a)
- WorkTime 2 (Break In - 11:15a, Clock Out - 3p)

Clock Status

This field describes the status of a given shift at the time of the message.

Drawer Status	Description
CLOCKED_IN	Reflects that an employee has begun a work shift
CLOCKED_OUT	Reflects that an employee has ended a work shift

The Example Time Punch Object shows an example of an order object that is published to the webhook URL.

The Data Models section defines the objects and attributes that the Data Stream service sends as part of the Time Punch Object.

Example Time Punch Object

The code below shows an example of a Time Punch Object that is published to the webhook URL:

{
  "entityName": "TimePunch",
  "data": {
    "model": {
      "shift_id": "690c912f9d61f8b7e3cf6cb7",
      "initial_shift_id": null,
      "employee_id": "690c90c7862f3e55518d85de",
      "start_date_time": "2025-11-05T14:00:00-08:00",
      "end_date_time": "2025-11-05T21:00:00-08:00",
      "is_active": true,
      "site_id": "604f88bfe314e100089a1b5b",
      "status": "CLOCKED_OUT",
      "source": "PunchEditor",
      "actual_update_date": "2025-11-06T12:14:55.124",
      "history": {
        "previous": {
          "start_date_time": "2025-11-05T14:00:00-08:00",
          "end_date_time": "2025-11-05T22:00:00-08:00",
          "is_active": true,
          "update_date": "2025-11-06T12:14:39.000Z",
          "actual_update_date": "2025-11-06T12:14:39.040Z",
          "update_user": "5f50df662ffd58000765526e",
          "updater_type": "access",
          "shift_adjustment_note": "note",
          "punch_adjustment_reason_id": "58f66d447020f950c17c3e5c",
          "work_times": [
            {
              "employee_work_time_id": "690c912f9d61f8b7e3cf6cb8",
              "employee_job_id": "690c90c8862f3e55518d85e0",
              "business_date": "2025-11-05",
              "clock_in": "2025-11-05T14:00:00-08:00",
              "clock_in_type_id": "58f66d457020f950c17c3e5e",
              "clock_out": "2025-11-05T18:00:00-08:00",
              "clock_out_type_id": "58f66d447020f950c17c3e5d",
              "break_time_id": "58ff592b2804e6056e019f7d",
              "work_type_id": "58f68e1f7020f950c17c3e6e",
              "rate": null,
              "clock_in_approval_id": null,
              "clock_in_approval_person_id": "5f50df662ffd58000765526e",
              "clock_out_approval_id": null,
              "clock_out_approval_person_id": "5f50df662ffd58000765526e",
              "update_date": "2025-11-06T12:14:39.000Z",
              "is_active": true,
              "transactions": []
            },
            {
              "employee_work_time_id": "690c912f9d61f8b7e3cf6cba",
              "employee_job_id": "690c90c8862f3e55518d85e0",
              "business_date": "2025-11-05",
              "clock_in": "2025-11-05T18:15:00-08:00",
              "clock_in_type_id": "58f66d447020f950c17c3e5c",
              "clock_out": "2025-11-05T22:00:00-08:00",
              "clock_out_type_id": "58f66d467020f950c17c3e5f",
              "break_time_id": null,
              "work_type_id": "58f68e1f7020f950c17c3e6e",
              "rate": null,
              "clock_in_approval_id": null,
              "clock_in_approval_person_id": "5f50df662ffd58000765526e",
              "clock_out_approval_id": null,
              "clock_out_approval_person_id": "5f50df662ffd58000765526e",
              "update_date": "2025-11-06T12:14:39.000Z",
              "is_active": true,
              "transactions": [
                {
                  "tender_mapping_id": "58ff5d45555005ae42f8c7e1",
                  "tender_category_code": "DTIP",
                  "tender_type_code": "CREDIT",
                  "tender_currency_code": "USD",
                  "amount": 45,
                  "is_active": true
                },
                {
                  "tender_mapping_id": "58ff5d38555005ae42f8c7df",
                  "tender_category_code": "DTIP",
                  "tender_type_code": "CASH",
                  "tender_currency_code": "USD",
                  "amount": 12,
                  "is_active": true
                },
                {
                  "tender_mapping_id": "58ff5d45555005ae42f8c7e2",
                  "tender_category_code": "SALES",
                  "tender_type_code": "CREDIT",
                  "tender_currency_code": "USD",
                  "amount": 1891.75,
                  "is_active": true
                },
                {
                  "tender_mapping_id": "58ff5d45555005ae42f8c7e0",
                  "tender_category_code": "SALES",
                  "tender_type_code": "CASH",
                  "tender_currency_code": "USD",
                  "amount": 10099,
                  "is_active": true
                }
              ]
            }
          ],
          "source": "PunchEditor"
        },
        "current": {
          "start_date_time": "2025-11-05T14:00:00-08:00",
          "end_date_time": "2025-11-05T21:00:00-08:00",
          "is_active": true,
          "update_date": "2025-11-06T12:14:55.321Z",
          "actual_update_date": "2025-11-06T12:14:55.124Z",
          "update_user": "5f50df662ffd58000765526e",
          "updater_type": "access",
          "shift_adjustment_note": null,
          "punch_adjustment_reason_id": null,
          "work_times": [
            {
              "employee_work_time_id": "690c912f9d61f8b7e3cf6cb8",
              "employee_job_id": "690c90c8862f3e55518d85e0",
              "business_date": "2025-11-05",
              "clock_in": "2025-11-05T14:00:00-08:00",
              "clock_in_type_id": "58f66d457020f950c17c3e5e",
              "clock_out": "2025-11-05T18:00:00-08:00",
              "clock_out_type_id": "58f66d447020f950c17c3e5d",
              "break_time_id": "58ff592b2804e6056e019f7d",
              "work_type_id": "58f68e1f7020f950c17c3e6e",
              "rate": null,
              "clock_in_approval_id": null,
              "clock_in_approval_person_id": "5f50df662ffd58000765526e",
              "clock_out_approval_id": null,
              "clock_out_approval_person_id": "5f50df662ffd58000765526e",
              "update_date": "2025-11-06T12:14:55.235Z",
              "is_active": true,
              "transactions": []
            },
            {
              "employee_work_time_id": "690c912f9d61f8b7e3cf6cba",
              "employee_job_id": "690c90c8862f3e55518d85e0",
              "business_date": "2025-11-05",
              "clock_in": "2025-11-05T18:15:00-08:00",
              "clock_in_type_id": "58f66d447020f950c17c3e5c",
              "clock_out": "2025-11-05T21:00:00-08:00",
              "clock_out_type_id": "58f66d467020f950c17c3e5f",
              "break_time_id": null,
              "work_type_id": "58f68e1f7020f950c17c3e6e",
              "rate": null,
              "clock_in_approval_id": null,
              "clock_in_approval_person_id": "5f50df662ffd58000765526e",
              "clock_out_approval_id": null,
              "clock_out_approval_person_id": "5f50df662ffd58000765526e",
              "update_date": "2025-11-06T12:14:55.299Z",
              "is_active": true,
              "transactions": [
                {
                  "tender_mapping_id": "58ff5d45555005ae42f8c7e1",
                  "tender_category_code": "DTIP",
                  "tender_type_code": "CREDIT",
                  "tender_currency_code": "USD",
                  "amount": 45,
                  "is_active": true
                },
                {
                  "tender_mapping_id": "58ff5d38555005ae42f8c7df",
                  "tender_category_code": "DTIP",
                  "tender_type_code": "CASH",
                  "tender_currency_code": "USD",
                  "amount": 12,
                  "is_active": true
                },
                {
                  "tender_mapping_id": "58ff5d45555005ae42f8c7e2",
                  "tender_category_code": "SALES",
                  "tender_type_code": "CREDIT",
                  "tender_currency_code": "USD",
                  "amount": 1891.75,
                  "is_active": true
                },
                {
                  "tender_mapping_id": "58ff5d45555005ae42f8c7e0",
                  "tender_category_code": "SALES",
                  "tender_type_code": "CASH",
                  "tender_currency_code": "USD",
                  "amount": 10099,
                  "is_active": true
                }
              ]
            }
          ],
          "source": "PunchEditor"
        }
      }
    },
    "details_map": {
      "shared_time_punch_employee": {
        "690c90c7862f3e55518d85de": {
          "employee_role_id": null,
          "employee_id": "690c90c7862f3e55518d85de",
          "badge_number": null,
          "employee_corporate_code": "1780",
          "person_id": null,
          "primary_site_id": "604f88bfe314e100089a1b5b",
          "skip_biometrics": false
        }
      },
      "site": {
        "604f88bfe314e100089a1b5b": {
          "site_id": "604f88bfe314e100089a1b5b",
          "name": "Store NY",
          "store_identifier": "12345",
          "timezone_name": "America/Los_Angeles",
          "is_active": true
        }
      },
      "shared_time_punch_job": {
        "690c90c8862f3e55518d85e0": {
          "job_code_id": "58e63c06fbf17de5ced22064",
          "job_code_name": "Cashier",
          "external_id": "12"
        }
      },
      "adjustment_reason": {
        "58f66d447020f950c17c3e5c": {
          "punch_adjustment_reason_id": "58f66d447020f950c17c3e5c",
          "description": "Forgot to clock in",
          "is_active": true,
          "site_id": null,
          "name": "Forgot to clock in",
          "code": "FCLIN"
        }
      },
      "work_type": {
        "58f68e1f7020f950c17c3e6e": {
          "work_type_id": "58f68e1f7020f950c17c3e6e",
          "name": "WorkTime",
          "description": "WorkTime",
          "is_overtime_calculated": true,
          "is_worked": true,
          "code": "WORK",
          "is_active": true
        }
      },
      "break_time": {
        "58ff592b2804e6056e019f7d": {
          "is_paid_break": false,
          "break_type_code": "DFLT"
        }
      },
      "clock_type": {
        "58f66d457020f950c17c3e5e": {
          "punch_type_id": "58f66d457020f950c17c3e5e",
          "name": "Clock-in",
          "description": "Clock-in",
          "code": "CKIN",
          "is_clock_in": true,
          "site_id": null,
          "is_active": true
        },
        "58f66d447020f950c17c3e5d": {
          "punch_type_id": "58f66d447020f950c17c3e5d",
          "name": "Break Clock-out",
          "description": "Break Clock-out",
          "code": "BKOUT",
          "is_clock_in": false,
          "site_id": null,
          "is_active": true
        },
        "58f66d447020f950c17c3e5c": {
          "punch_type_id": "58f66d447020f950c17c3e5c",
          "name": "Break Clock-in",
          "description": "Break Clock-in",
          "code": "BKIN",
          "is_clock_in": true,
          "site_id": null,
          "is_active": true
        },
        "58f66d467020f950c17c3e5f": {
          "punch_type_id": "58f66d467020f950c17c3e5f",
          "name": "Clock-out",
          "description": "Clock-out",
          "code": "CKOUT",
          "is_clock_in": false,
          "site_id": null,
          "is_active": true
        }
      },
      "shared_portal_information": {
        "5f50df662ffd58000765526e": {
          "name": "User 1"
        }
      }
    }
  }
}

For more information, see Data Models General Structure - Time Punch.

Data Models

Data Models General Structure - Time Punch

The table below defines the objects and attributes that the Data Stream service sends as part of the Time Punches Object:

Field Name	Type	Description
`model`	object	The object that contains information about a current and previous timekeeping event with details related to the employee's rate, work time duration, and related sales and tips transactions. Structure: mobile Object
`details_map`	object	The object that contains a list of main lookups' values sent within worktimes data in the model Object. Structure: details_map Object

Field Name

Type

Description

model

object

The object that contains information about a current and previous timekeeping event with details related to the employee's rate, work time duration, and related sales and tips transactions.

Structure: mobile Object

details_map

object

The object that contains a list of main lookups' values sent within worktimes data in the model Object.

Structure: details_map Object

model Object

Field Name	Type	Description
`shift_id`	string	The unique identifier (UID) of the employee's shift
`initial_shift_id`	string/HEX24	The UID of the parent shift related to the current shift. This link exists only during automatic shift splits when crossing two business dates.
`employee_id`	string	The UID of the employee
`start_date_time`	string	The ISO timestamp of the shift actual start
`end_date_time`	string	The ISO timestamp of the shift actual end
`is_active`	boolean	Shows whether the shift was deleted or not. A value of "false" indicates this shift was deleted within the user interface (UI).
`site_id`	string	The UID of the site where the shift was added
`status`	string	The current shift's status. Describes the clock status of the employee, as of the time of the message. The available values are as follows: CLOCKED_IN CLOCKED_OUT ON_BREAK
`source`	string	Where the shift was actually initiated. The entry is automatically created using our point of sale (POS) / Kiosk or added manually in Back Office. The available values are as follows: PosTimeClock AutoClockOut PunchEditor Kiosk
`actual_update_date`	string	The ISO timestamp of the last shift update
`history`	object	The object that contains detailed information about work times created within this shift. `previous` and `current` objects have the same structure described in history below. The main difference between them is that the history object contains a record that was generated historically before current, but only one from the entire history. Structure: `history`

Sample Time Punches Object model Object

{
 "model": {
  "shift_id": "60ec6363c8fe790001d9d43c",
  "employee_id": "60c737009f6d090001062140",
  "start_date_time": "20XX-07-12T15:00:00+03:00",
  "end_date_time": "20XX-07-12T17:00:00+03:00",
  "is_active": true,
  "site_id": "60b0b81b0d2b510007c9606f",
  "status": "CLOCKED_OUT",
  "source": "PunchEditor",
  "actual_update_date": "20XX-07-12T15:48:37.632",
  "history": {
    "previous": {
      "start_date_time": "20XX-07-12T12:00:00+00:00",
      "end_date_time": "20XX-07-12T15:00:00+00:00",
      "is_active": true,
      "update_date": "20XX-07-12T15:44:39",
      "actual_update_date": "20XX-07-12T15:44:34.246Z",
      "update_user": "5f4cf90b6e2e35000781026c",
      "updater_type": "access",
      "shift_adjustment_note": null,
      "punch_adjustment_reason_id": 
        "58f66d447020f950c17c3e5c",
      "work_times": [
       {
        "employee_work_time_id": "60ec6364c8fe790001d9d43d",
        "employee_job_id": "60c73700687b3b0001daa2db",
        "business_date": "20XX-07-12",
        "clock_in": "20XX-07-12T12:00:00+00:00",
        "clock_in_type_id": "58f66d457020f950c17c3e5e",
        "clock_out": "20XX-07-12T15:00:00+00:00",
        "clock_out_type_id": "58f66d467020f950c17c3e5f",
        "break_time_id": null,
        "work_type_id": "58f68e1f7020f950c17c3e6e",
        "rate": null,
        "clock_in_approval_id": null,
        "clock_in_approval_person_id": 
          "5f4cf90b6e2e35000781026c",
        "clock_out_approval_id": null,
        "clock_out_approval_person_id": 
          "5f4cf90b6e2e35000781026c",
        "update_date": "20XX-07-12T15:44:36",
        "is_active": true,
        "transactions": [
         {
          "tender_mapping_id": "58ff5d45555005ae42f8c7e1",
          "tender_category_code": "DTIP",
          "tender_type_code": "CREDIT",
          "tender_currency_code": "USD",
           "amount": 2.5,
           "is_active": true
          },
          {
           "tender_mapping_id": "58ff5d38555005ae42f8c7df",
           "tender_category_code": "DTIP",
           "tender_type_code": "CASH",
           "tender_currency_code": "USD",
           "amount": 1,
           "is_active": true
          }
        ]
       }
     ],
   "source": "PunchEditor"
  },
  "current": {
    "start_date_time": "20XX-07-12T15:00:00+03:00",
    "end_date_time": "20XX-07-12T17:00:00+03:00",
    "is_active": true,
    "update_date": "20XX-07-12T15:48:40.2490342Z",
    "actual_update_date": "20XX-07-12T15:48:37.6325698Z",
    "update_user": "5f4cf90b6e2e35000781026c",
    "updater_type": "access",
    "shift_adjustment_note": null,
    "punch_adjustment_reason_id": 
      "58f66d447020f950c17c3e5c",
    "work_times": [
     {
      "employee_work_time_id": "60ec6364c8fe790001d9d43d",
      "employee_job_id": "60c73700687b3b0001daa2db",
      "business_date": "20XX-07-12",
       "clock_in": "2021-07-12T15:00:00+03:00",
       "clock_in_type_id": "58f66d457020f950c17c3e5e",
       "clock_out": "20XX-07-12T17:00:00+03:00",
       "clock_out_type_id": "58f66d467020f950c17c3e5f",
       "break_time_id": null,
       "work_type_id": "58f68e1f7020f950c17c3e6e",
       "rate": null,
       "clock_in_approval_id": null,
       "clock_in_approval_person_id": 
         "5f4cf90b6e2e35000781026c",
       "clock_out_approval_id": null,
       "clock_out_approval_person_id": 
         "5f4cf90b6e2e35000781026c",
       "update_date": "20XX-07-12T15:48:39.5387239Z",
       "is_active": true,
       "transactions": [
        {
         "tender_mapping_id": "58ff5d45555005ae42f8c7e1",
         "tender_category_code": "DTIP",
         "tender_type_code": "CREDIT",
         "tender_currency_code": "USD",
         "amount": 2.5,
         "is_active": true
         },
        {
          "tender_mapping_id": "58ff5d38555005ae42f8c7df",
          "tender_category_code": "DTIP",
          "tender_type_code": "CASH",
          "tender_currency_code": "USD",
          "amount": 1,
          "is_active": true
         }
      ]
     }
   ],     
   "source": "PunchEditor"
   }
  }
 }
}

history

Field Name	Type	Description
`start_date_time`	string	The ISO timestamp of the shift start
`end_date_time`	string	The ISO timestamp of the shift end
`is_active`	boolean	Shows whether the shift was deleted or not
`update_date`	string	The ISO timestamp of the shift update (in the database)
`actual_update_date`	string	The ISO timestamp of the shift actual update
`update_user`	string	The unique identifier (UID) of the person or site for the point of sale (POS) who initiated the update
`updater_type`	string	The person or site for the POS who initiated the update. The available values are as follows: site access
`shift_adjustment_note`	string	The note left automatically or manually by the user who updated the shift
`punch_adjustment_reason_id`	string	The UID of one of the adjustment reasons chosen during the shift update. This object contains information about a chosen reason for the punch creation, update, or deletion. The available values for `adjustment_reason` in the details_map object: Forgot to clock-in Clocked In Late Clocked Out Late Forgot to break in Forgot to break out Forgot to clock out Employee had to leave after clocking in Other
`work_times`	array	The array that provides details for the exact timekeeping timeframe added or updated in a particular moment. For example, clock-in, break-in, break-out, or clock-out. Structure: work_times
`source`	string	Where the punch was actually initiated. The entry is created automatically using the POS / Kiosk or added manually in Back Office.

work_times

Field Name	Type	Description
`employee_work_time_id`	string	The unique identifier (UID) of the work time within current shift
`employee_job_id`	string	The UID of the employee job with which employee has started the shift
`business_date`	string	The site's actual business date
`clock_in`	string	The ISO timestamp of the employee's clock-in action
`clock_in_type_id`	string	The type of employee clock-in. The available values for clock_type in the details_map Object are as follows: Break Clock-in Break Clock-out Clock-in End of day Clock-in End of day Clock-out Still clocked-in
`clock_out`	string	The ISO timestamp of the employee's clock-out action
`clock_out_type_id`	string	The type of employee clock-out. This could be break clock-out as well. It depends on the particular work time being processed currently. The available values for clock_type in the details_map Object are as follows: Break Clock-in Break Clock-out Clock-in End of day Clock-in End of day Clock-out Still clocked-in
`clock_out_type_id`	string	The type of employee clock-out. This could be break clock-out as well, so it depends on what work time is being processed currently.
`break_time_id`	string	The UID of the break type, which is configured using Data Management
`work_type_id`	string	The UID of the employee's work type
`rate`	string	The employee's job pay rate assigned to the job record mentioned above
`clock_in_approval_id`	string	The UID of the manager's employee record - In case the employee has no permissions to clock-in, the manager performs a clock-in operation for the employee and the manager's employee UID is sent here.
`clock_in_approval_person_id`	string	In case the approval employee has a related Portal user record, then the linked person UID is sent here (`employees.person_id`). Otherwise, this field is empty.
`clock_out_approval_id`	string	Similar to `clock_in_approval_id` - The UID of the manager who performed the employee's clock-out
`clock_out_approval_person_id`	string	The UID of the portal user linked to the manager's employee record
`update_date`	string	The ISO timestamp of the worktime update (in the database)
`is_active`	string	Shows whether this work time was deleted or not
`transactions`	array	Contains a list of tips and sales data created and received by the employee during the shift. Structure: `transactions`

transactions

Field Name	Type	Description
`tender_mapping_id`	string	The link to the Data Management "Tender Mapping" section. It identifies which kind of tips or sales were performed and received by the employee.
`tender_category_code`	string	The name of the tender category. The available values are as follows: Direct Tip (DTIP) Indirect Tip (IDTIP) Sales (SALES)
`tender_type_code`	string	The name of the payment type (all available values from the Data Management "Payment Type" section)
`tender_currency_code`	string	The currency code. It is United States dollars (USD) by default.
`amount`	decimal	The amount of the tender transaction, such as total sales amount and total tips amount.
`is_active`	boolean	Shows whether the transaction was deleted or not

details_map Object

Field Name	Type	Description
`shared_portal_information`	object	This Object contains information about the users who updated the current shift. The `name` field displays the name of the portal user who created, edited, or removed the currently sent shift. Structure: `shared_portal_information` Note This object is present in the payload only if the shift update is performed by a portal user and not by a request from the point of sale (POS) or integrator. This field is omitted if no Portal User information is found for this shift.
`shared_time_punch_employee`	object	The unique identifier (UID) of the site with which the employee is associated, such as their primary site or work location. Structure: `shared_time_punch_employee`
`shared_time_punch_job`	object	This object contains information about the employee's job related to the received shift in this message. Structure: `shared_time_punch_job`
`site`	object	This object contains detailed information about the site within which the shift and all its worktimes were created. Structure: `site`
`work_type`	object	The list of available work types that could be associated with the punch. The available values are as follows: Holiday Payroll Generated Time Sick Vacation WorkTIme Meeting Break Structure: `work_type`
`clock_type`	object	The list of available clock types that could be associated with the punch. The available values are as follows: Break Clock-in Break Clock-out Clock-in End of day Clock-in End of day Clock-out Still clocked-in Structure: `clock_type`
`adjustment_reason`	object	Contains information about a chosen reason for punch creation, update, and deletion. The available values are as follows: Forgot to clock in Clocked In Late Clocked Out Late Forgot to break in Forgot to break out Forgot to clock out Employee had to leave after clocking in Other Structure: `adjustment_reason`
`break_time`	object	This object defines information about employee break types. Available values: `MEAL` `REST` `DFLT` - Default Structure: `break_time`

Sample Time Punches Object detailed_map Object

{
    "details_map": {
        "shared_time_punch_employee": {
            "690c90c7862f3e55518d85de": {
                "employee_role_id": null,
                "employee_id": "690c90c7862f3e55518d85de",
                "badge_number": null,
                "employee_corporate_code": "1780",
                "person_id": null,
                "primary_site_id": "604f88bfe314e100089a1b5b",
                "skip_biometrics": false
            }
        },
        "site": {
            "604f88bfe314e100089a1b5b": {
                "site_id": "604f88bfe314e100089a1b5b",
                "name": "Store NY",
                "store_identifier": "12345",
                "timezone_name": "America/Los_Angeles",
                "is_active": true
            }
        },
        "shared_time_punch_job": {
            "690c90c8862f3e55518d85e0": {
                "job_code_id": "58e63c06fbf17de5ced22064",
                "job_code_name": "Cashier",
                "external_id": "12"
            }
        },
        "adjustment_reason": {
            "58f66d447020f950c17c3e5c": {
                "punch_adjustment_reason_id": "58f66d447020f950c17c3e5c",
                "description": "Forgot to clock in",
                "is_active": true,
                "site_id": null,
                "name": "Forgot to clock in",
                "code": "FCLIN"
            }
        },
        "work_type": {
            "58f68e1f7020f950c17c3e6e": {
                "work_type_id": "58f68e1f7020f950c17c3e6e",
                "name": "WorkTime",
                "description": "WorkTime",
                "is_overtime_calculated": true,
                "is_worked": true,
                "code": "WORK",
                "is_active": true
            }
        },
        "break_time": {
            "58ff592b2804e6056e019f7d": {
                "is_paid_break": false,
                "break_type_code": "DFLT"
            }
        },
        "clock_type": {
            "58f66d457020f950c17c3e5e": {
                "punch_type_id": "58f66d457020f950c17c3e5e",
                "name": "Clock-in",
                "description": "Clock-in",
                "code": "CKIN",
                "is_clock_in": true,
                "site_id": null,
                "is_active": true
            },
            "58f66d447020f950c17c3e5d": {
                "punch_type_id": "58f66d447020f950c17c3e5d",
                "name": "Break Clock-out",
                "description": "Break Clock-out",
                "code": "BKOUT",
                "is_clock_in": false,
                "site_id": null,
                "is_active": true
            },
            "58f66d447020f950c17c3e5c": {
                "punch_type_id": "58f66d447020f950c17c3e5c",
                "name": "Break Clock-in",
                "description": "Break Clock-in",
                "code": "BKIN",
                "is_clock_in": true,
                "site_id": null,
                "is_active": true
            },
            "58f66d467020f950c17c3e5f": {
                "punch_type_id": "58f66d467020f950c17c3e5f",
                "name": "Clock-out",
                "description": "Clock-out",
                "code": "CKOUT",
                "is_clock_in": false,
                "site_id": null,
                "is_active": true
            }
        },
        "shared_portal_information": {
            "5f50df662ffd58000765526e": {
                "name": "User 1"
            }
        }
    }
}

shared_portal_information

Field Name	Type	Description
`name`	string	The name of the portal user who created, updated, or deleted this shift

shared_time_punch_employee

Field Name	Type	Description
`primary_site_id`	string	The unique identifier (UID) of the site with which the employee is associated - Their primary site or work location
`person_id`	string	The UID of the Portal user associated with the employee. During the employee creation, this field is filled when a Portal user with the same email already exists. In this case, the UID of such a user is saved in this field. Used for those employees that have access to the Portal.
`employee_role_id`	string	The UID of the employee's security role
`employee_id`	string	The UID of the employee record
`employee_corporate_code`	string	The numeric UID of the employee within a company
`badge_number`	string	The employee's badge number, if applicable
`skip_biometrics`	boolean	This flag indicates whether the employee’s biometric data is required during the login on the point of sale (POS)

shared_time_punch_job

Field Name	Type	Description
`job_code_id`	string	The unique identifier (UID) of the job's code from Data Management
`job_code_name`	string	The name of the job code from Data Management
`external_id`	string	The readable identifier of the job code that can be used by third-parties

site

Field Name	Type	Description
`site_id`	string	The unique identifier (UID) of the source site
`name`	string	The full, readable name of the site
`store_identifier`	string	The site's identifier. Usually contains a numerical value or letters.
`is_active`	boolean	Shows whether the site was deleted or not
`timezone_name`	string	The readable name of the time zone associated with the site

work_type

Field Name	Type	Description
`work_type_id`	string	The unique identifier (UID) of the work type
`code`	string	The short, unique code of the work type
`description`	string	The work type description
`is_active`	boolean	Shows whether this work type was deleted or not. The current list should always contain active records.
`is_overtime_calculated`	boolean	A flag for pay calculations to include this type of work in overtime calculations
`is_worked`	boolean	A flag to demonstrate if this type of work was for actual labor
`name`	string	The work type name

clock_type

Field Name	Type	Description
`punch_type_id`	string	The unique identifier (UID) of the clock type (punch type)
`code`	string	The short, unique code of the punch type
`description`	string	The punch type description
`is_active`	boolean	Shows whether the punch type was deleted or not. The current list should always contain active records.
`is_clock_in`	boolean	Identifies whether the punch is a clock-in type
`site_id`	string	The site identifier to which the punch type is assigned
`name`	string	The punch name

adjustment_reason

Field Name	Type	Description
`punch_adjustment_reason_id`	string	The unique identifier (UID) of the chosen adjustment reason
`code`	string	The adjustment reason code
`description`	string	The adjustment reason description
`is_active`	boolean	Shows whether the adjustment reason was deleted or not. The current list should always contain active records.
`site_id`	string	The site identifier to which this adjustment reason is assigned
`name`	string	The adjustment reason name

break_time Object

Field Name	Type	Description
`is_paid_break`	boolean	The flag that indicates whether this break type is considered as a paid one
`break_type_code`	string	Identifies the break’s type code: Meal Rest Default