List financials by project

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<date>

Start date.

till

string<date>

End date.

projectId

integer[]

Identifier of the project.

string

Find a project based on its name or code.

projectIntersectsPeriod

string<date>[]

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

Required array length: 2 elements

projectOwnerDepartmentId

integer[]

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

Minimum array length: 1

Required range: x >= 0

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

time

Duration · object

Total time spent on all items.

Show child attributes

time.value

number<float>

Decimal value

Must be a multiple of 0.001

time.iso

string<duration>

ISO-8601 formatted string

time.unit

enum<string>

Duration unit: days or hours.

Available options:

day,

hour

Example:

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

spent

Price · object

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

Show child attributes

spent.amount

number

spent.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

progress

number

Ratio of budget spent. Equal to Spent / RevisedBudget.

Must be a multiple of 0.01

totalInvoiced

Price · object

Total amount of all invoices issued on the items.

Show child attributes

totalInvoiced.amount

number

totalInvoiced.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

managementOutstanding

Price · object

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

Show child attributes

managementOutstanding.amount

number

managementOutstanding.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

currentOverrun

Price · object

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

Show child attributes

currentOverrun.amount

number

currentOverrun.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

estimatedOverrun

Price · object

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

Show child attributes

estimatedOverrun.amount

number

estimatedOverrun.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

price

Price · object

Total price of all items.

Show child attributes

price.amount

number

price.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

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

Price · object

Ratio of total discount already spent.

Show child attributes

currentDiscount.amount

number

currentDiscount.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

discountedSpent

Price · object

Equal to Spent - CurrentDiscount.

Show child attributes

discountedSpent.amount

number

discountedSpent.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

spentToComplete

Price · object

Equal to RevisedBudget - Spent.

Show child attributes

spentToComplete.amount

number

spentToComplete.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

timeToComplete

Duration · object

Equal to spentToComplete / standardPrice.

Show child attributes

timeToComplete.value

number<float>

Decimal value

Must be a multiple of 0.001

timeToComplete.iso

string<duration>

ISO-8601 formatted string

timeToComplete.unit

enum<string>

Duration unit: days or hours.

Available options:

day,

hour

Example:

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

string<uri> | null

count

integer | null

Required range: x >= 0

items

The Project Financials resource · object[]

Show child attributes

items.project

object

Show child attributes

items.project.id

number

Required range: x >= 1

items.project.code

string

Minimum string length: 1

items.project.name

string

Minimum string length: 1

items.project.client

object

Show child attributes

items.project.client.id

number

Required range: x >= 1

items.project.client.code

string

Minimum string length: 1

items.project.client.name

string

Minimum string length: 1

items.project.client.externalCode

string

items.project.owner

object

Show child attributes

items.project.owner.picture

object

required

Show child attributes

items.project.owner.picture.href

string

required

Minimum string length: 1

items.project.owner.establishmentId

number

required

items.project.owner.id

number

items.project.owner.firstName

string

Minimum string length: 1

items.project.owner.lastName

string

Minimum string length: 1

items.project.owner.dtContractEnd

any

items.project.status

any

items.project.contractType

any

items.project.initialDeliveryDate

string<date>

items.project.revisedDeliveryDate

string<date>

items.project.billRate

PriceRate · object

Represents an amount of money per day or hour.

Show child attributes

items.project.billRate.price

Price · object

Represents an amount of money. Is a value object containing a decimal number and a currency.

Show child attributes

items.project.billRate.price.amount

number

items.project.billRate.price.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

items.project.billRate.unit

enum<string>

Duration unit: days or hours.

Available options:

day,

hour

items.project.initialTimeEstimate

Duration · object

Represents a duration in days or hours. ISO value is formatted as an ISO-8601 duration string. For example P5DT8H represents 128 hours. When sending a duration to the server, please only send either a value or an iso. In most cases, the unit is set on the project's organization and thus should not be sent in the request.

Show child attributes

items.project.initialTimeEstimate.value

number<float>

Decimal value

Must be a multiple of 0.001

items.project.initialTimeEstimate.iso

string<duration>

ISO-8601 formatted string

items.project.initialTimeEstimate.unit

enum<string>

Duration unit: days or hours.

Available options:

day,

hour

Example:

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

items.project.revisedTimeEstimate

Duration · object

Show child attributes

items.project.revisedTimeEstimate.value

number<float>

Decimal value

Must be a multiple of 0.001

items.project.revisedTimeEstimate.iso

string<duration>

ISO-8601 formatted string

items.project.revisedTimeEstimate.unit

enum<string>

Duration unit: days or hours.

Available options:

day,

hour

Example:

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

items.project.anomalies

object[]

items.project.risks

object[]

Minimum array length: 1

Show child attributes

items.project.risks.type

string

required

Minimum string length: 1

items.project.risks.label

string

required

Minimum string length: 1

items.project.invoicingWarnings

object[]

items.project.initialBudget

object

Show child attributes

items.project.initialBudget.amount

number

required

items.project.initialBudget.currencyId

string

Minimum string length: 1

items.project.revisedBudget

object

Show child attributes

items.project.revisedBudget.amount

number

items.project.revisedBudget.currencyId

string

Minimum string length: 1

items.project.price

object

Show child attributes

items.project.price.amount

number

items.project.price.currencyId

string

Minimum string length: 1

items.project.invoiceMilestonesTotal

any

items.project.discount

Price · object

Represents an amount of money. Is a value object containing a decimal number and a currency.

Show child attributes

items.project.discount.amount

number

items.project.discount.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

items.project.startsOn

string

Minimum string length: 1

items.time

Duration · object

Total time spent on the project.

Show child attributes

items.time.value

number<float>

Decimal value

Must be a multiple of 0.001

items.time.iso

string<duration>

ISO-8601 formatted string

items.time.unit

enum<string>

Duration unit: days or hours.

Available options:

day,

hour

Example:

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

items.spent

Price · object

Standard price value of all time spent on the project.

Show child attributes

items.spent.amount

number

items.spent.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

items.progress

number

Current total progress percentage for the project.

Must be a multiple of 0.01

items.totalInvoiced

Price · object

Total amount invoiced to the client for this project.

Show child attributes

items.totalInvoiced.amount

number

items.totalInvoiced.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

items.managementOutstanding

Price · object

Equal to Spent - TotalInvoiced. In other words, is equal to the standard price value of all uninvoiced time spent on the project.

Show child attributes

items.managementOutstanding.amount

number

items.managementOutstanding.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

items.currentOverrun

Price · object

Standard price value of the current budget overrun.

Show child attributes

items.currentOverrun.amount

number

items.currentOverrun.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

items.estimatedOverrun

Price · object

Standard price value of the planned total budgeted overrun.

Show child attributes

items.estimatedOverrun.amount

number

items.estimatedOverrun.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

items.price

Price · object

Price for this project (estimated based on initial time estimate for time and materials contracts).

Show child attributes

items.price.amount

number

items.price.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

items.currentRecoveryRate

number

Ratio between (accounting) Revenue and (financials) Spent.

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

items.initialRecoveryRate

number

Ratio between Price and InitialBudget.

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

items.estimatedRecoveryRate

number

Ratio between Price and RevisedBudget.

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

items.currentDiscount

Price · object

Ratio of the total discount already "spent".

Show child attributes

items.currentDiscount.amount

number

items.currentDiscount.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

items.discountedSpent

Price · object

Equal to Spent - CurrentDiscount.

Show child attributes

items.discountedSpent.amount

number

items.discountedSpent.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

items.spentToComplete

Price · object

Budget remaining (amount). Equal to RevisedBudget - Spent.

Show child attributes

items.spentToComplete.amount

number

items.spentToComplete.currencyId

enum<string>

Available options:

EUR,

USD,

CAD,

...

items.timeToComplete

Duration · object

Time budget remaining.

Show child attributes

items.timeToComplete.value

number<float>

Decimal value

Must be a multiple of 0.001

items.timeToComplete.iso

string<duration>

ISO-8601 formatted string

items.timeToComplete.unit

enum<string>

Duration unit: days or hours.

Available options:

day,

hour

Example:

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

Documentation

Files

Organization Structure API

Core HR API

Expenses API

Invoices API

Absences API

Office API

Project API

Schedule API

Timesheet API

Mealvouchers API

Compensation API

Training API

List financials by project

Headers

Query Parameters

Response