Introduction

Files

Organization Structure API

Axis-sections
Departments
Legal-Units
Establishments

Core HR API

Employees Directory
Guides

Cleemy Expenses API

Expense-temp-items
Expense-claims
Expense-claim-items

Timmi Absences API

Leaves
Leave-requests
Sick-leaves
Imports
Guides

Timmi Office API

User-locations
Work-locations

Timmi Project API

Timmi Settings API

UserDates
Workcycle-exceptions
Working-time-arrangement

Timmi Timesheet API

Time-entries
Timesheets
Reports
Guides

Pagga Mealvouchers API

Statutory
Computation

Pagga Remuneration API

Fixed-natures
Fixed-items
Variable-natures
Variable-items

Poplee Training API

Training-demands
Realized-trainings

Projects

List Projects

List projects from an organization. Only returns a subset of a Project fields.

Search

The search query parameter takes a list of words and enables you to only return projects whose code or name (or those of their clients) contains all those words.

GET /api/v4/projects?organizationId=1&search=pro,avat&fields.root=count HTP/1.1

{
  "count": 2,
  "items": [
    {
      "id": 1,
      "name": "Project",
      "code": "Avatar",
      "client": {
        "name": "James Cameron",
        "code": "CAMERON"
      }
    },
    {
      "id": 2,
      "name": "Avatar Project",
      "code": "Awesomeness",
      "client": {
        "name": "Advent",
        "code": "ADVENT"
      }
  ],
  {
    "id": 3,
    "name": "Test",
    "code": "Test",
    "client": {
      "name": "Avatar",
      "code": "project"
    }
  }
}

GET

timmi-project

api

projects

curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/timmi-project/api/v4/projects

{
  "next": "<string>",
  "prev": "<string>",
  "count": 1,
  "items": [
    {
      "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>"
        }
      ]
    }
  ]
}

Query Parameters

organizationId

integer

required

Filter on a single organization unique identifier.

string[]

Comma-separated list of codes / names to search for

limit

integer

default:10

Page size

page

integer

default:1

Page number

Required range: x >= 1

fields.root

enum<string>

Return total items count (across all pages).

Available options:

count

code

string

Only returns projects whose code is strictly equal to sent value

Response

200

application/json

string | null

count

integer | null

Required range: x >= 0

items

object[]

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

items.name

string

required

Maximum length: 255

items.id

integer

Required range: x >= 1

items.code

string | null

Defaults to an automatically generated value.

Maximum length: 255

items.client

object

items.owner

object | null

The user assigned as this project lead. Set through the ownerId field.

items.status

enum<string>

default:draft

Project is only available for time submission when having a "ongoing" status. Status can be updated through the "status-updates" API.

Available options:

draft,

ongoing,

completed,

cancelled,

suspended,

archived

items.contractType

enum<string>

default:nonBillable

Describes project contract types:

Non-billable (internal): no revenue recognized, budget estimates are optional.
Fixed price: progress-based revenue recognition, budget estimates are mandatory.
Time and Materials: time-based revenue recognition, initial estimates are indicative.
Not-to-exceed Time and Materials: time-based revenue recognition with a maximum value, initial estimate sets the maximum value.

Available options:

nonBillable,

fixedPrice,

timeAndMaterials,

cappedTimeAndMaterials

items.startsOn

string | null

Start of the project execution.

items.createdAt

string

Timestamp of the project creation.

items.lastModifiedAt

string

Timestamp of the last update to the project.

items.price

object | null

Price of the project. Equal to the sum of this project's services prices.

items.authorizedActions

enum<string>[]

Actions the current user can do on the project.

Available options:

canEditAndDelete,

canUpdateStatus

items.organizationId

integer

Identifier of the organization this project belongs to. Inherited from the client.

Required range: x >= 1

items.description

string | null

default:

Optional markdown formatted description.

items.initialDeliveryDate

string | null

Initially planned delivery date.

items.revisedDeliveryDate

string | null

Updated planned (or actual) delivery date.

items.launchedAt

string | null

Timestamp of the project launch.

items.lastChargedOn

string | null

Timestamp of the last time or expense allocated on the project.

items.standardRateCard

object

Standard rate card version applicable for this project. Used for profit analysis.

items.initialTimeEstimate

object | null

Initial estimate of the work duration needed to complete the project.

Example:

{
  "value": 128,
  "iso": "P5DT8H",
  "unit": "hour"
}

items.revisedTimeEstimate

object | null

Updated estimate of the work duration needed to complete the project. Can be modified through creating a new EstimateToComplete.

Example:

{
  "value": 128,
  "iso": "P5DT8H",
  "unit": "hour"
}

items.standardRate

object | null

Standard daily/hourly rate this project should be invoiced at. Equal to (price + discount) / initialTimeEstimate.

items.billRate

object | null

Actual daily/hourly rate this project will be invoiced at. Equal to price / initialTimeEstimate.

items.initialBudget

object | null

Sum of this project's services initial budgets.

items.revisedBudget

object | null

Sum of this project's services revised budgets.

items.discount

object | null

Sum of this project's services discounts.

items.discountRate

number | null

Must be a multiple of 0.1

items.estimatedOverrun

object | null

Difference between this project's initial budget and its revised budget. Represents the planned overrun upon completion.

items.initialRecoveryRate

number | null

items.estimatedRecoveryRate

number | null

items.totalInvoiced

object | null

Sum of all invoices issued for this project.

items.risks

object[]

List of risks this project is exposed to.

items.anomalies

object[]

List of anomalies this project is exposed to.

items.invoicingWarnings

object[]

Was this page helpful?

The project resource Create a new Project

curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/timmi-project/api/v4/projects

{
  "next": "<string>",
  "prev": "<string>",
  "count": 1,
  "items": [
    {
      "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>"
        }
      ]
    }
  ]
}