Skip to main content
Version: 5.4

TimeEntry Service

TimeEntryDto : TimeEntrySaveDto

This class contains all data of a time-entry.

DatatypeNameDescription
StringProjectNameName of the project that is used by the time entry
StringTaskNameName of the task that is used by the time entry.
DoubleWorkTimeAmount of work time in hours
DoubleDurationComplete duration of the time entry
DoubleLeaveAmount of leave in hours
DoubleSickAmount of sick time in hours
DoubleDrivingTimeAmount of driving time in hours
DoubleTakenOvertimeAmount of taken overtime in hours
LongBackgroundColorBackground colour of the project that gets tracked.
LongTextColorText colour of the project that gets tracked.
GuidUserIdId of the user dependent TimePunch Profile
StringCustomerNameName of the customer that has been set for the time entry.
StringCustomerRefNrRef.Nr. of the customer that has been set for the time entry
GuidCustomerIdUnique customer Id
BoolIsVirtualTrue, if the time entry is only a virtual entry, like weekend, missing workday etc.
DoubleDurationAsDayDuration of the time entry in relation to the workday
StringProjectDescriptionDescription of the project referenced by the time entry
StringTaskNameIdBusiness driven task id
StringTaskDescriptionDescription of the task referenced by the time entry
UserProfileDtoCreatedByInformation about the user who created the time entry.
UserProfileDtoLastUpdatedByInformation about the user who last updated the time entry.

TimeEntryCopiesDto : TimeEntrySaveDto

This class contains additional settings to save a series entry.

DatatypeNameDescription
WeekdaysWeekdaysEnumeration of weekdays on that the series shall be created

TimeEntryFilterSearchDto

This class is used to search for time entry filters.

DatatypeNameDescription
ConfidentialityConfidentialitySearches for time entry filters with the following confidentiality. Undefined = 0 (search private and public) Private = 1 Public = 2
BoolDeepLoadTrue, if the filter shall be returned with all dependencies (projects/tasks/customers)

TimeEntryRestrictedSaveDto

This class contains the relevant data in order to execute a restricted time entry modification. That means the user does not need elevated permissions.

DatatypeNameDescription
GuidIdUnique ID of the active time entry
DateTimeLastUpdateTime stamp of the last update
GuidProjectIdUnique project Id of the time entry
GuidTaskIdUnique Task Id of the time entry
StringDescriptionThe description of the time entry
GuidCustomerIdUnique customer Id
BoolIsImportantTrue, if the time entry has been marked as important. This will force the project report to show the description.
BoolIsOnSiteTrue, if the time entry has been marked as onsite.
BoolIsNotInvoicedTrue, if the current entry gets not invoiced at all.

TimeEntryResultDto

This class is returned by save operations. It contains the result of the operation, as well as the data itself.

DatatypeNameDescription
TimeEntrySaveResultResultThe result of the save operation. NotSaved = -1, Ok = 0, BreakEnforced = 1, EmptyBreakEntry = 2
List\<TimeEntryDto>TimeEntriesList that contains the stored time entries.

TimeEntrySaveDto

This class contains all base data in order to save a time-entry.

DatatypeNameDescription
GuidProjectIdUnique project Id of the time entry
GuidTaskIdUnique Task Id of the time entry
StringLogonNameDependent TimePunch Profile
DateTimeLogonTimeLogon time stamp of the time entry
DateTimeLogoffTimeLogoff time stamp of the time entry
DoubleDurationComplete duration of the time entry
StringDescriptionThe description of the time entry
BoolHasBeenPaidFlag that defines if the time entry has been marked as paid.
TimeEntryTypeUsageDefine the type of the time entry (WorkTime, DrivingTime, Leave, Sickness, TakeOvertime, BankHoliday, OfficialBankHoliday, Weekend)
DoubleBreakTimeAmount of break time in hours
GuidCustomerIdUnique customer Id
BoolIsImportantTrue, if the time entry has been marked as important. This will force the project report to show the description.
BoolIsOnSiteTrue, if the time entry has been marked as onsite.
BoolIsNotInvoicedTrue, if the time entry gets not invoiced at all.
StringLogonOriginDefines the system with that the user logged in to TimePunch
StringLogoffOriginDefines the system with that the user logged of from TimePunch
Double?LogonLatitudeGPS Latitude of the Logon
Double?LogonLongitudeGPS Longitude of the Logon
Double?LogonGeoAccuracyGPS Accuracy in meters
StringLogonGeoAddressGPS Logon Address
Double?LogoffLatitudeGPS Latitude of the Logoff
Double?LogoffLongitudeGPS Longitude of the Logoff
Double?LogoffGeoAccuracyGPS Accuracy in meters
StringLogoffGeoAddressGPS Logoff Address
DoubleCutTimeThe cutted time of the time entry
GuidSiblingIdThe id of a sibling entry used for merging time entries
StringTechnicalTagsThis field can be used by modules to mark a time entry or add additional info to the entry.
boolIsDeletedTechnical flag whether to delete the current time entry (instead of saving it)

TimeEntrySearchDto : PagingContextDto

With this class a filter can be defined in order to search time entries. This class is derived from the PagingContextDto

DatatypeNameDescription
StringReportTitleTitle of the time entry search filter
ConfidentialityConfidentialityDefines if the time entry search filter is private or public – means only accessible by the person who created it, or accessible for all users.
DateTimeLogonTimeSearch time entries starting with the given logon time
DateTimeLogoffTimeSearch time entries through the given logoff time
TimeEntry-SearchPaymentPaymentDefines the type of the entries to search (SearchAllEntries, PaidEntries, NonPaidEntries)
List\<Guid>FilteredProjectsIf null, all projects will be returned. If the collection is empty, nothing will be returned. If the collection is filled with project ids, only entries with the given project ids will be returned.
List\<Guid>FilteredTasksIf null, all tasks will be returned. If the collection is empty, nothing will be returned. If the collection is filled with task ids, only entries with the given task ids will be returned.
List\<Guid>FilteredUsersIf null or empty, the data of the current user will be returned. If the collection is filled, only entries with the given user ids will be returned.
BoolShowPublicHolidaysTrue, if public holidays shall be returned for the given time frame.
BoolShowWeekendsTrue, if the weekends shall be returned for the given time frame.
BoolShowBreaksTrue, if the break times shall be shown.
BoolShowWorkingTimeTrue, if the working times shall be shown.
List\<Guid>FilteredCustomersIf null or empty, the data of the all customers will be returned. If the collection is filled, only entries with the given customer ids will be returned.
BoolShowWeekdaysTrue, if also weekdays shall be returned.
BoolShowMissingdaysTrue, if also missing workdays shall be returned. Missing workdays are weekdays that are marked as working days. But for that working days are no time entry bookings
DateTime?FirstModificationTimeIt defines the first modification date to search for time entries. Means all time entries that are amended after the given date.
DateTime?LastModificationTimeIt defines the latest modification date to search for time entries. Means all time entries that are amended before the given date.
Bool?IsImportantNULL to search both important and unimportant time entries. True to search for important and False to search for unimportant time entries
Bool?IsOnSiteNULL to search both on site and offsite entries. True to search for onsite entries and false to search for offsite entries
Bool?IsNotInvoicedNULL to search both invoiced and not invoiced entries. True to search only not invoiced entries.
BoolEnhanceWithAuditTrailTrue, if the result shall be enhanced with information about who changed or who created the time entries.
TimeFrameFilteringTimeFrameUsed to set the logon/logoff time automatically with a constant value AllEntries = 0 UserDefined = 1 CurrentWeek = 2 CurrentMonth = 3 CurrentYear = 4 PreviousWeek = 5 PreviousMonth = 6 PreviousYear = 7 Last30Days = 8 Last3Month = 9 Last6Month = 10 Today = 11
boolMergeOvernightEntriesFlag that indicates whether overnight entries shall be merged
boolPreventDataPreviewFlag that prevents the data preview
Guid[]IsNotInGroupIdsList of group Ids where the user may not be a member of
Guid[]IsInGroupIdsList of group Ids where the user must be a member of
stringGenericSearchGeneric search within the time entries description
GuidCreatedByUnique Id of the user who created the time entry filter
ProjectLifeCycleProjectLifeCycleDefines the project life cylce that the result projects must have

TimeEntrySeriesDto

Time entry series can be created using this class. Time entry series start with a specific time, but with time of day. The concrete time is taken from the work time model by TimePunch for the given user.

DatatypeNameDescription
GuidProjectIdUnique project Id of the time entry
GuidTaskIdUnique Task Id of the time entry
StringLogonNameDependent TimePunch Profile
DateTimeLogonDateLogon date of the time entry
DateTimeLogoffDateLogoff date of the time entry
TimeOfDayLogonTimeOfDayTime of day to start the time entry Morning = 0, Midday = 1, Evening = 2
TimeOfDayLogoffTimeOfDayTime of day to end the time entry Morning = 0, Midday = 1, Evening = 2
StringDescriptionThe description of the time entry
TimeEntryTypeUsageDefine the type of the time entry (WorkTime, DrivingTime, Leave, Sickness, TakeOvertime, BankHoliday, OfficialBankHoliday, Weekend)
DoubleBreakTimeAmount of break time in hours
GuidCustomerIdUnique customer Id
WeekdaysWeekdaysDefines the Weekdays on which the entry series shall be created