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. Finance
  4. Projects
  5. Cash flows

Payment logs

PreviousCash flowsNextPro forma

Get the cash flow payment logs

get

Get the cash flow payment logs for a specific cash flow in a project

Path parameters
projectIdstringRequired

The ID of the project to get the payment logs for

cashFlowIdstringRequired

The ID of the cash flow to get the payment logs for

Responses
200
successful operation
application/json
400
Invalid status value
application/json
get
GET //finance/projects/{projectId}/cash-flows/{cashFlowId}/payment-logs HTTP/1.1
Host: api.ecosuite.io
Accept: */*
{
  "cashFlow": {},
  "paymentLogs": {
    "payments": {
      "advisedAmount": 1,
      "reading": 1,
      "advisedReading": 1,
      "expectedAmount": 1,
      "start": "2025-06-16",
      "end": "2025-06-16"
    }
  }
}

Update the cash flow payment logs

put

Update the cash flow payment logs for a specific cash flow in a project

Authorizations
Path parameters
projectIdstringRequired

The ID of the project to update the payment logs for

cashFlowIdstringRequired

The ID of the cash flow to update the payment logs for

Responses
200
successful operation
400
Invalid status value
application/json
put
PUT //finance/projects/{projectId}/cash-flows/{cashFlowId}/payment-logs HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

No content

  • GETGet the cash flow payment logs
  • PUTUpdate the cash flow payment logs