Pro forma

PreviousContacts NextVersions

Delete Pro Forma version

delete

Deletes the Pro Forma version for the specified project

Authorizations

Path parameters

projectIdstringRequired

The project ID

Query parameters

versionstringOptional

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

delete

DELETE //projects/{projectId}/pro-forma HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

No content

Get Pro Forma details

get

Gets the Pro Forma details for the specified project

Authorizations

Path parameters

projectIdstringRequired

The project ID

Responses

get

GET //projects/{projectId}/pro-forma HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

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

Save Pro Forma details

put

Saves the Pro Forma details for the specified project

Authorizations

Path parameters

projectIdstringRequired

The project ID

Query parameters

versionstringOptional

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

Refer to the /schemas/pro-forma endpoint for the full JSON Schema definition

projectStartDatestring · dateRequired

systemSizenumberRequired

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

systemProductionnumberRequired

The total kWhs generated per Year per kW of installed PV

degradationnumberRequired

projectLifenumber · max: 50Required

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

developerFeePercentnumberOptional

archivedbooleanOptionalDefault: false

Responses

put

PUT //projects/{projectId}/pro-forma HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 366

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

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