Irr

Get the Pro Forma IRR details for a project

get

Get the Pro Forma IRR details for a project

Authorizations

ecogy-auth-cognito-dev

Path parameters

projectIdstringRequired

The ID of the project to get the details for

Query parameters

proFormaVersionIdstringOptional

Can be used to specify a pro forma version in place of the projects current pro forma

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

HTTPcURLJavaScriptPython

GET //finance/projects/{projectId}/pro-forma/irr HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "irr": 1,
    "income": 1,
    "expenses": 1,
    "netIncome": 1,
    "capitalCost": 1,
    "cumulativeCashFlow": 1,
    "categories": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": 1
      }
    }
  },
  "month": "text"
}