Project
Project details with comprehensive information about the solar installation project
- financeType:
Reporting requiredProperties: 6Current selected financing composition. Prepaid with associated Cash or Loan remains Prepaid TPO. Independent legs of different known types produce Mixed; equal types retain that type. Unknown and issues make missing or inconsistent evidence explicit. Saved unselected options and down payments do not add legs. This projection does not establish a sale or preserve the financier at signing.
- activeType: integer
Panels Count Integer numbers.
- addersType: numberFormat: float
Total Price - additionalType: numberFormat: float
Margin min:0max:100 - Properties: 7addressType:
- annualType: numberFormat: float
Degradation Factor - Properties: 1arrayType:
Stats - Properties: 7assignedType:
Sales Rep - baseType: numberFormat: floatnullable
Battery Price - baseType: numberFormat: floatnullable
Home Improvement Adders Price Base price for home improvement adders
- baseType: numberFormat: floatnullable
Home Improvement Price Base price for home improvement equipment
- baseType: numberFormat: floatnullable
Hvac Adders Price Base price for HVAC-specific adders
- baseType: numberFormat: floatnullable
Load Management Price - baseType: numberFormat: float
P P W - baseType: numberFormat: floatnullable
Roof Adders Price Base price for roof-specific adders
- baseType: numberFormat: floatnullable
Solar System Total Price - baseType: numberFormat: float
System Price Base system price before incentives
- Properties: 7batteryType: nullable
- batteryType: integer
Count Integer numbers.
- batteryType: "backup" or "self_consumption" or "time_of_use"enum
Mode - clonedType: stringFormat: uuidnullable
From Project Id The project this one was cloned from. Null means the project is an original. Points at the direct source, so a clone of a clone references its immediate parent rather than the root of the chain.
- coType: nullable
Applicant Properties: 9Co-applicant associated with the project. Null if no co-applicant exists.
- combinedType: stringnullable
Roof Outline Wkt Exact union of all non-ground-mount roof-plane footprints across every structure, in the project's 2D UTM coordinate system. Returns POLYGON for connected geometry or MULTIPOLYGON for detached geometry. Null when roof-plane geometry or georeferencing is unavailable.
- companyType: string
Name - createdType: stringFormat: date-time
At the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- customerType: stringFormat: uri
Url URL to the customer page for this project's homeowner. Points at the homeowner id, not the project id, so all of a customer's projects share the same customerUrl.
- documentsType:Properties: 6
Project documents such as utility bills, drone images, and other files
- electricType: numberFormat: floatnullable
Bill - energyType: nullable
Community Properties: 4Energy community qualification status under the Inflation Reduction Act (IRA). Null if not yet checked.
- energyType: array of number 12…12Format: floatnullable
Consumption 12 months of energy consumption
- energyType: array of number 12…12Format: floatnullable
Payment 12 months of energy payment
- energyType: stringFormat: uri
Plan Url URL to the energy plan page. Similar to proposalUrl but with /e instead of /p in the path.
- equipmentType:
Breakdown Properties: 6Detailed breakdown of all equipment pricing including solar, battery, and home improvements
- equipmentsType:Properties: 9
List of equipment included in the project (e.g., HVAC units, windows, roofing materials)
- estimatedType: numberFormat: float
Annual Production Ackwh - estimatedType: integer
Years Of Power Production Integer numbers.
- externalType: stringnullable
Project Id - finalType: numberFormat: float
System Price - financierType: nullableProperties: 22
Active financier for financed projects and selected Prepaid + Cash when represented by an active financier row. Null for multi-financing (see financiers) or when no active financier row exists. Native prepaid provider identity is exposed in financeReporting.prepaid even when financier is null.
- financiersType:
Present when
paymentOptionismulti-financing: each active financier in the split, with per-side loan amount and assigned equipment/adder segments. - Properties: 5georefType: nullable
Image Params - grossType: numberFormat: float
System Price Gross system price before incentives and discounts
- hasType: boolean
Battery - homeType: array of stringenum
Improvement Types Array of home improvement types included in the project
valueswindowdoorhvacinsulationwater-heatermpuroof - Properties: 12homeownerType:
- idType: stringFormat: uuid
- incentivesType: numberFormat: float
Total - initialType: numberFormat: float
Loan Payment - Properties: 15installerType:
- Properties: 7inverterType: nullable
- inverterType: integer
Count Integer numbers.
- isType: boolean
Starred - loanType: numberFormat: float
Amount - loanType: numberFormat: float
Payment - loanType: numberFormat: float
Payment Without Incentives - masterType: string
Tariff Id - obstaclesType: array of string
Wkt - offsetType: numberFormat: float
- organizationType: stringFormat: uuid
Id - parcelType: stringnullable
Outline Wkt WKT polygon representing the property parcel boundary, in UTM coordinates. Null if no parcel outline is available for this project.
- paymentType: stringenum
Option How the project is paid for. When
multi-financing, use thefinanciersarray for the active split; whenfinanced, usefinancierfor the single active lender.valuesfinancedcashleaseppamulti-financing - postType: numberFormat: floatnullable
Solar Estimated Annual Consumption Ackwh - postType: string
Solar Tariff Code - postType: numberFormat: floatnullable
Solar Utility Rate - preferredType: string
Language - preType: numberFormat: floatnullable
Solar Estimated Annual Consumption Ackwh - preType: string
Solar Tariff Code - preType: numberFormat: floatnullable
Solar Utility Rate - projectType: integer
Radius M min:15max:40Resolved project parcel radius in meters. This is the square half-extent used for imagery and auto-design.
- proposalType: string
Status - proposalType: stringenum
Type valuesSolarSolar + BatteryBattery OnlyHome Improvement - proposalType: stringFormat: uri
Url - rgbType: stringFormat: urinullable
Basemap Url - rgbType: stringFormat: urinullable
Basemap With Panels Url - rgbType: integer
Image Size Integer numbers.
- roofingType: nullableProperties: 11
Roof measurements computed from the project's roof planes and edges (total area, edge linear footage, pitch breakdown, per-facet detail, and waste-factor table). Only populated for organizations that have the roofing module enabled; null otherwise, or when the project has no roof planes or no georeferenced map scale.
- roofType: string
Outline Wkt nullabledeprecatedLegacy project-wide roof envelope in UTM coordinates. For structure-specific geometry, use structures[].roofOutlineWkt. Null if the roof has not been configured in the design editor.
- roofType: array of object
Planes Properties: 11Individual roof planes for this project. Empty until roof planes are drawn in the design editor.
- Properties: 7solarType: nullable
Panel - Properties: 25solarType:
Panels - statusType: array of object
Histories Properties: 3History of project status changes, ordered by statusUpdatedAt ascending
- structuresType: array of objectProperties: 5
Roof design and roofing measurements grouped by structure. Numeric structureId values are ordered ascending, followed by a null group for legacy or unassigned roof planes. Empty when the project has no roof planes.
- systemType: string
Design Type - systemType: numberFormat: float
Size - tagsType: array of objectProperties: 5
Tags applied to the project
- Properties: 3teamType:
- totalType: numberFormat: float
Discounts Total discounts amount
- totalType: numberFormat: float
P P W After Incentives - totalType: numberFormat: float
P P W Before Incentives - totalType: numberFormat: float
Solar Resource Fraction - totalType: numberFormat: float
Term Degradation Factor - updatedType: stringFormat: date-time
At the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- Properties: 19upgradesType:
- utilityType: nullable
Bill Analysis Properties: 8Linked utility bill analysis result, if one was provided when creating the project
- utilityType: stringnullable
Company - utilityType: stringnullable
Company Id ID of the utility company, as sent in
utilityCompanyExternalIdwhen the project was created. - utilityType: stringnullable
Data Source - utmType: stringnullable
Campaign UTM campaign parameter for tracking marketing campaigns
- utmType: stringnullable
Content UTM content parameter for tracking marketing campaigns
- utmType: stringnullable
Medium UTM medium parameter for tracking marketing campaigns
- utmType: stringnullable
Source UTM source parameter for tracking marketing campaigns
- utmType: stringnullable
Term UTM term parameter for tracking marketing campaigns

