Skip to main content

Source Reconciliation Matrix

Canonical field/pathPDF termStatusNotes
AcLosses.acohmicLossacohmicLosscurrentDirect match.
AcSystem.mpptFractionmpptFractioncurrentMulti-MPPT power fraction allocation.
AcSystem.numberOfInvertersnumberOfInverterscurrentDirect match.
ArraySingleLegacy.bifacialbifacialcurrentDirect match.
ArraySingleLegacy.bifacialInputsbifacialInputscurrentDirect match.
ArraySingleLegacy.stringCountstringCountcurrentDirect match.
ArraySingleLegacy.stringLengthstringLengthcurrentDirect match.
BifacialInputs.heightheightcurrentTracker center of rotation height in meters.
BifacialInputs.irradianceMismatchLossirradianceMismatchLosscurrentDirect match.
BifacialInputs.moduleTransparencymoduleTransparencycurrentDirect match.
BifacialInputs.rackingShadingrackingShadingcurrentDirect match.
Block.acSystemacSystemcurrentDirect match.
Block.albedoalbedocurrentDirect match.
Block.aoiaoicurrentCustom angle-of-incidence transmission curve.
Block.arrayarraycurrentDirect match in legacy schema mode.
Block.dcInputsarraylegacy termv16 PDF centers on legacy array shape. Current schema adds dcInputs for multi-MPPT.
Block.inverterIdinverterIdcurrentDirect match.
Block.layoutlayoutcurrentDirect match.
Block.layoutReflayoutlegacy termPDF assumes inline layout. Current API also supports external layoutRef.
Block.losseslossescurrentDirect match.
Block.moduleIdmoduleIdcurrentDirect match for legacy array block form.
Block.shadingshadingcurrentDirect match.
Block.shadingStringMapshadingSceneIdlegacy termPDF describes block-level shadingSceneId. Current API additionally supports per-dcInput shadingStringMap.
DcInputGroup.dcInputIdstringCountlegacy termMulti-MPPT identifiers are current-schema additions beyond the legacy single-array framing.
DcInputGroup.moduleIdmoduleIdcurrentSame semantic meaning, now per-DC-input in multi-MPPT mode.
DcInputGroup.mpptIndexarraylegacy termCurrent multi-MPPT control field.
DcInputGroup.stringCountstringCountcurrentSame semantic meaning.
DcInputGroup.stringLengthstringLengthcurrentSame semantic meaning.
EnergyModelInput.blocksblockscurrentDirect match.
EnergyModelInput.farShadingfarShadingcurrentFar shading profile override at root level.
EnergyModelInput.locationlocationcurrentInline location for querying mode.
EnergyModelInput.locationIdlocationIdcurrentDirect match.
EnergyModelInput.outputoutputcurrentDirect match.
EnergyModelInput.plantplantcurrentDirect match.
EnergyModelInput.projectIdprojectIdcurrentDirect match (optional location source).
EnergyModelInput.schemaVersionschemaVersionlegacy termNot surfaced in v16 PDF page 7/8 structure diagram but supported in current API.
EnergyModelInput.settingssettingscurrentDirect match.
EnergyModelInput.soilingsoilingcurrentDirect match.
EnergyModelInput.weatherDataweatherDatacurrentSupported inline weather override.
EnergyModelInput.weatherIdweatherIdcurrentDirect match.
HvLosses.hvCollectionLossFractionhvCollectionLossFractioncurrentDirect match.
Layout.arrayTypearrayTypecurrentDirect match.
Layout.axisTiltaxisTiltcurrentDirect match.
Layout.azimuthazimuthcurrentDirect match.
Layout.backTrackingbackTrackingcurrentDirect match.
Layout.gcrgcrconflictPDF cites 0.1-0.85; current validator enforces 0.15-0.90.
Layout.maxAnglemaxAnglecurrentDirect match.
Layout.numberOfRowsnumberOfRowscurrentDirect match.
Layout.tilttiltcurrentDirect match.
LayoutRef.layoutIdlayoutlegacy termExternal layout reference not described in legacy PDF.
LayoutRef.layoutVersionlayoutlegacy termExternal layout version pinning.
Losses.dcohmicdcohmiccurrentDirect match.
Losses.degradationdegradationcurrentOptional.
Losses.degradationMismatchdegradationMismatchcurrentOptional.
Losses.invAuxLossinvAuxLosscurrentDirect match.
Losses.lidlidcurrentDirect match.
Losses.mismatchmismatchcurrentDirect match.
Losses.moduleQualitymoduleQualitycurrentDirect match.
Losses.stringVoltageMismatchstringVoltageMismatchcurrentDirect match.
Losses.uCuCcurrentDirect match.
Losses.uVUvlegacy termPDF casing varies; canonical payload key is uV.
MvLosses.mvOhmicLossFractionmvOhmicLossFractioncurrentDirect match.
MvLosses.mvTransformerLossFractionmvTransformerLossFractioncurrentDirect match.
Output.blockIndexblockQuery + blockQueryIndexlegacy termCanonical zero-based selected-block response filter. Conflicting canonical and legacy values return 422.
Output.blockResultsblockresultslegacy termCanonical output field for blockTimeSeries visibility. Legacy query param blockresults still normalizes here.
Output.fullOutputfullOutputcurrentDirect match.
Output.fullTimeSeriesfullTimeSeriescurrentDirect match. Mutually exclusive with blockResults.
Output.lossBreakdownTimestampslossBreakdownTimestampslegacy termTop-level boolean request flag again. Implies block-level results are surfaced.
Output.namenamecurrentOptional simulation run label.
Output.savesavelegacy termAccepted only as a backward-compatible persistence hint; not the preferred contract.
Output.timeSeriestimeSeriescurrentDirect match.
Plant.contAuxLossThreshkWcontAuxLossThreshkWcurrentDirect match.
Plant.contAuxLosskWcontAuxLosskWcurrentDirect match.
Plant.hvLosseshvLossescurrentDirect match.
Plant.limitAtInverterslimitAtInverterscurrentDirect match.
Plant.nightAuxLossnightAuxLosscurrentDirect match.
Plant.poiLimitMWpoiLimitMWcurrentDirect match.
Plant.powerFactorpowerFactorcurrentDirect match.
Plant.propAuxLossThreshkWpropAuxLossThreshkWcurrentDirect match.
Plant.propAuxLossWperkWpropAuxLossWperkWcurrentDirect match.
Settings.advancedNearShadingLossesadvancedNearShadingLossescurrentDirect match.
Settings.circumsolarIncludedInDiffusecircumsolarIncludedInDiffusecurrentDirect match.
Settings.dcInputPowerSharingPolicydcInputPowerSharingPolicycurrentDirect match.
Settings.ignoreSpectralCorrectionignoreSpectralCorrectioncurrentDirect match.
Settings.inverterAmbientTemperatureShiftinverterAmbientTemperatureShiftcurrentDirect match.
Settings.irradianceOptimizationirradianceOptimizationcurrentDirect match.
Settings.timeZoneOverridetimeZoneOverridecurrentDirect match.
Settings.windStowwindStowcurrentDirect match.
Shading.electricalImpactelectricalImpactcurrentDirect match.
Shading.electricalImpactFractionelectricalImpactFractioncurrentDirect match; defaults to 1.0 when electricalImpact=true.
Shading.farShadingfarShadingcurrentDirect match.
Shading.nearShadingnearShadingcurrentDirect match.
Shading.shadingSceneIdshadingSceneIdcurrentDirect match for octavia mode.
Shading.transverseDiodestransverseDiodesconflictPDF describes wider limits in some modes; current validator enforces 0-10 globally.
StringShadingMap.dcInputIdshadingSceneIdlegacy termPer-dcInput shading mapping is current-schema behavior.
StringShadingMap.shadingSceneIdshadingSceneIdcurrentDirect match at scene identifier level.
StringShadingMap.tableGroupIdshadingSceneIdlegacy termCurrent schema adds table-group linkage controls.
StringShadingMap.tableIdsshadingSceneIdlegacy termCurrent schema adds table-level linkage controls.
TransformerLosses.copperLosscopperLosscurrentDirect match.
TransformerLosses.ironLossironLosscurrentDirect match.
WeatherDataArrayInput.datedatelegacy termPDF overview does not detail auto-generated date behavior for exactly 8760 rows.
WeatherDataArrayInput.dhidhicurrentDirect match.
WeatherDataArrayInput.dnidnicurrentDirect match.
WeatherDataArrayInput.ghighicurrentDirect match.
WeatherDataArrayInput.poapoacurrentOptional POA irradiance override.
WeatherDataArrayInput.relativeHumidityrelativeHumiditycurrentDirect match.
WeatherDataArrayInput.temperaturetemperaturecurrentDirect match.
WeatherDataArrayInput.windSpeedwindSpeedcurrentDirect match.
WindStow.stowAnglestowAnglecurrentDirect match.
WindStow.stowSpeedThresholdstowSpeedThresholdcurrentDirect match.

Behavior Conflicts

TopicPDF wordingCurrent behaviorSource
POST /energymodels async defaultDescribes async query parameter but does not establish current default semantics used by API docs.Route defaults to sync mode when async query is omitted; async queueing requires ?async=true.packages/api/api/routes/energy_models.py and packages/api/tests/test_api/test_energy_models.py
Run identifier namingReferences runId.API responses use taskId, energyModelId, runIndex, and revision.packages/api/api/routes/energy_models.py
Selected-block request contractDescribes top-level blockQuery, blockQueryIndex, and lossBreakdownTimestamps as primary request fields.The preferred contract uses top-level output.blockIndex plus output.blockResults or output.lossBreakdownTimestamps. Legacy blockQuery/blockQueryIndex are compatibility-only, and conflicting canonical and legacy values return 422.packages/api/api/routes/energy_models.py and packages/api/core/models/energy_model.py
conflict entries are intentionally documented for migration clarity.