Report

Get the finance report for a project

get

Get the finance report for a project

Authorizations

Path parameters

projectIdstringRequired

The ID of the project to get the details for

Query parameters

proFormaVersionIdstringOptional

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

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

HTTPcURLJavaScriptPython

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

{
  "timestamp": "2025-06-16T12:36:14.849Z",
  "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": [
                          {}
                        ]
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

Update the finance report for a project

put

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

Authorizations

Path parameters

projectIdstringRequired

The ID of the project to update the report for

Responses

200

successful operation

400

Invalid status value

application/json

put

HTTPcURLJavaScriptPython

PUT //finance/projects/{projectId}/report HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

No content