List financials by project
Retrieve all financial metrics on projects.
Response contains the sum of all included projects (paginated). The items
node contains the financial metrics for each project.
Headers
API key. Value must be formatted like so: lucca application={api_key}
.
Query Parameters
Only return projects in given organization (by id).
Only return projects with given contract type.
Only return projects with given status.
Identifier of the project lead.
Only return projects with anomalies (any).
Only return late projects (risk).
Only return overrun projects (risk)
Only return highly discounted projects (risk).
Start date.
End date.
Identifier of the project.
Find a project based on its name or code.
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).
"2022-01-01,2022-01-31"
"2022-01-01,2022-12-31"
List the identifiers of departments the project owner must belong to.
Page number
x >= 1
Page size
Return total items count (across all pages).
count
Sort results by property
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
The response is of type object
.