Public
Events

Normalize (correct) the clocking of an existing event. The id can be an UID or an externalId

Changed on
patch/v1/public/events/{eventId}/clocking

Request

  • Base URL
    https://api.evolia.com
  • Auth
    HTTP basic

Path parameters

eventIdstring required

Request body

dryRunboolean

When true, simulates the update without saving the clocking data. Useful to see the effect of the update on paidDurationInM and paidAmount.

startsAtstring

the start date and time of the clocking. In ISO-8601 format.

endsAtstring

the end date and time of the clocking. In ISO-8601 format.

breakPeriodInMnumber

the unpaid break duration in minutes

paidBreaksInMnumber

the paid breaks duration in minutes

extraPaidTimeInMnumber

extra paid time in minutes to add to the clocking

notestring nullable

Optional note attached to the clocking. Set to null to remove existing note, or omit to leave unchanged.

saveNoteToEmployeeProfileboolean

if true, the note is added to the employee profile

Example request

{
  "note": "This is an updated note."
}

Response

clockedBreaksstring[] required

Clocked breaks information

paidDurationInMnumber required

Paid duration in minutes

updatedByMemberIdstring

Uid of the employee who update clocking

updatedByMemberCodestring

Code of the employee who update clocking

updatedAtstring

Clocking update date and time. In ISO-8601 format.

validatedBy'MEMBER' | 'SMART_PUNCH'

The clocking can be validated by the smart punch or by an manager

validatedByMemberIdstring

Uid of the employee who validated clocking

validatedByMemberCodestring

Code of the employee who validated clocking

validatedAtstring

clocking validate date and time. In ISO-8601 format.

notestring

clocking note.

paidBreaksstring[]

This optional property contains an array of planned paid breaks. If null or undefined, the shift has no planned paid breaks.

paidAmountnumber

The amount paid calculated from the employee's hourly wage multiplied by hours worked minus the sum of all unpaid break time plus extra paid time (if specified).

lockedboolean

True if the Timesheet have been locked

lockedByMemberIdstring

Uid of the employee who locked clocking

lockedByMemberCodestring

Code of the employee who locked clocking

lockedAtstring

Clocking update date and time. In ISO-8601 format.

Changes