EVevolia
Public
Timesheets

Get time entries for a specific period. This endpoint uses POST to allow large values in its body parameters

post/v1/public/time-entries/get

Request

Request body

fromDatenumber required

A unix timestamp. All resulting timesheet entries will have an end date after this date.

toDatenumber required

A unix timestamp. All resulting timesheet entries will have a start date before this date.

skillNamesstring[]

If specified, use this array of skill names to only get timesheet entries linked to those skills. A skill is a position the Evolia application but the API uses the skill term

teamNamesstring[]

If specified, use this array of team names to only get timesheet entries linked to those teams.

locationNamesstring[]

If specified, use this array of location names to only get timesheet entries linked to those locations.

forMemberIdsstring[]

If specified, use this array of member UIDs or employee ids to only get timesheets linked to those members

lockedOnlyboolean

If true only locked timesheet entries are returned

validatedOnlyboolean

If true only validated timesheet entries are returned

withCancelledboolean

If true, cancelled timesheet entries will also be returned. Cancelled entries have "isCancelled" set to true

Example request

{
  "skillNames": [
    "Cook",
    "Manager"
  ],
  "teamNames": [
    "Base Workers"
  ],
  "locationNames": [
    "Main Office"
  ],
  "forMemberIds": []
}

Response

uidstring required

Unique time entry id. Same as the shift (event)

externalIdstring

Time entry externalId. Same as the shift (event).This externalId is provided when using the create or update event API.

startsAtstring required

Event Start date. In ISO-8601 format.

endsAtstring required

Event End date. In ISO-8601 format.

firstNamestring

When assigned, contains the member (employee) first name

lastNamestring

When assigned, contains the member (employee) first name

memberIdstring

When assigned, contains the member (employee) UID

memberCodestring

When assigned, contains the member (employee) code

memberEmailstring

When assigned, contains the member (employee) email

hourlyWagenumber

When assigned, contains the member hourly wage specific to the position of the entry

positionIdstring required

The entry position UID (skill)

positionstring required

The entry position name (skill)

positionCodestring required

The entry position code (skill)

locationIdstring

The entry location UID

locationstring

The entry location name

locationCodestring

The entry location code

subLocationstring

The entry sub-location code

subLocationIdstring

The entry sub-location UID

subLocationCodestring

The entry sub-location code

teamIdstring required

The entry team UID

teamstring required

The entry team name

teamCodestring required

The entry team code

isCancelledboolean

If true this entry is cancelled

isDraftboolean

If true this event is draft

notestring

The entry public note

employeeNotestring

The entry employee note

internalNotestring

The entry internal note. Only to visible to managers, supervisors and admin.

clockedInstring

Adjusted clock in time from company rules. This value is use to calculate the total worked hours. In ISO-8601 format.

clockedInOriginalstring

The actual time when employee clocked in. In ISO-8601 format.

clockedInNotestring

The note an employee may has left when clocking in.

clockedInZoneboolean required

If true, the employee has clocked in within the designated area of the work location.

clockedInStatusstring required

A text designating the status of the "in" clocking.

clockedOutstring

Adjusted clock out time from company rules. This value is use to calculate the total worked hours. In ISO-8601 format.

clockedOutOriginalstring

The actual time when employee clocked out. In ISO-8601 format.

clockedOutNotestring

The note an employee may has left when clocking out.

clockedOutZoneboolean required

If true, the employee has clocked out within the designated area of the work location.

clockedOutStatusstring required

A text designating the status of the "out" clocking.

clockingMgrNotestring

A note left by managers on the clocking of time entry.Not to be confused the event note.

unpaidBreaksnumber required

Total unpaid breaks duration in hours and decimal. Ex: a 15 minutes is 0.25

paidBreaksnumber required

Total paid breaks duration in hours and decimal. Ex: a 15 minutes is 0.25

paidAmountnumber

Paid amount

workingHoursnumber required

Worked hours with decimal. Ex 8h30 is 8.5

plannedHoursnumber required

Planned hours with decimal. Ex 8h30 is 8.5. Based on start time and end time, minus unpaid breaks, plus paidPreparationTimeInM

paidPreparationTimeInMnumber required

The paid preparation time in minutes.

lockedAtstring

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

validatedAtstring

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

Changes

No recorded changes to this operation across all 8 revisions of this API.