API Documentation
  • API Documentation
  • Ecosuite Project Data API
    • Authentication
    • OpenAPI reference
      • Events
        • Resolve
      • Feedback
      • Profile
      • Portfolios
      • Projects
        • Contacts
        • Pro forma
          • Versions
        • I2x
        • Records
        • Sites
          • Records
          • Systems
            • Records
        • Record documents
      • Record documents
      • Records
        • Record documents
      • Service requests
        • Generate
        • Resolve
      • Tariff
      • User groups
      • Users
        • Alerts
        • Groups
          • Reset
        • Mfa
        • Notifications
        • Resend
      • User types
      • Audit
        • Assets
        • Projects
        • Users
      • Coda
        • Milestones
        • Import
      • Connectivity
        • Data
        • Devices
      • Dashboard
        • Status
      • Energy
        • Datums
          • Most recent
          • Projects
          • Consumption
            • Cost
              • Projects
            • Predicted
              • Projects
            • Projects
          • Cumulative
            • Projects
          • Generation
            • Expected
            • Predicted
              • Projects
          • Nodes
            • Projects
        • Export
        • Instantaneous
        • Readings
        • Status
      • Finance
        • Cashflow totals
        • Report
        • Transactions
        • Sources uses
          • Sources uses
        • Export
          • Report
        • Projects
          • Billing
          • CashFlowTimeSeriesArrears
          • Categories
          • Irr categories
          • Report
          • Settings
          • Sources uses
          • Import
          • Cash flows
            • Payment logs
          • Pro forma
            • Irr
        • Record
          • Payments
        • Softledger
          • Locations
      • Media
        • Files
        • Tags
          • Storage
            • Code
            • Labels
          • Default
        • Storage
          • File
          • Code
      • Public
        • Projects
        • Energy
          • Datums
            • Projects
          • Readings
            • Projects
      • Schemas
        • Rfi
        • RfiReply
        • Dr event
        • Dr notification
        • Event
        • Participant
        • Finance
        • Notification
        • Portfolio
        • Pro forma
        • Profile
        • Project
        • Record
        • Service request
        • Site
        • System
        • User
        • User type
        • User groups
        • New tariff
        • Tariff
      • Rfi
        • Thread
          • Code
          • Resolve
          • Version
          • Replies
        • Reply
          • Version
      • Search
        • Refinements
      • Solarnetwork
        • Devices
        • Instruction
        • Nodes
        • Ssh
        • Credentials
          • Solarflux
          • Solarnode
          • Ssh
        • Metadata
          • Projects
        • Settings
          • Node ids
        • Solarnode
          • Login url
      • Tools
        • Address business details
      • Dr
        • Participants
        • Dr events
        • Dr notifications
      • Report
        • Operating
          • Project
      • Weather
        • Datums
          • Projects
        • Daylight
          • Projects
            • Sites
        • Projects
          • Sites
    • OpenAPI Specification
  • Ecosuite Time Series Data API
Powered by GitBook
On this page
  1. Ecosuite Project Data API
  2. OpenAPI reference
  3. Projects

Pro forma

PreviousContactsNextVersions

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
200
successful operation
400
Invalid status value
application/json
delete
DELETE //projects/{projectId}/pro-forma HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

No content

  • GETGet Pro Forma details
  • PUTSave Pro Forma details
  • DELETEDelete Pro Forma version

Get Pro Forma details

get

Gets the Pro Forma details for the specified project

Authorizations
Path parameters
projectIdstringRequired

The project ID

Responses
200
successful operation
application/json
400
Invalid status value
application/json
get
GET //projects/{projectId}/pro-forma HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "proForma": {
    "projectStartDate": "2025-06-16",
    "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
        ]
      }
    ]
  }
}

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
200
successful operation
application/json
400
Invalid status value
application/json
put
PUT //projects/{projectId}/pro-forma HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 369

{
  "projectStartDate": "2025-06-16",
  "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
      ]
    }
  ]
}
{
  "proForma": {
    "projectStartDate": "2025-06-16",
    "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
        ]
      }
    ]
  }
}