GET
/
timmi-project
/
api
/
v4
/
projects
/
{id}
curl --request GET \
  --url https://{host}/timmi-project/api/v4/projects/{id} \
  --header 'Authorization: <authorization>'
{
  "id": 2,
  "name": "<string>",
  "code": "<string>",
  "client": {
    "id": 123,
    "name": "<string>",
    "code": "<string>",
    "externalCode": null
  },
  "owner": null,
  "status": "draft",
  "contractType": "nonBillable",
  "startsOn": null,
  "createdAt": "2023-11-07T05:31:56Z",
  "lastModifiedAt": "2023-11-07T05:31:56Z",
  "price": null,
  "authorizedActions": [
    "canEditAndDelete"
  ],
  "organizationId": 2,
  "description": "",
  "initialDeliveryDate": null,
  "revisedDeliveryDate": null,
  "launchedAt": null,
  "lastChargedOn": null,
  "standardRateCard": {
    "id": 2,
    "name": "<string>"
  },
  "initialTimeEstimate": null,
  "revisedTimeEstimate": null,
  "standardRate": null,
  "billRate": null,
  "initialBudget": null,
  "revisedBudget": null,
  "discount": null,
  "discountRate": null,
  "estimatedOverrun": null,
  "initialRecoveryRate": null,
  "estimatedRecoveryRate": null,
  "totalInvoiced": null,
  "risks": [
    {
      "type": "budgetOverRun",
      "label": "<string>"
    }
  ],
  "anomalies": [
    {
      "type": "noServices",
      "label": "<string>"
    }
  ],
  "invoicingWarnings": [
    {
      "type": "unapprovedItems",
      "applicableFrom": "2021-07-22",
      "preventsInvoicing": true,
      "label": "<string>"
    }
  ]
}

Headers

​
Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Path Parameters

​
id
integer
required

Unique identifier of the project.

Response

200
application/json
OK

Definitions

Projects are the main resources in Timmi Project.

They belong to a single Client and Organization. Internal (non-billable) projects may be attached to a client that represents your own company.

Any billable project, whether fixed price or time and materials, must have a owner, start and end dates, and a contract:

  • A fixed price project must have prices set on its services.
  • A time and materials project must have bill rates set on its services.

A Project is only available for time submission while on the "ongoing" status. Whenever a project is marked as complete or abandonned, all its services' estimates are adjusted to the actual spent value.

A project must be valid (ie all required fields must be set) before its status can be set to "ongoing".

Once ongoing, a project cannot go back to the "draft" status and can no longer be deleted. It may only be abandonned or complete.

Fields