GET
/
timmi-project
/
api
/
projects
/
financials
curl --request GET \
  --url https://{host}/timmi-project/api/projects/financials \
  --header 'Authorization: <authorization>'
{
  "time": null,
  "spent": null,
  "progress": 123,
  "totalInvoiced": null,
  "managementOutstanding": null,
  "currentOverrun": null,
  "estimatedOverrun": null,
  "price": null,
  "currentRecoveryRate": 1,
  "initialRecoveryRate": 1,
  "estimatedRecoveryRate": 1,
  "currentDiscount": null,
  "discountedSpent": null,
  "spentToComplete": null,
  "timeToComplete": null,
  "next": "<string>",
  "prev": "<string>",
  "count": 1,
  "items": [
    {
      "project": {
        "id": 2,
        "code": "<string>",
        "name": "<string>",
        "client": {
          "id": 2,
          "code": "<string>",
          "name": "<string>",
          "externalCode": "<string>"
        },
        "owner": {
          "id": 123,
          "firstName": "<string>",
          "lastName": "<string>",
          "dtContractEnd": "<any>",
          "picture": {
            "href": "<string>"
          },
          "establishmentId": 123
        },
        "status": "draft",
        "contractType": "nonBillable",
        "initialDeliveryDate": "2023-12-25",
        "revisedDeliveryDate": "2023-12-25",
        "billRate": null,
        "initialTimeEstimate": null,
        "revisedTimeEstimate": null,
        "anomalies": [
          {}
        ],
        "risks": [
          {
            "type": "<string>",
            "label": "<string>"
          }
        ],
        "invoicingWarnings": [
          {}
        ],
        "initialBudget": {
          "amount": 123,
          "currencyId": "<string>"
        },
        "revisedBudget": {
          "amount": 123,
          "currencyId": "<string>"
        },
        "price": {
          "amount": 123,
          "currencyId": "<string>"
        },
        "invoiceMilestonesTotal": "<any>",
        "discount": null,
        "startsOn": "<string>"
      },
      "time": null,
      "spent": null,
      "progress": 123,
      "totalInvoiced": null,
      "managementOutstanding": null,
      "currentOverrun": null,
      "estimatedOverrun": null,
      "price": null,
      "currentRecoveryRate": 1,
      "initialRecoveryRate": 1,
      "estimatedRecoveryRate": 1,
      "currentDiscount": null,
      "discountedSpent": null,
      "spentToComplete": null,
      "timeToComplete": null
    }
  ]
}

Headers

Authorization
string
required

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

Query Parameters

organizationId
integer
required

Only return projects in given organization (by id).

projectContractType
any[]

Only return projects with given contract type.

projectStatus
any[]

Only return projects with given status.

projectOwnerId
integer

Identifier of the project lead.

hasProjectAnomaly
boolean

Only return projects with anomalies (any).

isProjectDelayedDelivery
boolean

Only return late projects (risk).

isProjectBudgetOverrun
integer

Only return overrun projects (risk)

isProjectHighlyDiscounted
boolean

Only return highly discounted projects (risk).

from
string

Start date.

till
string

End date.

projectId
integer[]

Identifier of the project.

Find a project based on its name or code.

projectIntersectsPeriod
string[]

Only return projects with [startsOn, revisedDeliveryDate] dates intersecting given period ?projectIntersectsPeriod={start},{end}. In other words, projects that spread partially or completely over passed period. Projects with no dates startsOn: null, revisedDeliveryDate: null will always be returned (these may only be non-billable projects).

Examples:

"2022-01-01,2022-01-31"

"2022-01-01,2022-12-31"

projectOwnerDepartmentId
integer[]

List the identifiers of departments the project owner must belong to.

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:10

Page size

fields.root
enum<string>

Return total items count (across all pages).

Available options:
count
sort
enum<string>

Sort results by property

Available options:
project.id,
-project.id,
project.name,
-project.name,
project.owner.lastName,
-project.owner.lastName,
project.price,
-project.price,
project.billRate,
-project.billRate,
discountedSpent,
-discountedSpent,
totalInvoiced,
-totalInvoiced,
managementOutstanding,
-managementOutstanding,
estimatedOverrun,
-estimatedOverrun,
estimatedRecoveryRate,
-estimatedRecoveryRate

Response

200
application/json
OK

The response is of type object.