abstract swish line in gradient colouring from pink to blue on a dark blue background

Event stream documentation

Time Event Stream - field definitions

 

Field definitions for events
Field NameData TypeAdditional information
PersonalReferenceNumberstringThe reference number of the person to whom the time-pair belongs. Max-length: 20
PersonFirstnamestringThe first name of the person to whom the time-pair belongs. Max-length: 80
PersonLastnamestringThe last name of the person to whom the time-pair belongs. Max-length: 80
TimePairTypestringStandard or Overtime
StartTimedatetimeThe start date of the Time-pair. The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
StartTimeZonestringThe starting Time Zone of the Time-pair. The Time Zone is in IANA format i.e. continent or ocean followed by the name of the largest city within the region e.g. Pacific/Honolulu.
StartLongitudedecimalThe starting Geolocation Longitude of the Time-pair. The value is in decimal degrees format and ranges from -180 to 180. For example, Washington DC has a longitude -77.0364.
StartLatitudedecimalThe starting Geolocation Latitude of the Time-pair. The value is in decimal degrees format and ranges from -90 to 90. For example, Washington DC has a latitude 38.8951.
StartAccuracydecimalThe starting Geolocation Accuracy of the Time-pair. The value is in decimal format and represents the radius of a circle around the longitude and latitude co-ordinates. The location of the clock-in could be anywhere within that circle.
StartTimeEntryTypestringThe starting Time Entry Type of the Time-pair. The value can only be Automatic or Manual. Automatic implies entered by clicking on a button or some other automatic process, whereas Manual means the time-pair was entered by manually editing values.
EndTimedatetimethe end date of the Time-Pair. The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
EndTimeZonestringThe end Time Zone of the Time-pair. The Time Zone is in IANA format i.e. continent or ocean followed by the name of the largest city within the region e.g. Pacific/Honolulu.
EndLongitudedecimalThe end Geolocation Longitude of the Time-pair. The value is in decimal degrees format and ranges from -180 to 180. For example, Washington DC has a longitude -77.0364.
EndLatitudedecimalThe end Geolocation Latitude of the Time-pair. The value is in decimal degrees format and ranges from -90 to 90. For example, Washington DC has a latitude 38.8951.
EndAccuracydecimalThe end Geolocation Accuracy of the Time-pair. The value is in decimal format and represents the radius of a circle around the longitude and latitude co-ordinates. The location of the clock-in could be anywhere within that circle.
EndTimeEntryTypestringThe end Time Entry Type of the Time-pair. The value can only be Automatic or Manual. Automatic implies entered by clicking on a button or some other automatic process, whereas Manual means the time-pair was entered by manually editing values.
DurationintegerThe difference in seconds between the time-pair's StartTime and the EndTime. Will always be a positive non-zero whole number.
PreviousDurationintegerThe previous difference in seconds between the time-pair's StartTime and the EndTime. Will always be a positive non-zero whole number. Only applies to time-pairs which have been modified.
BreakDurationInMinutesintegerDuration in minutes of an unpaid break taken during the time-pair. Can be a positive whole number, zero, or null if not set.
PreviousBreadDurationInMinutesintegerThe previous duration of a break in minutes. Can be a positive whole number, zero, or null if not set. Only applies to time-pairs which have been modified.
PreviousStartTimedatetimeThe previous start date of the Time-pair. The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
PreviousStartTimeZonestringThe previous starting Time Zone of the Time-pair. The Time Zone is in IANA format i.e. continent or ocean followed by the name of the largest city within the region e.g. Pacific/Honolulu.
PreviousEndTimedatetimeThe previous end date of the Time-pair. The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
PreviousEndTimeZonestringThe previous end Time Zone of the Time-pair. The Time Zone is in IANA format i.e. continent or ocean followed by the name of the largest city within the region e.g. Pacific/Honolulu.
CurrentApprovalStatusstringThe current approval status of the Time-pair. Values are AwaitingApproval, Approved, Rejected, or Deleted.
PreviousApprovalStatusstringThe previous approval status of the Time-pair. Values are null, AwaitingApproval, Approved, Rejected, or Deleted.
WorkingFromHomebooleanWill be true if the time-pair represent time spent working at home, or at some other location away from the normal place of work. False otherwise.
PreviousWorkingFromHomebooleanWill be true if the time-pair represent time spent working at home, or at some other location away from the normal place of work. False otherwise.
OvertimeReasonstringWhen the time-pair is for overtime, then this is the reason e.g. 'Not Provided' Max-length: 40.
OvertimeReasonDetailsstringRepresents additional information for why the overtime was worked, e.g. "Behind schedule". Max-length: 40.
PreviousOvertimeReasonstringWhen the time-pair is for overtime, then this is the previous reason e.g. 'Not Provided'. Max-length: 40.
PreviousOvertimeReasonDetailsstringRepresents the previous additional information for why the overtime was worked, e.g. "Behind schedule". Max-length: 40.
TimeOffInLieubooleanWill be true if the time-pair is associated with Time Off In Lieu. False otherwise.
PreviousTimeOffInLieubooleanWill be true if the time-pair is associated with Time Off In Lieu. False otherwise.
TimeTypestringTime type associated with time-pair. Max-length: 255.
TimeCategorystringStandard, Overtime or Special.
PayslipItemCodestringPayslip item code associated with time-pair, can be used in payroll to pay employees. Max-length: 255.
RateOfPaydecimalRate of pay's value overriden by manager.
CurrencyIsoCodestringCurrency which is associated to provided rate of pay. Currency is in ISO format i.e. GBP.
WorkTypestringWork type field value describes the activity that was undertaken during the work period. Max-length: 255.
ExternalLocationstringExternal location field value describes relevant external location where employees worked during their shift. Max-length: 255.
WorkReferencestringField contains relevant work reference for the work they have done during their shift. Max-length: 255.
CustomerstringCustomer field value describes relevant customer or project, which employee was working on. Max-length: 255.

 

OpenTimePairCreated event

The payload for this event contains the Time-pair details.

An OpenTimePairCreated event will be raised when:

  • a person clocks-in
  • an open time-pair is manually created

An OpenTimePairCreated event will only ever contain start time details - the end time details will be null.


Example of this event

{
  "EventData": {
    "PersonalReferenceNumber": "P100",
    "PersonFirstname": "Mark",
    "PersonLastname": "Hemingway",
    "TimePairType": "Standard",
    "StartTime": "2022-05-25T12:48:00Z",
    "StartTimeZone": "Europe/London",
    "StartLongitude": -1.1423692,
    "StartLatitude": 52.8842841,
    "StartAccuracy": 14.188,
    "StartTimeEntryType": "Automatic",
    "EndTime": null,
    "EndTimeZone": null,
    "EndLongitude": null,
    "EndLatitude": null,
    "EndAccuracy": null,
    "EndTimeEntryType": null,
    "Duration": null,
    "PreviousDuration": null,
    "BreakDurationInMinutes": 5,
    "PreviousBreakDurationInMinutes": null,
    "PreviousStartTime": null,
    "PreviousStartTimeZone": null,
    "PreviousEndTime": null,
    "PreviousEndTimeZone": null,
    "CurrentApprovalStatus": "AwaitingApproval",
    "PreviousApprovalStatus": "",
    "WorkingFromHome": false,
    "PreviousWorkingFromHome": null,
    "OvertimeReason": null,
    "OvertimeReasonDetails": "",
    "PreviousOvertimeReason": null,
    "PreviousOvertimeReasonDetails": null,
    "TimeType": "Normal hours",
    "TimeCategory": "Standard",
    "PayslipItemCode": "PI0021",
    "RateOfPay": 15.21,
    "CurrencyIsoCode": "GBP",
    "WorkType": "Engineering",
    "ExternalLocation": "",
    "WorkReference": "38959p8ncr498bv",
    "Customer": "Project One"
  },
  "EventType": "OpenTimePairCreated",
  "TimeOfCreation": "2022-05-25T12:48:40.0660308Z"
}

ClosedTimePairCreated event

The payload for this event contains the Time-pair details.

A ClosedTimePairCreated event will be raised when:

  • a closed time-pair is manually created

A ClosedTimePairCreated event will always contain both the start time details and the end time details.


Example of this event

{
  "EventData": {
    "PersonalReferenceNumber": "P100",
    "PersonFirstname": "Mark",
    "PersonLastname": "Hemingway",
    "TimePairType": "Standard",
    "StartTime": "2022-05-25T12:48:00Z",
    "StartTimeZone": "Europe/London",
    "StartLongitude": -1.1423692,
    "StartLatitude": 52.8842841,
    "StartAccuracy": 14.188,
    "StartTimeEntryType": "Automatic",
    "EndTime": "2022-05-25T13:57:00Z",
    "EndTimeZone": "Europe/London",
    "EndLongitude": -1.1423693,
    "EndLatitude": 52.8842857,,
    "EndAccuracy": 14.301,
    "EndTimeEntryType": "Automatic",
    "Duration": 5632,
    "BreakDurationInMinutes": 5,
    "PreviousBreakDurationInMinutes": null,
    "PreviousDuration": null,
    "PreviousStartTime": null,
    "PreviousStartTimeZone": null,
    "PreviousEndTime": null,
    "PreviousEndTimeZone": null,
    "CurrentApprovalStatus": "AwaitingApproval",
    "PreviousApprovalStatus": "",
    "WorkingFromHome": false,
    "PreviousWorkingFromHome": null,
    "OvertimeReason": null,
    "OvertimeReasonDetails": "",
    "PreviousOvertimeReason": null,
    "PreviousOvertimeReasonDetails": null,
    "TimeType": "Normal hours",
    "TimeCategory": "Standard",
    "PayslipItemCode": "PI0021",
    "RateOfPay": 15.21,
    "CurrencyIsoCode": "GBP",
    "WorkType": "Engineering",
    "ExternalLocation": "",
    "WorkReference": "38959p8ncr498bv",
    "Customer": "Project One"
  },
  "EventType": "ClosedTimePairCreated",
  "TimeOfCreation": "2022-05-25T12:48:40.0660308Z"
}

TimePairApproved event

The payload for this event contains the details of the approved Time-pair.

A TimePairApproved event will be raised when:

  • a closed standard or overtime time-pair is manually approved
  • a closed standard time-pair is auto-approved when the system is configured appropriately

A TimePairApproved event will always contain both the start time details and the end time details, as well as the current & previous approval states.


Example of this event

{
  "EventData": {
    "PersonalReferenceNumber": "P100",
    "PersonFirstname": "Mark",
    "PersonLastname": "Hemingway",
    "TimePairType": "Standard",
    "StartTime": "2022-05-25T12:48:00Z",
    "StartTimeZone": "Europe/London",
    "StartLongitude": -1.1423692,
    "StartLatitude": 52.8842841,
    "StartAccuracy": 14.188,
    "StartTimeEntryType": "Automatic",
    "EndTime": "2022-05-25T13:57:00Z",
    "EndTimeZone": "Europe/London",
    "EndLongitude": -1.1423693,
    "EndLatitude": 52.8842857,,
    "EndAccuracy": 14.301,
    "EndTimeEntryType": "Automatic",
    "Duration": 3552,
    "PreviousDuration": null,
    "BreakDurationInMinutes": 5,
    "PreviousBreakDurationInMinutes": null,
    "PreviousStartTime": null,
    "PreviousStartTimeZone": null,
    "PreviousEndTime": null,
    "PreviousEndTimeZone": null,
    "CurrentApprovalStatus": "Approved",
    "PreviousApprovalStatus": "AwaitingApproval",
    "WorkingFromHome": false,
    "PreviousWorkingFromHome": null,
    "OvertimeReason": null,
    "OvertimeReasonDetails": "",
    "PreviousOvertimeReason": null,
    "PreviousOvertimeReasonDetails": null,
    "TimeType": "Normal hours",
    "TimeCategory": "Standard",
    "PayslipItemCode": "PI0021",
    "RateOfPay": 15.21,
    "CurrencyIsoCode": "GBP",
    "WorkType": "Engineering",
    "ExternalLocation": "",
    "WorkReference": "38959p8ncr498bv",
    "Customer": "Project One"
  },
  "EventType": "TimePairApproved",
  "TimeOfCreation": "2022-05-25T12:48:40.0660308Z"
}

TimePairRejected event

The payload for this event contains the details of the rejected Time-pair.

A TimePairApproved event will be raised when:

  • a closed time-pair is manually rejected

A TimePairRejected event will always contain both the start time details and the end time details, as well as the current & previous approval states.


Example of this event

{
  "EventData": {
    "PersonalReferenceNumber": "P100",
    "PersonFirstname": "Mark",
    "PersonLastname": "Hemingway",
    "TimePairType": "Standard",
    "StartTime": "2022-05-25T12:48:00Z",
    "StartTimeZone": "Europe/London",
    "StartLongitude": -1.1423692,
    "StartLatitude": 52.8842841,
    "StartAccuracy": 14.188,
    "StartTimeEntryType": "Automatic",
    "EndTime": "2022-05-25T13:57:00Z",
    "EndTimeZone": "Europe/London",
    "EndLongitude": -1.1423693,
    "EndLatitude": 52.8842857,,
    "EndAccuracy": 14.301,
    "EndTimeEntryType": "Automatic",
    "Duration": 1342,
    "PreviousDuration": null,
    "BreakDurationInMinutes": 5,
    "PreviousBreakDurationInMinutes": null,
    "PreviousStartTime": null,
    "PreviousStartTimeZone": null,
    "PreviousEndTime": null,
    "PreviousEndTimeZone": null,
    "CurrentApprovalStatus": "Rejected",
    "PreviousApprovalStatus": "AwaitingApproval",
    "WorkingFromHome": false,
    "PreviousWorkingFromHome": null,
    "OvertimeReason": null,
    "OvertimeReasonDetails": "",
    "PreviousOvertimeReason": null,
    "PreviousOvertimeReasonDetails": null,
    "TimeType": "Normal hours",
    "TimeCategory": "Standard",
    "PayslipItemCode": "PI0021",
    "RateOfPay": 15.21,
    "CurrencyIsoCode": "GBP",
    "WorkType": "Engineering",
    "ExternalLocation": "",
    "WorkReference": "38959p8ncr498bv",
    "Customer": "Project One"
  },
  "EventType": "TimePairRejected",
  "TimeOfCreation": "2022-05-25T12:48:40.0660308Z"
}

TimePairChanged event

The payload for this event contains the details of the changed Time-pair, and details of the previous values.

A TimePairChanged event will be raised when:

  • an open or closed time-pair is manually edited.
  • an open time-pair is clocked-out.

A TimePairChanged event will always contain the start time details, but will only contain the end time details if it is a closed time-pair.


Example of this event

{
  "EventData": {
    "PersonalReferenceNumber": "P100",
    "PersonFirstname": "Mark",
    "PersonLastname": "Hemingway",
    "TimePairType": "Standard",
    "StartTime": "2022-05-25T12:41:00Z",
    "StartTimeZone": "Europe/London",
    "StartLongitude": -1.14239,
    "StartLatitude": 52.884293,
    "StartAccuracy": 17.13,
    "StartTimeEntryType": "Automatic",
    "EndTime": "2022-05-25T12:41:00Z",
    "EndTimeZone": "Europe/London",
    "EndLongitude": -1.1423902,
    "EndLatitude": 52.8842929,
    "EndAccuracy": 17.127,
    "EndTimeEntryType": "Automatic",
    "Duration": 0,
    "PreviousDuration": null,
    "BreakDurationInMinutes": 5,
    "PreviousBreakDurationInMinutes": null,
    "PreviousStartTime": "2022-05-25T12:41:00Z",
    "PreviousStartTimeZone": "Europe/London",
    "PreviousEndTime": "",
    "PreviousEndTimeZone": null,
    "CurrentApprovalStatus": "AwaitingApproval",
    "PreviousApprovalStatus": "",
    "WorkingFromHome": false,
    "PreviousWorkingFromHome": false,
    "OvertimeReason": null,
    "OvertimeReasonDetails": "",
    "PreviousOvertimeReason": null,
    "PreviousOvertimeReasonDetails": "",
    "TimeType": "Normal hours",
    "TimeCategory": "Standard",
    "PayslipItemCode": "PI0021",
    "RateOfPay": 15.21,
    "CurrencyIsoCode": "GBP",
    "WorkType": "Engineering",
    "ExternalLocation": "",
    "WorkReference": "38959p8ncr498bv",
    "Customer": "Project One"
  },
  "EventType": "TimePairChanged",
  "TimeOfCreation": "2022-05-25T12:41:46.6038592Z"
}

TimePairDeleted event

The payload for this event contains the details of the deleted Time-pair.

A TimePairDeleted event will be raised when:

  • an open or closed time-pair is manually deleted.

A TimePairDeleted event will always contain the start time details, but will only contain the end time details if it is a closed time-pair.


Example of this event

{
  "EventData": {
    "PersonalReferenceNumber": "P100",
    "PersonFirstname": "Mark",
    "PersonLastname": "Hemingway",
    "TimePairType": "Standard",
    "StartTime": "2022-05-25T12:48:00Z",
    "StartTimeZone": "Europe/London",
    "StartLongitude": -1.1423692,
    "StartLatitude": 52.8842841,
    "StartAccuracy": 14.188,
    "StartTimeEntryType": "Automatic",
    "EndTime": null,
    "EndTimeZone": null,
    "EndLongitude": null,
    "EndLatitude": null,
    "EndAccuracy": null,
    "EndTimeEntryType": null,
    "Duration": null,
    "PreviousDuration": null,
    "BreakDurationInMinutes": 5,
    "PreviousBreakDurationInMinutes": null,
    "PreviousStartTime": null,
    "PreviousStartTimeZone": null,
    "PreviousEndTime": null,
    "PreviousEndTimeZone": null,
    "CurrentApprovalStatus": "Deleted",
    "PreviousApprovalStatus": "AwaitingApproval",
    "WorkingFromHome": false,
    "PreviousWorkingFromHome": null,
    "OvertimeReason": null,
    "OvertimeReasonDetails": "",
    "PreviousOvertimeReason": null,
    "PreviousOvertimeReasonDetails": null,
    "TimeType": "Normal hours",
    "TimeCategory": "Standard",
    "PayslipItemCode": "PI0021",
    "RateOfPay": 15.21,
    "CurrencyIsoCode": "GBP",
    "WorkType": "Engineering",
    "ExternalLocation": "",
    "WorkReference": "38959p8ncr498bv",
    "Customer": "Project One"
  },
  "EventType": "TimePairDeleted",
  "TimeOfCreation": "2022-05-25T12:48:40.0660308Z"
}

Looking for something specific?