GET
/
timmi-project
/
api
/
projects
/
financials

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.

search
string

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).

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
time
object | null

Total time spent on all items.

spent
object | null

Total value (standard prices) of the whole time spent on all items.

progress
number

Ratio of budget spent. Equal to Spent / RevisedBudget.

Must be a multiple of 0.01
totalInvoiced
object | null

Total amount of all invoices issued on the items.

managementOutstanding
object | null

Total worth of uninvoiced time spent. Equal to Spent - TotalInvoiced.

currentOverrun
object | null

Value of the budget overrun as of today. Equal to Spent - InitialBudget.

estimatedOverrun
object | null

Value of the estimated budget overrun upon project end. Equal to Spent - RevisedBudget.

price
object | null

Total price of all items.

currentRecoveryRate
number

Ratio between the total invoiced amount and the worth of all time spent. Equal to TotalInvoiced / Spent.

Required range: x > 0Must be a multiple of 0.01
initialRecoveryRate
number

Ratio between the price and the initial budget of all items. Equal to Price / InitialBudget.

Required range: x > 0Must be a multiple of 0.01
estimatedRecoveryRate
number

Ratio between the price and the revised budget. Equal to Price / RevisedBudget.

Required range: x > 0Must be a multiple of 0.01
currentDiscount
object | null

Ratio of total discount already spent.

discountedSpent
object | null

Equal to Spent - CurrentDiscount.

spentToComplete
object | null

Equal to RevisedBudget - Spent.

timeToComplete
object | null

Equal to spentToComplete / standardPrice.

next
string | null
prev
string | null
count
integer | null
Required range: x > 0
items
object[]

Was this page helpful?

The project-financials resourceThe user-date resource