ClockIn

Command, Introduced in version 2.26

POST https://localhost:8001/sv/001.1/api/v1/TimeRecording/RecordingDays/ClockIn

Clocks in an employee. Will also restart any clocked-out work.

Returns EntityCommandResponse

The root entity id of the response is the business key identifier of the RecordingDay that was updated. References RecordingDays

The entity id of the response is the business key identifier of the created attendance interval or zero if no interval was created (employee may not have attendance recording enabled). References AttendanceIntervals

Required permission

Record

Properties

Name	Type	Summary
EmployeeId	Int64	Employee to create recording for Mandatory
TimeStamp	DateTimeOffset?	Timestamp for the recording. If undefined the current time will be used. The timestamp is not allowed to be in the future.
Message	String	Recording message that if defined will be appended to the recording comment on the RecordingDay Max length is 1000000
AbsencePeriods	AbsencePeriod[]	Any absence periods prior to the clock-in that needs to be recorded. Usually these comes from a AttendanceRecordingTemplate and all required absences must have their AbsenceCodeId specified. Mandatory (if there are required absence periods)
OvertimeTypeId	Int64?	The business key identifier for the overtime type to record if recording overtime. References OvertimeTypes.

Example

{
  "EmployeeId": 0,
  "TimeStamp": null,
  "Message": null,
  "AbsencePeriods": null,
  "OvertimeTypeId": null
}