Raw Data

This is low level Ecosuite internal data element documentation

This Raw Data documentation is technical documentation intended to help those doing data integrations via google APIs or similar. For example, it provides useful knowledge if you are doing the mapping of a new Financial Model into Ecosuite.

Payment Types and Their Properties

Cash Flow Level Properties (Common Across All Payment Types)

Property	Description
cashFlows[n].id	A unique identifier for the cash flow
cashFlows[n].name	The name of the cash flow
cashFlows[n].category	The category of the cash flow
cashFlows[n].account	The account associated with the cash flow
cashFlows[n].flags.backend	Indicates if the cash flow is a backend cash flow
cashFlows[n].flags.debt	Indicates if the cash flow is forecasted permanent debt

Scheduled Payments

Property	Description
cashFlows[n].payments[0].paymentType	The type of payment (always "scheduled")
cashFlows[n].payments[0].subAccount	The sub-account associated with the payment
cashFlows[n].payments[0].payments[m].amountDue	The amount due for the payment
cashFlows[n].payments[0].payments[m].dueDate	The due date for the payment
cashFlows[n].payments[0].payments[m].description	The description of the payment

Recurring Payments

Property	Description
cashFlows[n].payments[0].paymentType	The type of payment (always "recurring")
cashFlows[n].payments[0].subAccount	The sub-account associated with the payment if applicable
cashFlows[n].payments[0].recurrence.rateType	Fixed or variable
cashFlows[n].payments[0].recurrence.escalator
cashFlows[n].payments[0].recurrence.multiplier
cashFlows[n].payments[0].payments[m].startDate	The start date for the payment
cashFlows[n].payments[0].frequency	The frequency of the recurring payment (e.g., monthly)

Generation Payments

Recurring payment types with a generation qualifier

Property	Description
cashFlows[n].payments[0].paymentType	The type of payment (always "generation")
cashFlows[n].payments[0].subAccount	The sub-account associated with the payment
cashFlows[n].payments[0].pathId	The path ID to apply the tariff to a project/site/system

Amortization Payments

Property	Description
cashFlows[n].payments[0].paymentType	The type of payment (always "amortization")
cashFlows[n].payments[0].subAccount	The sub-account associated with the payment
cashFlows[n].payments[0].amount
cashFlows[n].payments[0].rate	Interest rate
cashFlows[n].payments[0].amortization	Years of amortization
cashFlows[n].payments[0].term
cashFlows[n].payments[0].frequency

Size Payments

Recurring payment types with a size qualifier

cashFlows[n].payments[0].paymentType	The type of payment (always "size")
cashFlows[n].payments[0].subAccount	The sub-account associated with the payment
cashFlows[n].payments[0].pathId	The path ID to project/site/system
cashFlows[n].payments[0].size	(e.g., $/kW/mo, $/W/year)

Tariff Payments

cashFlows[n].payments[0].paymentType	The type of payment (always "tariff")

cashFlows[n].payments[0].subAccount	The sub-account associated with the payment

cashFlows[n].payments[0].tariff	A unique tariff ID

cashFlows[n].payments[0].pathId	The path ID to apply the tariff to a project/site/system

cashFlows[n].payments[0].startDate	Date tariff is applicable

cashFlows[n].payments[0].endDate	Date tariff is no longer applicable