Report

Get the finance report for a set of projects

get

Get the finance report for a set of projects

Authorizations

ecogy-auth-cognito-dev

Query parameters

projectIdsstringRequired

Comma separated list of the project IDs to generate the report for

aggregatestringOptional

The aggregate to group the report by, one of "month", "quarter", "year" or "total". Defaults to "month"

modestring · enumOptional

Whether the project starts date should be normalised to start at the same time or use their actual start dates

Possible values:

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

HTTPcURLJavaScriptPython

GET //finance/report HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "settings": {
    "projectIds": [
      "2025-09-16T12:45:25.780Z"
    ],
    "aggregate": "month",
    "report": {
      "dates": [
        "text"
      ],
      "unleveredTotals": {
        "totals": [
          1
        ],
        "projects": [
          {
            "ANY_ADDITIONAL_PROPERTY": {
              "totals": [
                1
              ]
            }
          }
        ]
      },
      "cumulativeUnleveredTotals": {
        "totals": [
          1
        ],
        "projects": [
          {
            "ANY_ADDITIONAL_PROPERTY": {
              "totals": [
                1
              ]
            }
          }
        ]
      },
      "leveredTotals": {
        "totals": [
          1
        ],
        "projects": [
          {
            "ANY_ADDITIONAL_PROPERTY": {
              "totals": [
                1
              ]
            }
          }
        ]
      },
      "netIncomes": {
        "totals": [
          1
        ],
        "projects": [
          {
            "ANY_ADDITIONAL_PROPERTY": {
              "totals": [
                1
              ]
            }
          }
        ]
      },
      "unleveredIrr": {
        "totals": [
          1
        ],
        "projects": [
          {
            "ANY_ADDITIONAL_PROPERTY": {
              "totals": [
                1
              ]
            }
          }
        ]
      },
      "leveredIrr": {
        "totals": [
          1
        ],
        "projects": [
          {
            "ANY_ADDITIONAL_PROPERTY": {
              "totals": [
                1
              ]
            }
          }
        ]
      },
      "retainedEarnings": {
        "totals": [
          1
        ],
        "projects": [
          {
            "ANY_ADDITIONAL_PROPERTY": {
              "totals": [
                1
              ]
            }
          }
        ]
      },
      "totalValue": {
        "totals": [
          1
        ],
        "projects": [
          {
            "ANY_ADDITIONAL_PROPERTY": {
              "totals": [
                1
              ]
            }
          }
        ]
      },
      "categories": {
        "ANY_ADDITIONAL_PROPERTY": {
          "totals": [
            1
          ],
          "projects": [
            {
              "ANY_ADDITIONAL_PROPERTY": {
                "totals": [
                  1
                ]
              }
            }
          ]
        }
      }
    }
  }
}