clockodo Logo

REST-API

The clockodo API allows you to connect clockodo to other systems. Accounting and project management applications or proprietary shell scripts are examples of useful mash-ups with clockodo.

api/lumpsumservices: Manage lump sum services

Object type „lumpSumService“

Parameter Type Description
id integer ID of the lump sum service
name string Name of the lump sum service
price float Price of the lump sum service
unit string Unit of the lump sum service
number string Lump sum service number
active boolean Is the lump sum service active?
note string Note for the lump sum service

List lump sum services

Request
GET /api/lumpsumservices
Response
{
  "lumpSumServices": 
  {
    [object of type lumpSumService],
    [object of type lumpSumService], 
    ...
  }
}

Get lump sum service

Request
GET /api/lumpsumservices/[ID]
Response
{
  "lumpSumService": [object of type lumpSumService]
}

Add lump sum services

Request
POST /api/lumpsumservices
Required parameters name, price
Optional parameters unit, number, active, note
Response
{
  "lumpSumService": [object of type lumpSumService]
}

Edit lump sum services

Request
PUT /api/lumpsumservices/[ID]
Required parameters none
Optional parameters name, price, unit, number, active, note
Response
{
  "lumpSumService": [object of type lumpSumService]
}

Deactivate lump sum services

Request
DELETE /api/lumpsumservices/[ID]
Response
{
  "lumpSumService": [object of type lumpSumService]
}