Skip to main content
Version: 5.3

Project Service

ProjectDto

This class contains all data of a project.

DatatypeNameDescription
GuidIdUnique ID of the project
DateTimeLastUpdateTime stamp of the last update
BoolIsPaidIndicates that the project will be paid If true, PricePerHour, Vat and Currency must be filled.
DoublePricePerHourDefines the hourly rate
DoubleVatDefines the VAT
StringCurrencyDefines the used currency. E.g. €
LongTextColorText colour of the project.
LongBackgroundColorBackground colour of the project
StringProjectNameName of the project
StringProjectDescriptionShort description of the project
BoolIsProjectDeletedTrue, if the project has been deleted
BoolIsProjectTimeLimitedTrue, if the project is limited in time. If true, StartDate and EndDate must be filled
DateTime?StartDateThe first valid booking date for the project, or NULL if the project is not time limited.
DateTime?EndDateThe last valid booking date for the project, or NULL if the project is not time limited.
List\<TaskDto>TaskListCollection of tasks that belongs to the project
BoolIsWorkingTimeRestrictedTrue, if the project has a maximum amount of working hours. If true, MaxWorkingTime must be filled
DatatypeNameDescription
DoubleMaxWorkingTimeMaximum Amount of Working Time
CustomerDtoCustomerDefault customer that is used when creating new time entries.
ProjectStateManualProjectStateCurrent project state. Calculated = 0, Green = 1, Yellow = 2, Red = 3
StringProjectStateDescriptionUser defined description of the project state
BoolDontInheritCommonTasksTrue, if the client shall not show the common tasks at the project level.
BoolIsOrderBasedTrue, if the project is based on a customer order
StringAccountProject account number
StringCostCenterCost center of the project
OrderTypeOrderTypeThe order type of the project Undefined = 0 PrivateSector = 1 PublicService = 2 SupplyOfTemporaryWorkers = 3 ServiceContract = 4 ContractToProduceAWork = 5
StringContractIdOrder nr. of the project
StringPlaceOfServiceProvisionThe place of service provision
Double?ChargingJourneyTimePercentage of driving time hat counts as working time
IntRoundPrecisionInMinutesRounding precision in minutes
RoundingRoundingType of rounding NotRounded = 0 Rounded = 1 RoundUp = 2 RoundDown = 3
DoubleYellowTrafficLightFactor where the traffic light turn to yellow
DoubleRedTrafficLightFactor where the traffic light turn to red
ProjectLifeCycleProjectLifeCycleCurrent life cycle state of the project
ProjectAvailabilityProjectAvailabilityDefines from whom the project can be accessed. AvailableForAll = 0 AvailableForSelected = 1 AvailableForNone = 2
UserProfileDtoProjectOwnerDefines the project owner
Guid?ParentProjectIdId of the parent project or NULL, if there is no parent project defined.
StringParentProjectNameRead only name of the parent project
StringParentProjectDescriptionRead only description of the parent project
StringFurtherAccountingDetailsUser specific data used to concrete the project accounting
StringProjectCodeThe barcode of a project. Used to identify a project by a barcode scanner.
BoolIsMaxWorkingTimeExceedableTrue, if the maximum working time of a project can be exceeded
BookingTypeBookingTypeThe booking type that is allowed for the project. Undefined = 0 Timed = 1 Duration = 2
Guid?DefaultTaskIdThat’s the id of the default task of a project that will be used for new time entries.
bool?IsDescriptionMandatoryA flag that indicates whether the description is mandatory. If null, the settings-default will be used.
bool?ShowAccountingDetailsA flag that indicates whether the accounting details shall be shown. If null, the settings-default will be used.

ProjectSearchDto

This class is derived from the PagingContextDto and contains a filter in order to search for projects.

DatatypeNameDescription
StringProjectNameName of the project to search
BoolInTimeFrameIf true, only projects that are active and in the bookable time frame will be returned
BoolEnrichWithTasksIf true, the projects will be loaded with included task information.
StringGenericSearchGeneric search will search for project name and description
ProjectLifeCycleProjectLifeCycleSearches only for projects that matches the defined lifecylce
Guid?ParentProjectIdIf set, returns only the projects of the given parent
BoolEnrichWithUserDefinedCustomerIf true, the projects will be enriched with customer data
GuidGroupLeaderIdId of the group leader. All projects of the dependend members will be retrieved.
BoolIncludeParentProjectsFlag that defines if parent projects shall be returned by the search, even if they are not matched by search criteria.

ProjectTaskDto : TaskDto

This class is derived from TaskDto and contains the name of the project to which the task belongs as an additional property.

DatatypeNameDescription
StringProjectName of the project to which the task belongs

ProjectTimeDto

This class is used to retrieve the time budget of a project.

DatatypeNameDescription
DateTime?DateNULL, if all project times shall be looked up. A special date if only the times up to the passed date shall be calculated.
GuidUserIdId of the TimePunch User that has been looked up.
GuidProjectIdId of the project that has been looked up.
DoubleScheduledWorkThe scheduled work for the project.
DoubleHoursWorkedThe hours the user has already been worked on the project.
DoubleAvailableWorkThe available work that can be booked by the user.

ProjectUserDto : UserProfileDto

This class contains the combination of Project and Profile information. It will be used read only to identify which profiles can book times to the distinct projects. The class is derived from the UserProfileDto.

DatatypeNameDescription
GuidIdUnique ID of TimePunch Profile
StringProjectNameName of the project
GuidProjectIdId of the project
DoubleScheduledWorkThe scheduled work for the user.
PoolTypePoolTypeThe pool type (allowed values are Shared / Private)
UserRightsUserRightsContains the permissions of the user that belongs to the project. This field is used to identify project leaders.
ProjectMember TypeMemberTypeDefines the type of the project member (e.g. Member, or Assistant)

ProjectUserRelationSaveDto : UserProfileDto

This class contains user-specific settings for a project. This class is derived from UserProfileDto.

DatatypeNameDescription
GuidProjectIdId of the project
Guid?CustomerIdId of the default customer if set, or NULL if no default customer has been set.
Double?PricePerHourPrice per hour if set, or NULL if no user specific price per hour has been set.
Double?MaxWorkingTimeMaximum working time for the user in the specified project. Or NULL, if no maximum working time for the user has been set.
Double?ChargingJourneyTimePercent of charging journey time for the user in the specified project. Or NULL, if no charging journey time has been set.
ProjectMember TypeMemberTypeDefines the type of the project member (e.g. Member, or Assistant)

ProjectUserRelationDto : ProjectUserRelationSaveDto

This method is derived from ProjectUserRelationSaveDto and contains additional information that is only returned when loading the data.

DatatypeNameDescription
StringProjectName of the project
StringCustomerRefNrReference number of the customer
StringCustomerNameName of the customer
UserRightsUserRightsThe permission of the given user.

TaskDto : AuditEntityDto

This class contains all data that describes a task. A task can be attached directly to a project, or standalone as a common task that is not bound to a project. Common Tasks can be used in combination with any project.

DatatypeNameDescription
GuidIdUnique ID of the task
StringTaskNameIdName of the task
StringTaskDescriptionDescription of the task
BoolIsDeletedTrue, if the task is deleted and cannot be used for new time entries.
TimeEntryTypeUsageDefines how the task entry will be booked when creating new time entries.
DoubleCostFactorThe cost factor defines a factor that multiplied by the hourly rate, defines the net cost.
StringTaskCodeBarcode of the task. Used to identify a task by the barcode scanner.
DoubleWorktimeFactorThe worktime factor defines which part of duration will be added to the worktime.
StringWorkTypeNoBooking account type no. that overrides the default type no. for the work
StringOtherTypeNoBooking account type no that overrides the default type no. for special times (e.g. on call service)
TimeRestrictionWorkTimeRestrictionThis field can be set to NoRestriction, TargetTime or SelfDefined
double?MaxTaskWorkingTimePerDayIf the time restriction is set to self defined, this field defines the max. working time per day that is allowed for booking.