Pro forma

PreviousContacts NextVersions

Get Pro Forma details

Gets the Pro Forma details for the specified project

get

/projects/{projectId}/pro-forma

Authorizations

Path parameters

projectIdstringrequired

The project ID

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

{
  "proForma": {
    "projectStartDate": "2025-02-24",
    "systemSize": 1,
    "systemProduction": 1,
    "degradation": 1,
    "projectLife": 1,
    "developerFeePercent": 1,
    "archived": false,
    "taxes": {
      "propertyTax": 1,
      "federalTax": 1,
      "stateTax": 1,
      "localTax": 1,
      "itc": 1
    },
    "cashFlows": [
      {
        "id": "text",
        "name": "text",
        "recordId": "text",
        "category": "text",
        "account": "text",
        "flags": {
          "backend": false,
          "debt": false
        },
        "payments": [
          null
        ]
      }
    ]
  }
}

successful operation

Save Pro Forma details

Saves the Pro Forma details for the specified project

put

/projects/{projectId}/pro-forma

Authorizations

Path parameters

projectIdstringrequired

The project ID

Query parameters

versionstring

The version name, if specified a version of the Pro Forma will be stored under this version name. If not included the actual Pro Forma itself is updated.

Body

projectStartDatestring · daterequired

systemSizeSystem Size (kW DC)required

The DC size of the system to use for forecasting of generation.

systemProductionSystem Production (kWh/kWp)required

The total kWhs generated per Year per kW of installed PV

degradationDegradation (%)required

projectLifeProject Life (Years)required

Used as default number of years for any recurring 'Expense' or 'Income' payment

developerFeePercentDeveloper Fee (%)

archivedArchived

taxesTaxes

cashFlowsCash Flows

Cash Flows are used to calculate the Pro Forma IRR

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.ecosuite.io//projects/{projectId}/pro-forma' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"projectStartDate":"2025-02-24","systemSize":1,"systemProduction":1,"degradation":1,"projectLife":1,"archived":false,"taxes":{"propertyTax":1,"federalTax":1,"stateTax":1,"localTax":1,"itc":1},"cashFlows":[{"id":"text","name":"text","recordId":"text","category":"text","account":"text","flags":{"backend":false,"debt":false},"payments":[null]}]}'

200

400

{
  "proForma": {
    "projectStartDate": "2025-02-24",
    "systemSize": 1,
    "systemProduction": 1,
    "degradation": 1,
    "projectLife": 1,
    "developerFeePercent": 1,
    "archived": false,
    "taxes": {
      "propertyTax": 1,
      "federalTax": 1,
      "stateTax": 1,
      "localTax": 1,
      "itc": 1
    },
    "cashFlows": [
      {
        "id": "text",
        "name": "text",
        "recordId": "text",
        "category": "text",
        "account": "text",
        "flags": {
          "backend": false,
          "debt": false
        },
        "payments": [
          null
        ]
      }
    ]
  }
}

successful operation

Delete Pro Forma version

Deletes the Pro Forma version for the specified project

delete

/projects/{projectId}/pro-forma

Authorizations

Path parameters

projectIdstringrequired

The project ID

Query parameters

versionstring

The version name, if specified a version of the Pro Forma will be delete. If not included the actual Pro Forma itself is deleted.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.ecosuite.io//projects/{projectId}/pro-forma' \
  --header 'Authorization: YOUR_API_KEY'

200

400

No body

successful operation