Calculate cashflow results

GET

Project

{projectId}

Prediction

{predictionId}

CalculateCashflowResults

Calculate cashflow results

curl --request GET \
  --url https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/CalculateCashflowResults \
  --header 'Authorization: Bearer <token>'

{
  "id": 123,
  "cumulativeCashflowSummary": {},
  "cashflowYearResults": [
    {}
  ],
  "cashflowGraphResults": [
    {}
  ],
  "projectOutputs": {}
}

Authorizations

Authorization

string

header

required

Pass Authorization: Bearer <token> on every request. See the Authentication section of the API description for how to fetch a token.

Path Parameters

projectId

integer

required

predictionId

integer

required

Response

Cashflow results

integer

cumulativeCashflowSummary

object

cashflowYearResults

object[]

cashflowGraphResults

object[]

projectOutputs

object

Get URL for a generated reportReturns the download URL for a specific report type. Valid report values: PlantSummary, PlantSummary8760, BlockSummary8760, InputsAssumptions. Not available for batch predictions. **Parameters:** - `projectId` (path, required): The project ID. - `predictionId` (path, required): The prediction ID. - `report` (path, required): Report type name (PlantSummary, PlantSummary8760, BlockSummary8760, or InputsAssumptions).

⌘I

Calculate cashflow results

curl --request GET \
  --url https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/CalculateCashflowResults \
  --header 'Authorization: Bearer <token>'

{
  "id": 123,
  "cumulativeCashflowSummary": {},
  "cashflowYearResults": [
    {}
  ],
  "cashflowGraphResults": [
    {}
  ],
  "projectOutputs": {}
}