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/projects: Manage projects


Object type „project“

Parameter Type Description
id integer ID of the project
customers_id integer ID of the corresponding customer
name string Name of the project
number string Project number
active boolean Is the project active?
billable_default boolean Is the project billable by default? (1 or 0)
note string Note for the project
budget_money float Budget for the project
budget_is_hours boolean Is the budget based on hours?
budget_is_not_strict boolean Is the budget not strict?
completed boolean Ist the project completed?
billed_money float Billed amount of money
billed_completely boolean Is the project billed completely?
revenue_factor float Factor with which revenues and hourly rates have to multiplicated in order to get the effective values In case of a project which has a hard budget and has been completed with a budget usage of 400%, the factor is "0.25".
"0" if a project with hard budget hasn't been completed yet.
"1" for projects without or with soft budget.

List projects

Please use /api/customers. There, customers an projects will be listet nested.


Get project

Request
GET /api/projects/[ID]
Response
{
  "project": [object of type project]
}

Add projects

Request
POST /api/projects
Required parameters name, customers_id
Optional parameters number, active, billable_default, budget_money, budget_is_hours, budget_is_not_strict, note
Response
{
  "project": [object of type project]
}

Edit projects

Request
PUT /api/projects/[ID]
Required parameters none
Optional parameters name, number, active, billable_default, budget_money, budget_is_hours, budget_ist_not_strict, note, hourly_rate, customers_id, completed, billed_money, billed_completely
Response
{
  "project": [object of type project]
}

Deactivate projects

Request
DELETE /api/projects/[ID]
Response
{
  "project": [object of type project]
}