Report

PreviousIrr categories NextSettings

Get the finance report for a project

get

/finance/projects/{projectId}/report

Authorizations

Path parameters

projectIdstringrequired

The ID of the project to get the details for

Query parameters

proFormaVersionIdstring

Can be used to specify a specific version of the Pro Forma to be used in the report instead of the latest version.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.ecosuite.io//finance/projects/{projectId}/report' \
  --header 'Authorization: YOUR_API_KEY'

200

400

{
  "timestamp": "2025-02-23T23:54:25.617Z",
  "report": {
    "forecast": {
      "dates": [
        "text"
      ],
      "netIncomes": [
        1
      ],
      "unleveredTotals": [
        1
      ],
      "leveredTotals": [
        1
      ],
      "unleveredIrr": [
        1
      ],
      "leveredIrr": [
        1
      ],
      "retainedEarnings": [
        1
      ],
      "categories": [
        {
          "ANY_ADDITIONAL_PROPERTY": {
            "name": "text",
            "totals": [
              1
            ],
            "categories": [
              {
                "ANY_ADDITIONAL_PROPERTY": {
                  "name": "text",
                  "totals": [
                    1
                  ],
                  "transactions": [
                    {}
                  ],
                  "categories": [
                    {
                      "ANY_ADDITIONAL_PROPERTY": {
                        "name": "text",
                        "totals": [
                          1
                        ],
                        "transactions": [
                          {}
                        ]
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    },
    "expected": {
      "dates": [
        "text"
      ],
      "netIncomes": [
        1
      ],
      "unleveredTotals": [
        1
      ],
      "leveredTotals": [
        1
      ],
      "unleveredIrr": [
        1
      ],
      "leveredIrr": [
        1
      ],
      "retainedEarnings": [
        1
      ],
      "categories": [
        {
          "ANY_ADDITIONAL_PROPERTY": {
            "name": "text",
            "totals": [
              1
            ],
            "categories": [
              {
                "ANY_ADDITIONAL_PROPERTY": {
                  "name": "text",
                  "totals": [
                    1
                  ],
                  "transactions": [
                    {}
                  ],
                  "categories": [
                    {
                      "ANY_ADDITIONAL_PROPERTY": {
                        "name": "text",
                        "totals": [
                          1
                        ],
                        "transactions": [
                          {}
                        ]
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    },
    "actual": {
      "dates": [
        "text"
      ],
      "netIncomes": [
        1
      ],
      "unleveredTotals": [
        1
      ],
      "leveredTotals": [
        1
      ],
      "unleveredIrr": [
        1
      ],
      "leveredIrr": [
        1
      ],
      "retainedEarnings": [
        1
      ],
      "categories": [
        {
          "ANY_ADDITIONAL_PROPERTY": {
            "name": "text",
            "totals": [
              1
            ],
            "categories": [
              {
                "ANY_ADDITIONAL_PROPERTY": {
                  "name": "text",
                  "totals": [
                    1
                  ],
                  "transactions": [
                    {}
                  ],
                  "categories": [
                    {
                      "ANY_ADDITIONAL_PROPERTY": {
                        "name": "text",
                        "totals": [
                          1
                        ],
                        "transactions": [
                          {}
                        ]
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    },
    "latestBestEstimate": {
      "dates": [
        "text"
      ],
      "netIncomes": [
        1
      ],
      "unleveredTotals": [
        1
      ],
      "leveredTotals": [
        1
      ],
      "unleveredIrr": [
        1
      ],
      "leveredIrr": [
        1
      ],
      "retainedEarnings": [
        1
      ],
      "categories": [
        {
          "ANY_ADDITIONAL_PROPERTY": {
            "name": "text",
            "totals": [
              1
            ],
            "categories": [
              {
                "ANY_ADDITIONAL_PROPERTY": {
                  "name": "text",
                  "totals": [
                    1
                  ],
                  "transactions": [
                    {}
                  ],
                  "categories": [
                    {
                      "ANY_ADDITIONAL_PROPERTY": {
                        "name": "text",
                        "totals": [
                          1
                        ],
                        "transactions": [
                          {}
                        ]
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

successful operation

Update the finance report for a project

Update the cached finance report for a project with the latest data

put