API Documentation

/billableTimes

A billable time is an amount of minutes belonging to an employee and a project that is put on the bill for this project. Billable times are typically created from the work times an employee has entered for that day.

Endpoints

MethodPath
GET/{id}
GET/search/findByProjectAndDateBetweenOrderByDateAsc
GET/search/findByDateBetween
GET/findEmployeeMappingByProjectAndDateBetween
POST/
PUT/{id}
DELETE/{id}

Projections

NameDescription
withProjectContains the project embedded

Structure

FieldnameFieldtypeValidations
idLong
versionInteger
dateDatenot null
minutesInteger> 0, not null
LinksSecurity
employeenot deletable, updateable by ROLE_SUPERVISOR
projectnot deletable, updateable by ROLE_SUPERVISOR

GET /{id}

Get a single billable time by its id.

Security

ROLE_SUPERVISOR

Returns

One billable time.


GET /search/findByProjectAndDateBetweenOrderByDateAsc

Find work times by their project and the date between two given dates.

Security

ROLE_SUPERVISOR

Returns

List of billable times.

Parameters

nametyperequireddescription
projectLongtrueThe id of the project
startDatetrueThe start of the interval
endDatetrueThe end of the interval

GET /search/findByDateBetween

Find all billable times between two dates.

Security

ROLE_ADMIN

Returns

List of billable times.

Parameters

nametyperequireddescription
startDatetrueThe start of the interval
endDatetrueThe end of the interval

GET /findEmployeeMappingByProjectAndDateBetween

Get all billable minutes for one project and employee in an interval summed up.

Security

ROLE_SUPERVISOR

Returns

Map of String to Integer (employee full name -> summed up minutes)

Parameters

nametyperequireddescription
projectLongtrueThe id of the project
startDatetrueThe start of the interval
endDatetrueThe end of the interval

POST /

Create a new billable time. Returns the created object.

Security

ROLE_SUPERVISOR

Returns

A single billable time.


PUT /{id}

Update the billable time identified by id. Returns the updated object.

Security

ROLE_SUPERVISOR

Returns

A billable time.


DELETE /{id}

Delete the billable time identified by id.

Security

ROLE_SUPERVISOR

Returns

Nothing