The project-financials resource

{
  "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
}

project

object

Show child attributes

time

object | null

Total time spent on the project. 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

Examples:

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

spent

object | null

Standard price value of all time spent on the project. Represents an amount of money. Is a value object containing a decimal number and a currency.

Show child attributes

progress

number

Current total progress percentage for the project.

Must be a multiple of 0.01

totalInvoiced

object | null

Total amount invoiced to the client for this project. Represents an amount of money. Is a value object containing a decimal number and a currency.

Show child attributes

managementOutstanding

object | null

Equal to Spent - TotalInvoiced. In other words, is equal to the standard price value of all uninvoiced time spent on the project. Represents an amount of money. Is a value object containing a decimal number and a currency.

Show child attributes

currentOverrun

object | null

Standard price value of the current budget overrun. Represents an amount of money. Is a value object containing a decimal number and a currency.

Show child attributes

estimatedOverrun

object | null

Standard price value of the planned total budgeted overrun. Represents an amount of money. Is a value object containing a decimal number and a currency.

Show child attributes

price

object | null

Price for this project (estimated based on initial time estimate for time and materials contracts). Represents an amount of money. Is a value object containing a decimal number and a currency.

Show child attributes

currentRecoveryRate

number

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

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

initialRecoveryRate

number

Ratio between Price and InitialBudget.

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

estimatedRecoveryRate

number

Ratio between Price and RevisedBudget.

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

currentDiscount

object | null

Ratio of the total discount already "spent". Represents an amount of money. Is a value object containing a decimal number and a currency.

Show child attributes

discountedSpent

object | null

Equal to Spent - CurrentDiscount. Represents an amount of money. Is a value object containing a decimal number and a currency.

Show child attributes

spentToComplete

object | null

Budget remaining (amount). Equal to RevisedBudget - Spent. Represents an amount of money. Is a value object containing a decimal number and a currency.

Show child attributes

timeToComplete

object | null

Time budget remaining. 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

Examples:

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

List Organizations

List financials by project

Documentation

Files

Organization Structure API

Core HR API

Expenses API

Invoices API

Absences API

Office API

Project API

Time Settings API

Timesheet API

Mealvouchers API

Compensation API

Training API

The project-financials resource