Pass Authorization: Bearer <token> on every request. See the Authentication section of the API description for how to fetch a token.
Response
Default settings
id
integer
environmentalConditions
object
The Environmental Conditions Page allows you to configure the weather and environmental parameters that influence solar resource modeling in your prediction. This includes selecting weather data, defining soiling and spectral loss profiles, setting design temperatures, and importing horizon scene data.
Show child attributes
powerPlantBuilder
object
The 3D View provides tools for analyzing terrain and racking placement within your map-based power plant design. This interface enables terrain slope analysis, table slope constraint identification, and post height calculations.
Show child attributes
simulationSettings
object
The Simulation Settings page allows you to configure the prediction timeframe and select the sub-models used for irradiance calculation, module performance, shading analysis, and degradation. These settings control the algorithms applied during the energy prediction simulation.
Show child attributes
weatherAPISettings
object
The Add New Weather page provides three methods for adding weather data to PlantPredict:
Show child attributes
essSettings
object
The Energy Storage System page allows you to configure an optional AC-coupled battery energy storage system (BESS) for your prediction. To enable energy storage, enter a Nameplate capacity value (input #1) and an Inverter Real Power rating (input #9). The Dispatch Algorithm should also be configured to ensure the...
Show child attributes
financialModelParameters
object
Show child attributes
miscellaneousSettings
object
The Simulation Settings page allows you to configure the prediction timeframe and select the sub-models used for irradiance calculation, module performance, shading analysis, and degradation. These settings control the algorithms applied during the energy prediction simulation.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"PlantPredict","colors":{"primary":"#086EC1","light":"#086EC1","dark":"#086EC1"},"logo":{"light":"https://mintcdn.com/terabaseenergy/iiAvm3u0yaPPvDgU/logo/Terabase_PlantPredict_Primary_Logo_Full_Color.svg?fit=max\u0026auto=format\u0026n=iiAvm3u0yaPPvDgU\u0026q=85\u0026s=d951c2fe4058ac3998997d5ed958bfe9","dark":"https://mintcdn.com/terabaseenergy/iiAvm3u0yaPPvDgU/logo/Terabase_PlantPredict_Primary_Logo_White.svg?fit=max\u0026auto=format\u0026n=iiAvm3u0yaPPvDgU\u0026q=85\u0026s=00d16ee188089d2e0fd9f9985ac4b900","href":"https://plantpredict.com/"},"favicon":"https://mintcdn.com/terabaseenergy/eQgx_CYJ74LVr_OK/favicon.ico?fit=max\u0026auto=format\u0026n=eQgx_CYJ74LVr_OK\u0026q=85\u0026s=187e381231017c22c54a0ce44fc17094","appearance":{"default":"system"},"navbar":{"links":[{"href":"mailto:support@plantpredict.com","label":"Support"}]},"footer":{"socials":{"github":"https://github.com/plantpredict","linkedin":"https://www.linkedin.com/showcase/plantpredict"}},"seo":{"metatags":{"canonical":"https://docs.plantpredict.com"}},"styling":{"latex":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"terabaseenergy","hasAudioNarration":false,"actualSubdomain":"terabaseenergy","customDomains":["docs.plantpredict.com"],"gitSource":{"type":"github","owner":"plantpredict","repo":"plantpredict-product-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af63734d89d0834a9bd7ca8","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"Release Notes","count":420},{"language":"default","tag":"PlantPredict","count":248},{"language":"default","tag":"API \u0026 SDK","count":122},{"language":"default","tag":"API Reference","count":115},{"language":"default","tag":"Models \u0026 Algorithms","count":66},{"language":"default","tag":"User Guide","count":62},{"language":"default","tag":"Version 11","count":40},{"language":"default","tag":"User Interface","count":37},{"language":"default","tag":"1. Irradiance Calculation","count":36},{"language":"default","tag":"Version 12","count":36}]},"assistantConfig":{"enableStarterQuestions":true,"deflection":{"enabled":true,"email":"support@plantpredict.com"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6a7f91873c58081693a6b2bf","deploymentId":"68def69020f53d6d18a22d89","questionText":"What is nodal data?","status":"active","generatedBy":"manual","createdAt":"2026-08-14T22:07:03.879Z","updatedAt":"2026-08-14T22:07:03.879Z","__v":0},{"_id":"6a7f91823c58081693a6b25b","deploymentId":"68def69020f53d6d18a22d89","questionText":"How do I create a 3D shade scene?","status":"active","generatedBy":"manual","createdAt":"2026-08-14T22:06:58.200Z","updatedAt":"2026-08-14T22:06:58.200Z","__v":0},{"_id":"6a7f917b3c58081693a6b1f9","deploymentId":"68def69020f53d6d18a22d89","questionText":"How can I run a sub-hourly prediction?","status":"active","generatedBy":"manual","createdAt":"2026-08-14T22:06:51.302Z","updatedAt":"2026-08-14T22:06:51.302Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"styles/custom.css","content":".katex-display{overflow-y:hidden!important}.katex-display>.katex{overflow-y:hidden!important}.katex-display::-webkit-scrollbar{display:none!important;width:0!important;height:0!important}.katex-display{-ms-overflow-style:none!important;scrollbar-width:none!important}"},{"filePath":"style.css","content":".card{border:2px solid #1b3359!important;box-shadow:0 4px 12px rgba(27, 51, 89, 0.15)!important;transition:box-shadow 0.2s ease, transform 0.2s ease!important}.card:hover{box-shadow:0 8px 24px rgba(27, 51, 89, 0.25)!important;transform:translateY(-2px)!important}@media (min-width: 1024px){#sidebar{display:flex!important}}.pricing-desc{color:oklch(37.3% .034 259.733)}.dark .pricing-desc{color:oklch(87.2% .01 258.338)!important}.pricing-page-marker{display:none}#content:has(>.pricing-page-marker){max-width:none!important}#content-area:has(.pricing-page-marker){max-width:calc(36rem + 300px)!important}@media (min-width: 1536px){#content-area:has(.pricing-page-marker){max-width:calc(42rem + 150px)!important}}.landing-desc{color:oklch(37.3% .034 259.733);opacity:0.8}.dark .landing-desc{color:oklch(87.2% .01 258.338)!important}"}],"page":{"pagePath":"api-reference/company/get-company-default-settings","slug":"/api-reference/company/get-company-default-settings","pageMetadata":{"title":"Get company default settings","description":"Returns default settings for your company.","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Company/DefaultSettings","href":"/api-reference/company/get-company-default-settings","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns default settings for your company.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get company default settings","description":"Returns default settings for your company.","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Company/DefaultSettings","href":"/api-reference/company/get-company-default-settings","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Company"],"summary":"Get company default settings","description":"Returns default settings for your company.","operationId":"getCompanyDefaultSettings","x-doc-source":"postman","responses":{"200":"d0669b35-5b8c-4cc7-9c9d-a41d9b623c88","401":"8c1073c3-e1a6-463a-8848-21e4088a74d6","500":"18274088-7c1f-4237-9fe9-069bbf0fb032"},"method":"get","type":"path","servers":["0326022f-84c8-4719-a04b-ce3dd0760239"],"security":["9994906a-351a-473d-bbaa-0f0494dd42d1"],"path":"/Company/DefaultSettings","baseUrlOptions":["https://api.plantpredict.terabase.energy"],"title":"Get company default settings","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"d0669b35-5b8c-4cc7-9c9d-a41d9b623c88":{"description":"Default settings","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"id","typeLabel":"integer"},"environmentalConditions":{"type":"object","description":"The Environmental Conditions Page allows you to configure the weather and environmental parameters that influence solar resource modeling in your prediction. This includes selecting weather data, defining soiling and spectral loss profiles, setting design temperatures, and importing horizon scene data.","x-doc-source":"inferred+docs:user-guide/ui/environmental-conditions.mdx","properties":{"id":{"type":"integer","uniqueKey":"environmentalConditions.id","typeLabel":"integer"},"monthlySoilingLoss":{"type":"number","uniqueKey":"environmentalConditions.monthlySoilingLoss","typeLabel":"number"},"monthlyAlbedo":{"type":"number","uniqueKey":"environmentalConditions.monthlyAlbedo","typeLabel":"number"}},"uniqueKey":"environmentalConditions","typeLabel":"object"},"powerPlantBuilder":{"type":"object","description":"The 3D View provides tools for analyzing terrain and racking placement within your map-based power plant design. This interface enables terrain slope analysis, table slope constraint identification, and post height calculations.","x-doc-source":"inferred+docs:user-guide/ui/power-plant-builder-3d-view.mdx","properties":{"id":{"type":"integer","uniqueKey":"powerPlantBuilder.id","typeLabel":"integer"},"acCollectionLoss":{"type":"number","uniqueKey":"powerPlantBuilder.acCollectionLoss","typeLabel":"number"},"dasLoad":{"type":"number","uniqueKey":"powerPlantBuilder.dasLoad","typeLabel":"number"},"coolingLoad":{"type":"number","uniqueKey":"powerPlantBuilder.coolingLoad","typeLabel":"number"},"transformerHighSideVoltage":{"type":"number","uniqueKey":"powerPlantBuilder.transformerHighSideVoltage","typeLabel":"number"},"transformerNoLoadLoss":{"type":"number","uniqueKey":"powerPlantBuilder.transformerNoLoadLoss","typeLabel":"number"},"transformerFullLoadLoss":{"type":"number","uniqueKey":"powerPlantBuilder.transformerFullLoadLoss","typeLabel":"number"},"powerFactor":{"type":"number","uniqueKey":"powerPlantBuilder.powerFactor","typeLabel":"number"},"inverter":{"type":"object","properties":{"status":{"type":"integer","uniqueKey":"powerPlantBuilder.inverter.status","typeLabel":"integer"},"model":{"type":"string","uniqueKey":"powerPlantBuilder.inverter.model","typeLabel":"string"},"manufacturer":{"type":"string","uniqueKey":"powerPlantBuilder.inverter.manufacturer","typeLabel":"string"},"powerRated":{"type":"number","uniqueKey":"powerPlantBuilder.inverter.powerRated","typeLabel":"number"},"apparentPower":{"type":"number","uniqueKey":"powerPlantBuilder.inverter.apparentPower","typeLabel":"number"},"minDCPowerThreshold":{"type":"number","uniqueKey":"powerPlantBuilder.inverter.minDCPowerThreshold","typeLabel":"number"},"minVoltage":{"type":"number","uniqueKey":"powerPlantBuilder.inverter.minVoltage","typeLabel":"number"},"maxMPPVoltage":{"type":"number","uniqueKey":"powerPlantBuilder.inverter.maxMPPVoltage","typeLabel":"number"},"maxAbsoluteVoltage":{"type":"number","uniqueKey":"powerPlantBuilder.inverter.maxAbsoluteVoltage","typeLabel":"number"},"maxCurrent":{"type":"number","uniqueKey":"powerPlantBuilder.inverter.maxCurrent","typeLabel":"number"},"maxElevation":{"type":"number","uniqueKey":"powerPlantBuilder.inverter.maxElevation","typeLabel":"number"},"outputVoltage":{"type":"number","uniqueKey":"powerPlantBuilder.inverter.outputVoltage","typeLabel":"number"},"usekVACurves":{"type":"boolean","uniqueKey":"powerPlantBuilder.inverter.usekVACurves","typeLabel":"boolean"},"usePQCurves":{"type":"boolean","uniqueKey":"powerPlantBuilder.inverter.usePQCurves","typeLabel":"boolean"},"dataSource":{"type":"integer","uniqueKey":"powerPlantBuilder.inverter.dataSource","typeLabel":"integer"},"efficiencyCurves":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.inverter.efficiencyCurves","typeLabel":"any"},"kVACurves":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.inverter.kVACurves","typeLabel":"any"},"pqCurves":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.inverter.pqCurves","typeLabel":"any"},"inverterType":{"type":"integer","uniqueKey":"powerPlantBuilder.inverter.inverterType","typeLabel":"integer"},"id":{"type":"integer","uniqueKey":"powerPlantBuilder.inverter.id","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"powerPlantBuilder.inverter.name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"powerPlantBuilder.inverter.description","typeLabel":"string"},"companyId":{"type":"integer","uniqueKey":"powerPlantBuilder.inverter.companyId","typeLabel":"integer"},"company":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.inverter.company","typeLabel":"any"},"ownerId":{"type":"integer","uniqueKey":"powerPlantBuilder.inverter.ownerId","typeLabel":"integer"},"owner":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.inverter.owner","typeLabel":"any"},"createdDate":{"type":"string","description":"ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset.","uniqueKey":"powerPlantBuilder.inverter.createdDate","typeLabel":"string"},"lastModified":{"type":"string","description":"ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset.","uniqueKey":"powerPlantBuilder.inverter.lastModified","typeLabel":"string"},"lastModifiedById":{"type":"integer","uniqueKey":"powerPlantBuilder.inverter.lastModifiedById","typeLabel":"integer"},"lastModifiedBy":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.inverter.lastModifiedBy","typeLabel":"any"}},"uniqueKey":"powerPlantBuilder.inverter","typeLabel":"object"},"inverter_Id":{"type":"integer","uniqueKey":"powerPlantBuilder.inverter_Id","typeLabel":"integer"},"dcacRatio":{"type":"number","uniqueKey":"powerPlantBuilder.dcacRatio","typeLabel":"number"},"dcWiringLossAtSTC":{"type":"number","uniqueKey":"powerPlantBuilder.dcWiringLossAtSTC","typeLabel":"number"},"dcHealth":{"type":"number","uniqueKey":"powerPlantBuilder.dcHealth","typeLabel":"number"},"trackerLoadLoss":{"type":"number","uniqueKey":"powerPlantBuilder.trackerLoadLoss","typeLabel":"number"},"minimumTrackingLimitAngleD":{"type":"number","uniqueKey":"powerPlantBuilder.minimumTrackingLimitAngleD","typeLabel":"number"},"maximumTrackingLimitAngleD":{"type":"number","uniqueKey":"powerPlantBuilder.maximumTrackingLimitAngleD","typeLabel":"number"},"structureShading":{"type":"number","uniqueKey":"powerPlantBuilder.structureShading","typeLabel":"number"},"module_Id":{"type":"integer","uniqueKey":"powerPlantBuilder.module_Id","typeLabel":"integer"},"module":{"type":"object","properties":{"status":{"type":"integer","uniqueKey":"powerPlantBuilder.module.status","typeLabel":"integer"},"model":{"type":"string","uniqueKey":"powerPlantBuilder.module.model","typeLabel":"string"},"manufacturer":{"type":"string","uniqueKey":"powerPlantBuilder.module.manufacturer","typeLabel":"string"},"length":{"type":"number","uniqueKey":"powerPlantBuilder.module.length","typeLabel":"number"},"width":{"type":"number","uniqueKey":"powerPlantBuilder.module.width","typeLabel":"number"},"weight":{"type":"number","uniqueKey":"powerPlantBuilder.module.weight","typeLabel":"number"},"defaultOrientation":{"type":"integer","uniqueKey":"powerPlantBuilder.module.defaultOrientation","typeLabel":"integer"},"numberOfCellsInSeries":{"type":"integer","uniqueKey":"powerPlantBuilder.module.numberOfCellsInSeries","typeLabel":"integer"},"numberOfCellsInParallel":{"type":"integer","uniqueKey":"powerPlantBuilder.module.numberOfCellsInParallel","typeLabel":"integer"},"stcShortCircuitCurrent":{"type":"number","uniqueKey":"powerPlantBuilder.module.stcShortCircuitCurrent","typeLabel":"number"},"stcOpenCircuitVoltage":{"type":"number","uniqueKey":"powerPlantBuilder.module.stcOpenCircuitVoltage","typeLabel":"number"},"stcmppCurrent":{"type":"number","uniqueKey":"powerPlantBuilder.module.stcmppCurrent","typeLabel":"number"},"stcmppVoltage":{"type":"number","uniqueKey":"powerPlantBuilder.module.stcmppVoltage","typeLabel":"number"},"stcMaxPower":{"type":"number","uniqueKey":"powerPlantBuilder.module.stcMaxPower","typeLabel":"number"},"stcPowerTempCoef":{"type":"number","uniqueKey":"powerPlantBuilder.module.stcPowerTempCoef","typeLabel":"number"},"stcShortCircuitCurrentTempCoef":{"type":"number","uniqueKey":"powerPlantBuilder.module.stcShortCircuitCurrentTempCoef","typeLabel":"number"},"stcOpenCircuitVoltageTempCoef":{"type":"number","uniqueKey":"powerPlantBuilder.module.stcOpenCircuitVoltageTempCoef","typeLabel":"number"},"stcEfficiency":{"type":"number","uniqueKey":"powerPlantBuilder.module.stcEfficiency","typeLabel":"number"},"minTolerance":{"type":"number","uniqueKey":"powerPlantBuilder.module.minTolerance","typeLabel":"number"},"maxTolerance":{"type":"number","uniqueKey":"powerPlantBuilder.module.maxTolerance","typeLabel":"number"},"cellTechnologyType":{"type":"integer","uniqueKey":"powerPlantBuilder.module.cellTechnologyType","typeLabel":"integer"},"constructionType":{"type":"integer","uniqueKey":"powerPlantBuilder.module.constructionType","typeLabel":"integer"},"faciality":{"type":"integer","uniqueKey":"powerPlantBuilder.module.faciality","typeLabel":"integer"},"bifacialityFactor":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.bifacialityFactor","typeLabel":"any"},"transmissionFactor":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.transmissionFactor","typeLabel":"any"},"backSideMismatch":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.backSideMismatch","typeLabel":"any"},"dataSource":{"type":"integer","uniqueKey":"powerPlantBuilder.module.dataSource","typeLabel":"integer"},"lightInducedDegradation":{"type":"number","uniqueKey":"powerPlantBuilder.module.lightInducedDegradation","typeLabel":"number"},"moduleQuality":{"type":"number","uniqueKey":"powerPlantBuilder.module.moduleQuality","typeLabel":"number"},"moduleMismatchCoefficient":{"type":"number","uniqueKey":"powerPlantBuilder.module.moduleMismatchCoefficient","typeLabel":"number"},"heatBalanceConvectiveCoef":{"type":"number","uniqueKey":"powerPlantBuilder.module.heatBalanceConvectiveCoef","typeLabel":"number"},"heatBalanceConductiveCoef":{"type":"number","uniqueKey":"powerPlantBuilder.module.heatBalanceConductiveCoef","typeLabel":"number"},"sandiaConductiveCoef":{"type":"number","uniqueKey":"powerPlantBuilder.module.sandiaConductiveCoef","typeLabel":"number"},"sandiaConvectiveCoef":{"type":"number","uniqueKey":"powerPlantBuilder.module.sandiaConvectiveCoef","typeLabel":"number"},"cellToModuleTempDiff":{"type":"number","uniqueKey":"powerPlantBuilder.module.cellToModuleTempDiff","typeLabel":"number"},"saturationCurrentAtSTC":{"type":"number","uniqueKey":"powerPlantBuilder.module.saturationCurrentAtSTC","typeLabel":"number"},"seriesResistanceAtSTC":{"type":"number","uniqueKey":"powerPlantBuilder.module.seriesResistanceAtSTC","typeLabel":"number"},"shuntResistanceAtSTC":{"type":"number","uniqueKey":"powerPlantBuilder.module.shuntResistanceAtSTC","typeLabel":"number"},"diodeIdealityFactorAtSTC":{"type":"number","uniqueKey":"powerPlantBuilder.module.diodeIdealityFactorAtSTC","typeLabel":"number"},"exponentialDependencyOnShuntResistance":{"type":"number","uniqueKey":"powerPlantBuilder.module.exponentialDependencyOnShuntResistance","typeLabel":"number"},"darkShuntResistance":{"type":"number","uniqueKey":"powerPlantBuilder.module.darkShuntResistance","typeLabel":"number"},"linearTempDependenceOnGamma":{"type":"number","uniqueKey":"powerPlantBuilder.module.linearTempDependenceOnGamma","typeLabel":"number"},"shortCircuitCurrentAtSTC":{"type":"number","uniqueKey":"powerPlantBuilder.module.shortCircuitCurrentAtSTC","typeLabel":"number"},"recombinationParameter":{"type":"number","uniqueKey":"powerPlantBuilder.module.recombinationParameter","typeLabel":"number"},"builtInVoltage":{"type":"number","uniqueKey":"powerPlantBuilder.module.builtInVoltage","typeLabel":"number"},"bandgapVoltage":{"type":"number","uniqueKey":"powerPlantBuilder.module.bandgapVoltage","typeLabel":"number"},"linearTempDependenceOnIsc":{"type":"number","uniqueKey":"powerPlantBuilder.module.linearTempDependenceOnIsc","typeLabel":"number"},"heatAbsorptionCoefAlphaT":{"type":"number","uniqueKey":"powerPlantBuilder.module.heatAbsorptionCoefAlphaT","typeLabel":"number"},"referenceIrradiance":{"type":"number","uniqueKey":"powerPlantBuilder.module.referenceIrradiance","typeLabel":"number"},"referenceTemperature":{"type":"number","uniqueKey":"powerPlantBuilder.module.referenceTemperature","typeLabel":"number"},"aGamma":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.aGamma","typeLabel":"any"},"bGamma":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.bGamma","typeLabel":"any"},"cGamma":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.cGamma","typeLabel":"any"},"dGamma":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.dGamma","typeLabel":"any"},"spectralResponse":{"type":"integer","uniqueKey":"powerPlantBuilder.module.spectralResponse","typeLabel":"integer"},"pvModel":{"type":"integer","uniqueKey":"powerPlantBuilder.module.pvModel","typeLabel":"integer"},"useDefaultSandiaIAM":{"type":"boolean","uniqueKey":"powerPlantBuilder.module.useDefaultSandiaIAM","typeLabel":"boolean"},"useDefaultTabularIAM":{"type":"boolean","uniqueKey":"powerPlantBuilder.module.useDefaultTabularIAM","typeLabel":"boolean"},"sandiaSpectralA0":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.sandiaSpectralA0","typeLabel":"any"},"sandiaSpectralA1":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.sandiaSpectralA1","typeLabel":"any"},"sandiaSpectralA2":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.sandiaSpectralA2","typeLabel":"any"},"sandiaSpectralA3":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.sandiaSpectralA3","typeLabel":"any"},"sandiaSpectralA4":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.sandiaSpectralA4","typeLabel":"any"},"sandiaIAMB0":{"type":"number","uniqueKey":"powerPlantBuilder.module.sandiaIAMB0","typeLabel":"number"},"sandiaIAMB1":{"type":"number","uniqueKey":"powerPlantBuilder.module.sandiaIAMB1","typeLabel":"number"},"sandiaIAMB2":{"type":"number","uniqueKey":"powerPlantBuilder.module.sandiaIAMB2","typeLabel":"number"},"sandiaIAMB3":{"type":"number","uniqueKey":"powerPlantBuilder.module.sandiaIAMB3","typeLabel":"number"},"sandiaIAMB4":{"type":"number","uniqueKey":"powerPlantBuilder.module.sandiaIAMB4","typeLabel":"number"},"sandiaIAMB5":{"type":"number","uniqueKey":"powerPlantBuilder.module.sandiaIAMB5","typeLabel":"number"},"ashraeiamB0":{"type":"number","uniqueKey":"powerPlantBuilder.module.ashraeiamB0","typeLabel":"number"},"spectral2B0":{"type":"number","uniqueKey":"powerPlantBuilder.module.spectral2B0","typeLabel":"number"},"spectral2B1":{"type":"number","uniqueKey":"powerPlantBuilder.module.spectral2B1","typeLabel":"number"},"spectral2B2":{"type":"number","uniqueKey":"powerPlantBuilder.module.spectral2B2","typeLabel":"number"},"spectral2B3":{"type":"number","uniqueKey":"powerPlantBuilder.module.spectral2B3","typeLabel":"number"},"spectral2B4":{"type":"number","uniqueKey":"powerPlantBuilder.module.spectral2B4","typeLabel":"number"},"spectral2B5":{"type":"number","uniqueKey":"powerPlantBuilder.module.spectral2B5","typeLabel":"number"},"iamFactors":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.iamFactors","typeLabel":"any"},"degradationModel":{"type":"integer","uniqueKey":"powerPlantBuilder.module.degradationModel","typeLabel":"integer"},"linearDegradationRate":{"type":"number","uniqueKey":"powerPlantBuilder.module.linearDegradationRate","typeLabel":"number"},"nonLinearDegradationRates":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.nonLinearDegradationRates","typeLabel":"any"},"cellDesignType":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.cellDesignType","typeLabel":"any"},"useAntiReflectiveCoating":{"type":"boolean","uniqueKey":"powerPlantBuilder.module.useAntiReflectiveCoating","typeLabel":"boolean"},"refractiveIndex":{"type":"number","uniqueKey":"powerPlantBuilder.module.refractiveIndex","typeLabel":"number"},"refractiveIndexOfARC":{"type":"number","uniqueKey":"powerPlantBuilder.module.refractiveIndexOfARC","typeLabel":"number"},"glazingExtinctionCoef":{"type":"number","uniqueKey":"powerPlantBuilder.module.glazingExtinctionCoef","typeLabel":"number"},"glazingThickness":{"type":"number","uniqueKey":"powerPlantBuilder.module.glazingThickness","typeLabel":"number"},"powerAtSTC":{"type":"number","uniqueKey":"powerPlantBuilder.module.powerAtSTC","typeLabel":"number"},"powerAtSTCExcludingWiringLosses":{"type":"number","uniqueKey":"powerPlantBuilder.module.powerAtSTCExcludingWiringLosses","typeLabel":"number"},"effectiveIrradianceResponse":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.effectiveIrradianceResponse","typeLabel":"any"},"electricalShadingFractionalEffect":{"type":"number","uniqueKey":"powerPlantBuilder.module.electricalShadingFractionalEffect","typeLabel":"number"},"moduleShadingResponse":{"type":"integer","uniqueKey":"powerPlantBuilder.module.moduleShadingResponse","typeLabel":"integer"},"isMetastable":{"type":"boolean","uniqueKey":"powerPlantBuilder.module.isMetastable","typeLabel":"boolean"},"metastabilityProperties":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.metastabilityProperties","typeLabel":"any"},"id":{"type":"integer","uniqueKey":"powerPlantBuilder.module.id","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"powerPlantBuilder.module.name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"powerPlantBuilder.module.description","typeLabel":"string"},"companyId":{"type":"integer","uniqueKey":"powerPlantBuilder.module.companyId","typeLabel":"integer"},"company":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.company","typeLabel":"any"},"ownerId":{"type":"integer","uniqueKey":"powerPlantBuilder.module.ownerId","typeLabel":"integer"},"owner":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.owner","typeLabel":"any"},"createdDate":{"type":"string","description":"ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset.","uniqueKey":"powerPlantBuilder.module.createdDate","typeLabel":"string"},"lastModified":{"type":"string","description":"ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset.","uniqueKey":"powerPlantBuilder.module.lastModified","typeLabel":"string"},"lastModifiedById":{"type":"integer","uniqueKey":"powerPlantBuilder.module.lastModifiedById","typeLabel":"integer"},"lastModifiedBy":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"powerPlantBuilder.module.lastModifiedBy","typeLabel":"any"}},"uniqueKey":"powerPlantBuilder.module","typeLabel":"object"},"dcFieldTrackingTypeEnum":{"type":"integer","uniqueKey":"powerPlantBuilder.dcFieldTrackingTypeEnum","typeLabel":"integer"},"tiltAngle":{"type":"number","uniqueKey":"powerPlantBuilder.tiltAngle","typeLabel":"number"},"gcr":{"type":"number","uniqueKey":"powerPlantBuilder.gcr","typeLabel":"number"},"northernHemisphereAzimuth":{"type":"number","uniqueKey":"powerPlantBuilder.northernHemisphereAzimuth","typeLabel":"number"},"southernHemisphereAzimuth":{"type":"number","uniqueKey":"powerPlantBuilder.southernHemisphereAzimuth","typeLabel":"number"},"azimuth":{"type":"number","uniqueKey":"powerPlantBuilder.azimuth","typeLabel":"number"},"irradianceOptimization":{"type":"boolean","uniqueKey":"powerPlantBuilder.irradianceOptimization","typeLabel":"boolean"},"irradianceOptimizationType":{"type":"integer","uniqueKey":"powerPlantBuilder.irradianceOptimizationType","typeLabel":"integer"},"rotationSpeed":{"type":"number","uniqueKey":"powerPlantBuilder.rotationSpeed","typeLabel":"number"},"nonIdealityFactor":{"type":"number","uniqueKey":"powerPlantBuilder.nonIdealityFactor","typeLabel":"number"},"postHeightCalculationMethod":{"type":"integer","uniqueKey":"powerPlantBuilder.postHeightCalculationMethod","typeLabel":"integer"},"postHeight":{"type":"number","uniqueKey":"powerPlantBuilder.postHeight","typeLabel":"number"},"modTempModel":{"type":"integer","uniqueKey":"powerPlantBuilder.modTempModel","typeLabel":"integer"},"mapBuilderCreateDCAs":{"type":"integer","uniqueKey":"powerPlantBuilder.mapBuilderCreateDCAs","typeLabel":"integer"},"shadingAlgorithm":{"type":"integer","uniqueKey":"powerPlantBuilder.shadingAlgorithm","typeLabel":"integer"},"setback":{"type":"number","uniqueKey":"powerPlantBuilder.setback","typeLabel":"number"},"northSouthRoadWidth":{"type":"number","uniqueKey":"powerPlantBuilder.northSouthRoadWidth","typeLabel":"number"},"eastWestRoadWidth":{"type":"number","uniqueKey":"powerPlantBuilder.eastWestRoadWidth","typeLabel":"number"}},"uniqueKey":"powerPlantBuilder","typeLabel":"object"},"simulationSettings":{"type":"object","description":"The Simulation Settings page allows you to configure the prediction timeframe and select the sub-models used for irradiance calculation, module performance, shading analysis, and degradation. These settings control the algorithms applied during the energy prediction simulation.","x-doc-source":"inferred+docs:user-guide/ui/simulation-settings.mdx","properties":{"id":{"type":"integer","uniqueKey":"simulationSettings.id","typeLabel":"integer"},"errorModelAcc":{"type":"number","uniqueKey":"simulationSettings.errorModelAcc","typeLabel":"number"},"errorSensAcc":{"type":"number","uniqueKey":"simulationSettings.errorSensAcc","typeLabel":"number"},"errorIntAnnVar":{"type":"number","uniqueKey":"simulationSettings.errorIntAnnVar","typeLabel":"number"},"errorMonAcc":{"type":"number","uniqueKey":"simulationSettings.errorMonAcc","typeLabel":"number"},"errorSpaVar":{"type":"number","uniqueKey":"simulationSettings.errorSpaVar","typeLabel":"number"},"transpositionModel":{"type":"integer","uniqueKey":"simulationSettings.transpositionModel","typeLabel":"integer"},"diffuseDirectDecompModel":{"type":"integer","uniqueKey":"simulationSettings.diffuseDirectDecompModel","typeLabel":"integer"},"useMeteoDni":{"type":"boolean","uniqueKey":"simulationSettings.useMeteoDni","typeLabel":"boolean"},"airMassModel":{"type":"integer","uniqueKey":"simulationSettings.airMassModel","typeLabel":"integer"},"soilingModel":{"type":"integer","uniqueKey":"simulationSettings.soilingModel","typeLabel":"integer"},"modTempModel":{"type":"integer","uniqueKey":"simulationSettings.modTempModel","typeLabel":"integer"},"spectralShiftModel":{"type":"integer","uniqueKey":"simulationSettings.spectralShiftModel","typeLabel":"integer"},"incAngleModel":{"type":"integer","uniqueKey":"simulationSettings.incAngleModel","typeLabel":"integer"},"directBeamShadingModel":{"type":"integer","uniqueKey":"simulationSettings.directBeamShadingModel","typeLabel":"integer"},"degradationModel":{"type":"integer","uniqueKey":"simulationSettings.degradationModel","typeLabel":"integer"},"diffuseShadingModel":{"type":"integer","uniqueKey":"simulationSettings.diffuseShadingModel","typeLabel":"integer"},"defaultDegradation":{"type":"integer","uniqueKey":"simulationSettings.defaultDegradation","typeLabel":"integer"},"circumsolarTreatment":{"type":"integer","uniqueKey":"simulationSettings.circumsolarTreatment","typeLabel":"integer"},"linearDegradationRate":{"type":"number","uniqueKey":"simulationSettings.linearDegradationRate","typeLabel":"number"},"firstYearDegradation":{"type":"boolean","uniqueKey":"simulationSettings.firstYearDegradation","typeLabel":"boolean"}},"uniqueKey":"simulationSettings","typeLabel":"object"},"weatherAPISettings":{"type":"object","description":"The Add New Weather page provides three methods for adding weather data to PlantPredict:","x-doc-source":"inferred+docs:user-guide/ui/add-new-weather.mdx","properties":{"id":{"type":"integer","uniqueKey":"weatherAPISettings.id","typeLabel":"integer"},"meteonormSettings":{"type":"object","properties":{"key":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"weatherAPISettings.meteonormSettings.key","typeLabel":"any"}},"uniqueKey":"weatherAPISettings.meteonormSettings","typeLabel":"object"},"cprSettings":{"type":"object","properties":{"apiKey":{"type":"string","uniqueKey":"weatherAPISettings.cprSettings.apiKey","typeLabel":"string"},"userName":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"weatherAPISettings.cprSettings.userName","typeLabel":"any"},"password":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"weatherAPISettings.cprSettings.password","typeLabel":"any"},"licenseNumber":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"weatherAPISettings.cprSettings.licenseNumber","typeLabel":"any"}},"uniqueKey":"weatherAPISettings.cprSettings","typeLabel":"object"},"solarGISSettings":{"type":"object","properties":{"key":{"type":"string","uniqueKey":"weatherAPISettings.solarGISSettings.key","typeLabel":"string"},"tmyKey":{"type":"string","uniqueKey":"weatherAPISettings.solarGISSettings.tmyKey","typeLabel":"string"},"version":{"type":"integer","uniqueKey":"weatherAPISettings.solarGISSettings.version","typeLabel":"integer"}},"uniqueKey":"weatherAPISettings.solarGISSettings","typeLabel":"object"},"arrayTechnologiesAPIKey":{"type":"string","uniqueKey":"weatherAPISettings.arrayTechnologiesAPIKey","typeLabel":"string"}},"uniqueKey":"weatherAPISettings","typeLabel":"object"},"essSettings":{"type":"object","description":"The Energy Storage System page allows you to configure an optional AC-coupled battery energy storage system (BESS) for your prediction. To enable energy storage, enter a Nameplate capacity value (input #1) and an Inverter Real Power rating (input #9). The Dispatch Algorithm should also be configured to ensure the...","x-doc-source":"inferred+docs:user-guide/ui/energy-storage-system.mdx","properties":{"id":{"type":"integer","uniqueKey":"essSettings.id","typeLabel":"integer"},"factor":{"type":"number","uniqueKey":"essSettings.factor","typeLabel":"number"},"usableEnergyCapacityCalendarDeg":{"type":"number","uniqueKey":"essSettings.usableEnergyCapacityCalendarDeg","typeLabel":"number"},"usableEnergyCapacityCycleDeg":{"type":"number","uniqueKey":"essSettings.usableEnergyCapacityCycleDeg","typeLabel":"number"},"roundtripDCEfficiencyYear1":{"type":"number","uniqueKey":"essSettings.roundtripDCEfficiencyYear1","typeLabel":"number"},"roundtripDCEfficiencyCalendarDeg":{"type":"number","uniqueKey":"essSettings.roundtripDCEfficiencyCalendarDeg","typeLabel":"number"},"roundtripDCEfficiencyCycleDeg":{"type":"number","uniqueKey":"essSettings.roundtripDCEfficiencyCycleDeg","typeLabel":"number"},"hvacNoLoadLoss":{"type":"number","uniqueKey":"essSettings.hvacNoLoadLoss","typeLabel":"number"},"hvacFullLoadLoss":{"type":"number","uniqueKey":"essSettings.hvacFullLoadLoss","typeLabel":"number"},"mvNoLoadLoss":{"type":"number","uniqueKey":"essSettings.mvNoLoadLoss","typeLabel":"number"},"mvFullLoadLoss":{"type":"number","uniqueKey":"essSettings.mvFullLoadLoss","typeLabel":"number"},"mvCapacity":{"description":"Observed as null in test-account samples; the field's actual type is undocumented. Re-run the typing probe against an account where this field is populated to refine.","uniqueKey":"essSettings.mvCapacity","typeLabel":"any"},"inverterEfficiency":{"type":"number","uniqueKey":"essSettings.inverterEfficiency","typeLabel":"number"},"chargeAlgorithm":{"type":"integer","uniqueKey":"essSettings.chargeAlgorithm","typeLabel":"integer"}},"uniqueKey":"essSettings","typeLabel":"object"},"financialModelParameters":{"type":"object","x-doc-source":"inferred","properties":{"id":{"type":"integer","uniqueKey":"financialModelParameters.id","typeLabel":"integer"},"bosInput":{"type":"number","uniqueKey":"financialModelParameters.bosInput","typeLabel":"number"},"developmentCostPerWatt":{"type":"number","uniqueKey":"financialModelParameters.developmentCostPerWatt","typeLabel":"number"},"moduleCostPerWatt":{"type":"number","uniqueKey":"financialModelParameters.moduleCostPerWatt","typeLabel":"number"},"itcPercentage":{"type":"number","uniqueKey":"financialModelParameters.itcPercentage","typeLabel":"number"},"yearOneEnergyAdjustmentPercentage":{"type":"number","uniqueKey":"financialModelParameters.yearOneEnergyAdjustmentPercentage","typeLabel":"number"},"ppaPrice":{"type":"number","uniqueKey":"financialModelParameters.ppaPrice","typeLabel":"number"},"ppaEscalatorPercentage":{"type":"number","uniqueKey":"financialModelParameters.ppaEscalatorPercentage","typeLabel":"number"},"omYearOne":{"type":"number","uniqueKey":"financialModelParameters.omYearOne","typeLabel":"number"},"omYearlyEscalatorPercentage":{"type":"number","uniqueKey":"financialModelParameters.omYearlyEscalatorPercentage","typeLabel":"number"},"ppaDuration":{"type":"integer","uniqueKey":"financialModelParameters.ppaDuration","typeLabel":"integer"},"postPPAPrice":{"type":"number","uniqueKey":"financialModelParameters.postPPAPrice","typeLabel":"number"},"postPPAPriceEscalationPercentage":{"type":"number","uniqueKey":"financialModelParameters.postPPAPriceEscalationPercentage","typeLabel":"number"},"projectLife":{"type":"integer","uniqueKey":"financialModelParameters.projectLife","typeLabel":"integer"},"discountNPVPercentage":{"type":"number","uniqueKey":"financialModelParameters.discountNPVPercentage","typeLabel":"number"},"itcEligibilityPercentage":{"type":"number","uniqueKey":"financialModelParameters.itcEligibilityPercentage","typeLabel":"number"},"solarSalvageValuePercentage":{"type":"number","uniqueKey":"financialModelParameters.solarSalvageValuePercentage","typeLabel":"number"},"insuranceCapitalCostPercentage":{"type":"number","uniqueKey":"financialModelParameters.insuranceCapitalCostPercentage","typeLabel":"number"},"insuranceEscalatorPerYearPercentage":{"type":"number","uniqueKey":"financialModelParameters.insuranceEscalatorPerYearPercentage","typeLabel":"number"},"bonusDepreciationRate":{"type":"number","uniqueKey":"financialModelParameters.bonusDepreciationRate","typeLabel":"number"},"stateTaxRate":{"type":"number","uniqueKey":"financialModelParameters.stateTaxRate","typeLabel":"number"},"federalTaxRate":{"type":"number","uniqueKey":"financialModelParameters.federalTaxRate","typeLabel":"number"},"solarLandLeaseCost":{"type":"number","uniqueKey":"financialModelParameters.solarLandLeaseCost","typeLabel":"number"},"solarLandLeaseEscalationPercentage":{"type":"number","uniqueKey":"financialModelParameters.solarLandLeaseEscalationPercentage","typeLabel":"number"},"solarPropertyTaxCost":{"type":"number","uniqueKey":"financialModelParameters.solarPropertyTaxCost","typeLabel":"number"},"solarPropertyTaxEscalationPercentage":{"type":"number","uniqueKey":"financialModelParameters.solarPropertyTaxEscalationPercentage","typeLabel":"number"}},"uniqueKey":"financialModelParameters","typeLabel":"object"},"miscellaneousSettings":{"type":"object","description":"The Simulation Settings page allows you to configure the prediction timeframe and select the sub-models used for irradiance calculation, module performance, shading analysis, and degradation. These settings control the algorithms applied during the energy prediction simulation.","x-doc-source":"inferred+docs:user-guide/ui/simulation-settings.mdx","properties":{"id":{"type":"integer","uniqueKey":"miscellaneousSettings.id","typeLabel":"integer"},"predictionStatus":{"type":"integer","uniqueKey":"miscellaneousSettings.predictionStatus","typeLabel":"integer"},"weatherStatus":{"type":"integer","uniqueKey":"miscellaneousSettings.weatherStatus","typeLabel":"integer"},"inverterStatus":{"type":"integer","uniqueKey":"miscellaneousSettings.inverterStatus","typeLabel":"integer"},"moduleStatus":{"type":"integer","uniqueKey":"miscellaneousSettings.moduleStatus","typeLabel":"integer"}},"uniqueKey":"miscellaneousSettings","typeLabel":"object"},"devPlatformSimulationSettings":{"type":"object","uniqueKey":"devPlatformSimulationSettings","typeLabel":"object"},"devPlatformSitePlanSettings":{"type":"object","uniqueKey":"devPlatformSitePlanSettings","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"postman-default-settings":{"title":"postman-default-settings","value":{"id":67,"environmentalConditions":{"id":190,"monthlySoilingLoss":2,"monthlyAlbedo":0.2},"powerPlantBuilder":{"acCollectionLoss":1,"dasLoad":800,"coolingLoad":0,"transformerHighSideVoltage":34.5,"transformerNoLoadLoss":0.2,"transformerFullLoadLoss":0.7,"powerFactor":1,"inverter_Id":8279,"dcacRatio":1.2,"dcWiringLossAtSTC":1.5,"dcHealth":1,"trackerLoadLoss":2.028,"minimumTrackingLimitAngleD":-60,"maximumTrackingLimitAngleD":60,"structureShading":5,"module_Id":224,"dcFieldTrackingTypeEnum":1,"dcFieldBacktrackingType":1,"tiltAngle":null,"gcr":40,"moduleOrientation":1,"azimuth":180,"modTempModel":0,"setback":6.5,"northSouthRoadWidth":6.096011996927617,"eastWestRoadWidth":6.096011996927617},"simulationSettings":{"errorModelAcc":2.9,"errorSensAcc":5,"errorIntAnnVar":3,"errorMonAcc":2,"errorSpaVar":2,"transpositionModel":1,"diffuseDirectDecompModel":3,"useMeteoDni":false,"airMassModel":0,"soilingModel":0,"modTempModel":0,"spectralShiftModel":2,"incAngleModel":5,"directBeamShadingModel":5,"degradationModel":0,"diffuseShadingModel":1,"defaultDegradation":0,"linearDegradationRate":0.5,"firstYearDegradation":false},"weatherAPISettings":{"meteonormSettings":{"key":null},"cprSettings":{"apiKey":"QVT203yOIhhGnAtr2l3riH#1cSTls8$BL9buGyD7EUxesR5Hp3Npovuwer$ZK1jB","userName":null,"password":null,"licenseNumber":null},"solarGISSettings":{"key":"Jc7PLhIgjjpnvffkN997","tmyKey":"dVH5NnxaWDlDLslwn1plNMk3AuMNnZMHZThy2Mn9xESplDNn3heTh2cM1RhQx4SLLM1BSnOVR3LTY31QzMd1kH112Ydd","version":2}},"essSettings":{"factor":0.9,"usableEnergyCapacityCalendarDeg":0.2,"usableEnergyCapacityCycleDeg":0.005,"roundtripDCEfficiencyYear1":95,"roundtripDCEfficiencyCalendarDeg":0.05,"roundtripDCEfficiencyCycleDeg":0.0002,"hvacNoLoadLoss":1.5,"hvacFullLoadLoss":10,"mvNoLoadLoss":0.2,"mvFullLoadLoss":0.7,"mvCapacity":null,"inverterEfficiency":97,"chargeAlgorithm":0},"financialModelParameters":{"bosInput":0.5,"developmentCostPerWatt":0.1,"moduleCostPerWatt":0.3,"itcPercentage":26,"yearOneEnergyAdjustmentPercentage":0,"ppaPrice":25,"ppaEscalatorPercentage":0,"omYearOne":3.5,"omYearlyEscalatorPercentage":2.5,"ppaDuration":20,"postPPAPrice":50,"postPPAPriceEscalationPercentage":2,"projectLife":35,"discountNPVPercentage":6,"itcEligibilityPercentage":100,"solarSalvageValuePercentage":5,"insuranceCapitalCostPercentage":0.15,"insuranceEscalatorPerYearPercentage":0,"bonusDepreciationRate":0,"stateTaxRate":6,"federalTaxRate":21,"solarLandLeaseCost":0,"solarLandLeaseEscalationPercentage":0,"solarPropertyTaxCost":0,"solarPropertyTaxEscalationPercentage":0},"miscellaneousSettings":{"predictionStatus":1},"devPlatformSimulationSettings":{"moduleType":1,"rackingSystem":1,"inverterType":1,"largeFormatModuleId":223,"shingledMonoPercId":221,"thinFilmId":130,"halfCellMonoPercId":4956,"bifacialId":11,"orientationTracker":0,"widthTracker":0.02,"heightTracker":0.02,"numOfPVModulesPerRowsTracker":3,"heightAboveGroundTracker":3,"pilesPerTableTracker":5,"pvModuleTiltMin":0,"pvModuleTiltMax":2,"tableAxisRotationMinTracker":-54,"tableAxisRotationMaxTracker":56,"enableBacktrackingTracker":false,"orientationMultistringTracker":0,"widthMultistringTracker":0.02,"maxWindSpeed":100,"motorTableGap":1.87,"gapBetweenTables":0.247,"heightAboveGroundStringTracker":0.247,"gapBetweenTrackers":0.3,"tableAxisRotationMinMultistringTracker":-54,"tableAxisRotationMaxMultistringTracker":56,"enableBacktrackingMultistringTracker":false,"orientationFixedTilt":0,"widthFixedTilt":0.02,"heightFixedTilt":0.02,"numOfPVModulesPerRowsFixedTilt":3,"heightAboveGroundFixedTilt":3,"pilesPerTableFixedTilt":7,"calculateModuleTiltAngle":false,"moduleTiltAngle":31,"inverterCentralId":739,"powerFactorCentral":2,"ocdpRatingCentral":320,"maxNumOfTablesPerColumnCentral":2,"inverterStringId":648,"powerFactorString":1,"ocdpRatingString":320,"maxNumOfTablesPerColumnString":5,"scenarioAnalysisDefault":1,"dcacMinimum":1,"dcacMaximum":2,"dcacInterval":1,"gcrMinimum":1,"gcrMaximum":2,"gcrInterval":1},"devPlatformSitePlanSettings":{"widthPerimeterRoad":666,"setbackFromSolarArrays":7.1,"setbackFromSiteBoundary":1.1,"widthInternalRoad":4,"setbackA":7.1,"setbackB":2,"setback":2,"widthLinearExclusion":51,"showLabels":false}}}},"exampleType":"examples"}},"exampleType":"examples"},"8c1073c3-e1a6-463a-8848-21e4088a74d6":{"description":"Missing or invalid bearer token. The response body is empty and no `Content-Type` header is set; the 401 status code is the only signal. Fetch a fresh token (see the **Authentication** section of the API description) and retry.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"18274088-7c1f-4237-9fe9-069bbf0fb032":{"description":"Unexpected server-side error. The body is usually a plain-text message\nbut its structure is not guaranteed — treat it as opaque diagnostic\ntext. Common causes: database constraint violation, downstream\nservice timeout, internal exception. Retry-safe for idempotent\nrequests; for non-idempotent ones, verify state before retrying.\n","content":{"text/plain":{"schema":{"type":"string","uniqueKey":"","typeLabel":"string"},"example":"An error has occurred.","examples":{"Example":{"title":"Example","value":"An error has occurred."}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"9994906a-351a-473d-bbaa-0f0494dd42d1":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Pass `Authorization: Bearer \u003ctoken>` on every request. See the **Authentication** section of the API description for how to fetch a token.","scopes":[]}}},"servers":{"0326022f-84c8-4719-a04b-ce3dd0760239":{"url":"https://api.plantpredict.terabase.energy","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Pass `Authorization: Bearer \u003ctoken>` on every request. See the **Authentication** section of the API description for how to fetch a token.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Pass `Authorization: Bearer \u003ctoken>` on every request. See the **Authentication** section of the API description for how to fetch a token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-docs/api-reference/plantpredict-api.yaml"},"subdomain":"terabaseenergy","siteName":"PlantPredict","title":"Get company default settings - PlantPredict","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-21T19:43:13.204Z","originalFileLocation":"api-reference/company/get-company-default-settings.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns default settings for your company.\">\u003cmeta data-mint-head name=\"application-name\" content=\"PlantPredict\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get company default settings - PlantPredict\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns default settings for your company.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PlantPredict\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.plantpredict.com/api-reference/company/get-company-default-settings\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://terabaseenergy.mintlify.site/_mintlify/api/og/v2?division=Company\u0026amp;title=Get+company+default+settings\u0026amp;description=Returns+default+settings+for+your+company.\u0026amp;theme=2b6fb3ebaa44c141d890c8c6\u0026amp;signature=4187f7bbd2c7f2b78ffb8b9b9ec8ec96db5ce999703edd711cedb8d42e8545c5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get company default settings - PlantPredict\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns default settings for your company.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://terabaseenergy.mintlify.site/_mintlify/api/og/v2?division=Company\u0026amp;title=Get+company+default+settings\u0026amp;description=Returns+default+settings+for+your+company.\u0026amp;theme=2b6fb3ebaa44c141d890c8c6\u0026amp;signature=4187f7bbd2c7f2b78ffb8b9b9ec8ec96db5ce999703edd711cedb8d42e8545c5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PlantPredict\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#086EC1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.plantpredict.com/api-reference/company/get-company-default-settings\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/company/get-company-default-settings.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.plantpredict.com/#organization\",\"name\":\"PlantPredict\",\"url\":\"https://docs.plantpredict.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/terabaseenergy/iiAvm3u0yaPPvDgU/logo/Terabase_PlantPredict_Primary_Logo_Full_Color.svg?fit=max\u0026auto=format\u0026n=iiAvm3u0yaPPvDgU\u0026q=85\u0026s=d951c2fe4058ac3998997d5ed958bfe9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.plantpredict.com#website\",\"name\":\"PlantPredict\",\"url\":\"https://docs.plantpredict.com\",\"publisher\":{\"@id\":\"https://docs.plantpredict.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.plantpredict.com/api-reference/company/get-company-default-settings#webpage\",\"url\":\"https://docs.plantpredict.com/api-reference/company/get-company-default-settings\",\"name\":\"Get company default settings\",\"description\":\"Returns default settings for your company.\",\"dateModified\":\"2026-08-21T19:43:13.204Z\",\"isPartOf\":{\"@id\":\"https://docs.plantpredict.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.plantpredict.com/api-reference/company/get-company-default-settings#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.plantpredict.com/api-reference/company/get-company-default-settings#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.plantpredict.com/api-reference/definitions/get-all-definitions-or-filter-by-enum-type\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get company default settings\",\"item\":\"https://docs.plantpredict.com/api-reference/company/get-company-default-settings\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.plantpredict.com/api-reference/company/get-company-default-settings#apireference\",\"headline\":\"Get company default settings\",\"name\":\"Get company default settings\",\"description\":\"Returns default settings for your company.\",\"url\":\"https://docs.plantpredict.com/api-reference/company/get-company-default-settings\",\"mainEntityOfPage\":{\"@id\":\"https://docs.plantpredict.com/api-reference/company/get-company-default-settings#webpage\"},\"dateModified\":\"2026-08-21T19:43:13.204Z\",\"publisher\":{\"@id\":\"https://docs.plantpredict.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.plantpredict.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PlantPredict\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"PlantPredict\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/company/get-company-default-settings.md","siteName":"PlantPredict","nav":{"global":null,"tabs":[{"tab":"Home","icon":"house"},{"tab":"PlantPredict","icon":"sun","menu":[{"item":"User Guide","pages":[{"title":"User Guide","href":"/user-guide/intro/introduction"}]},{"item":"Models \u0026 Algorithms","pages":[{"title":"Models \u0026 Algorithms","href":"/models/general/intro"}]},{"item":"API \u0026 SDK","groups":[{"group":"Introduction","icon":"book-open","pages":[{"title":" ","sidebarTitle":"Introduction","href":"/api-docs/intro"}]},{"group":"Quick Start Guides","icon":"gauge","pages":[{"title":"PlantPredict Performance API - Quick Start Guide","sidebarTitle":"Performance API","href":"/api-docs/api_quick_start_guide"},{"title":"PlantPredict Python SDK - Quick Start Guide","sidebarTitle":"Python SDK","href":"/api-docs/sdk_quick_start_guide"}]},{"group":"API Reference","icon":"code","pages":[{"group":"Definitions","pages":[{"title":"Get all definitions or filter by enum type","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Definitions","href":"/api-reference/definitions/get-all-definitions-or-filter-by-enum-type"}]},{"group":"Projects","pages":[{"title":"List projects (paginated)","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project","href":"/api-reference/projects/list-projects-paginated"},{"title":"Create a project","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project","href":"/api-reference/projects/create-a-project"},{"title":"Get current user's projects","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/My","href":"/api-reference/projects/get-current-users-projects"},{"title":"Get current user's projects including their predictions","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /ProjectsAndPredictions/My","href":"/api-reference/projects/get-current-users-projects-including-their-predictions"},{"title":"Search projects by geographic radius","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/Search","href":"/api-reference/projects/search-projects-by-geographic-radius"},{"title":"List projects filtered by status","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/ByStatus","href":"/api-reference/projects/list-projects-filtered-by-status"},{"title":"Change status of one or more projects","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/Status","href":"/api-reference/projects/change-status-of-one-or-more-projects"},{"title":"Import a PVsyst project from a ZIP export","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/Import/PVsyst","href":"/api-reference/projects/import-a-pvsyst-project-from-a-zip-export"},{"title":"Check the progress and outcome of a PVsyst import","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/Import/PVsyst/{jobId}","href":"/api-reference/projects/check-the-progress-and-outcome-of-a-pvsyst-import"},{"title":"Import a PVFARM project onto an existing prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/Import/PVFarm","href":"/api-reference/projects/import-a-pvfarm-project-onto-an-existing-prediction"},{"title":"Check the progress and outcome of a PVFARM import","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/Import/PVFarm/{jobId}","href":"/api-reference/projects/check-the-progress-and-outcome-of-a-pvfarm-import"},{"title":"Get a project by ID","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}","href":"/api-reference/projects/get-a-project-by-id"},{"title":"Delete a project","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml delete /Project/{projectId}","href":"/api-reference/projects/delete-a-project"},{"title":"Get project overview","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Overview","href":"/api-reference/projects/get-project-overview"},{"title":"Export a project","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Export","href":"/api-reference/projects/export-a-project"},{"title":"Get notes for a project","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Note","href":"/api-reference/projects/get-notes-for-a-project"},{"title":"Add a note to a project","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Note","href":"/api-reference/projects/add-a-note-to-a-project"},{"title":"Delete a project note","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml delete /Project/{projectId}/Note/{noteId}","href":"/api-reference/projects/delete-a-project-note"}]},{"group":"Predictions","pages":[{"title":"List predictions for a project","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction","href":"/api-reference/predictions/list-predictions-for-a-project"},{"title":"Update a prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Project/{projectId}/Prediction","href":"/api-reference/predictions/update-a-prediction"},{"title":"Create a prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction","href":"/api-reference/predictions/create-a-prediction"},{"title":"Get a prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}","href":"/api-reference/predictions/get-a-prediction"},{"title":"Delete a prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml delete /Project/{projectId}/Prediction/{predictionId}","href":"/api-reference/predictions/delete-a-prediction"},{"title":"Get prediction overview","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/Overview","href":"/api-reference/predictions/get-prediction-overview"},{"title":"Run a prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/Run","href":"/api-reference/predictions/run-a-prediction"},{"title":"Cancel a running prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/Cancel","href":"/api-reference/predictions/cancel-a-running-prediction"},{"title":"Change status of one or more predictions","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/Status","href":"/api-reference/predictions/change-status-of-one-or-more-predictions"},{"title":"Export a prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/Export","href":"/api-reference/predictions/export-a-prediction"},{"title":"Export and compare multiple predictions","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionIds}/ExportMulti","href":"/api-reference/predictions/export-and-compare-multiple-predictions"},{"title":"Get albedo data for a prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/GetAlbedoData","href":"/api-reference/predictions/get-albedo-data-for-a-prediction"},{"title":"Update export options for a prediction's power plant","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions","href":"/api-reference/predictions/update-export-options-for-a-predictions-power-plant"}]},{"group":"PowerPlant","pages":[{"title":"Get power plant","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/PowerPlant","href":"/api-reference/powerplant/get-power-plant"},{"title":"Update power plant","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Project/{projectId}/Prediction/{predictionId}/PowerPlant","href":"/api-reference/powerplant/update-power-plant"},{"title":"Create power plant","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/PowerPlant","href":"/api-reference/powerplant/create-power-plant"}]},{"group":"TimeSeries","pages":[{"title":"List time series data sets","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/TimeSeriesData","href":"/api-reference/timeseries/list-time-series-data-sets"},{"title":"Upload time series CSV","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Project/{projectId}/Prediction/{predictionId}/TimeSeriesData","href":"/api-reference/timeseries/upload-time-series-csv"},{"title":"Create new time series","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/TimeSeriesData","href":"/api-reference/timeseries/create-new-time-series"},{"title":"Download time series CSV template","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/TimeSeriesData/Template","href":"/api-reference/timeseries/download-time-series-csv-template"},{"title":"Get time series details","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/TimeSeriesData/{timeSeriesId}/Details","href":"/api-reference/timeseries/get-time-series-details"},{"title":"Download time series as CSV","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/TimeSeriesData/{timeSeriesId}/CSV","href":"/api-reference/timeseries/download-time-series-as-csv"},{"title":"Delete a time series","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml delete /Project/{projectId}/Prediction/{predictionId}/TimeSeriesData/{timeSeriesId}","href":"/api-reference/timeseries/delete-a-time-series"}]},{"group":"Results","pages":[{"title":"Get prediction result summary","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/ResultSummary","href":"/api-reference/results/get-prediction-result-summary"},{"title":"Get detailed energy results","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/ResultDetails","href":"/api-reference/results/get-detailed-energy-results"},{"title":"Get average energy results","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/AverageEnergy","href":"/api-reference/results/get-average-energy-results"},{"title":"Get nodal JSON results","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/NodalJson","href":"/api-reference/results/get-nodal-json-results"}]},{"group":"FinancialModel","pages":[{"title":"Get financial model parameters","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/FinancialModelParameters","href":"/api-reference/financialmodel/get-financial-model-parameters"},{"title":"Save financial model parameters","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/FinancialModelParameters","href":"/api-reference/financialmodel/save-financial-model-parameters"},{"title":"Calculate cashflow results","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/CalculateCashflowResults","href":"/api-reference/financialmodel/calculate-cashflow-results"}]},{"group":"Reports","pages":[{"title":"Get URL for a generated report","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/ReportURL/{reportType}","href":"/api-reference/reports/get-url-for-a-generated-report"},{"title":"Get plant block details report","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/Report/PlantBlockDetails","href":"/api-reference/reports/get-plant-block-details-report"},{"title":"Trigger report generation","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/GenerateReports","href":"/api-reference/reports/trigger-report-generation"},{"title":"Cancel report generation","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/CancelReportGeneration","href":"/api-reference/reports/cancel-report-generation"}]},{"group":"ShadeScene","pages":[{"title":"Convert PVC file to PVJ shade scene format","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /ShadeScene/ConvertPVCtoPVJ","href":"/api-reference/shadescene/convert-pvc-file-to-pvj-shade-scene-format"},{"title":"Convert SHD file to PVJ shade scene format","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /ShadeScene/ConvertSHDtoPVJ","href":"/api-reference/shadescene/convert-shd-file-to-pvj-shade-scene-format"},{"title":"Create/upload a shade scene from PVJ data","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Project/{projectId}/Prediction/{predictionId}/ShadeScene/PVJData","href":"/api-reference/shadescene/createupload-a-shade-scene-from-pvj-data"},{"title":"Get shade scene properties for a DC field","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/ShadeScene/Properties/{dcFieldNumber}","href":"/api-reference/shadescene/get-shade-scene-properties-for-a-dc-field"},{"title":"Update shade scene properties","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Project/{projectId}/Prediction/{predictionId}/ShadeScene","href":"/api-reference/shadescene/update-shade-scene-properties"},{"title":"Queue TABT calculations","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/TABT/Run","href":"/api-reference/shadescene/queue-tabt-calculations"},{"title":"Get TABT processing status","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/TABT/ProcessingStatus","href":"/api-reference/shadescene/get-tabt-processing-status"},{"title":"Queue shade calculations","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/ShadeScene/Run","href":"/api-reference/shadescene/queue-shade-calculations"},{"title":"Get shade calculation processing status","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/ShadeScene/ProcessingStatus","href":"/api-reference/shadescene/get-shade-calculation-processing-status"},{"title":"Get 3D shade calculation results","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/ShadeScene/Results","href":"/api-reference/shadescene/get-3d-shade-calculation-results"}]},{"group":"Weather","pages":[{"title":"Create a weather file","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Weather","href":"/api-reference/weather/create-a-weather-file"},{"title":"Get a weather file","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Weather/{weatherId}","href":"/api-reference/weather/get-a-weather-file"},{"title":"Export a weather file","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Weather/{weatherId}/Export","href":"/api-reference/weather/export-a-weather-file"},{"title":"Update weather file metadata","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Weather/{weatherId}/TitleUpdate","href":"/api-reference/weather/update-weather-file-metadata"},{"title":"Get weather hourly detail records","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Weather/{weatherId}/Detail","href":"/api-reference/weather/get-weather-hourly-detail-records"},{"title":"Update weather hourly detail records","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Weather/{weatherId}/Detail","href":"/api-reference/weather/update-weather-hourly-detail-records"},{"title":"Search weather files by location","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Weather/Search","href":"/api-reference/weather/search-weather-files-by-location"},{"title":"Parse a raw weather file upload","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Weather/Parse","href":"/api-reference/weather/parse-a-raw-weather-file-upload"},{"title":"Run quality check on a parsed weather file","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Weather/QualityCheck","href":"/api-reference/weather/run-quality-check-on-a-parsed-weather-file"},{"title":"Finalize import of a parsed weather file","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Weather/FinalizeImport","href":"/api-reference/weather/finalize-import-of-a-parsed-weather-file"},{"title":"Finalize a system-generated weather file","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Weather/FinalizeGeneratedWeather","href":"/api-reference/weather/finalize-a-system-generated-weather-file"},{"title":"Download weather data from a provider","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Weather/Download/{providerId}","href":"/api-reference/weather/download-weather-data-from-a-provider"},{"title":"Validate a weather download or import","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Weather/Download/ValidateDownload","href":"/api-reference/weather/validate-a-weather-download-or-import"},{"title":"Get horizon elevation profile for a location","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Weather/GetHorizonScene","href":"/api-reference/weather/get-horizon-elevation-profile-for-a-location"}]},{"group":"Inverters","pages":[{"title":"List all accessible inverters","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Inverter","href":"/api-reference/inverters/list-all-accessible-inverters"},{"title":"Create an inverter","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Inverter","href":"/api-reference/inverters/create-an-inverter"},{"title":"Get inverter overview list","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Inverter/InverterOverview","href":"/api-reference/inverters/get-inverter-overview-list"},{"title":"Change status of one or more inverters","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Inverter/Status","href":"/api-reference/inverters/change-status-of-one-or-more-inverters"},{"title":"Calculate kVA for an inverter at given conditions","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Inverter/kVA","href":"/api-reference/inverters/calculate-kva-for-an-inverter-at-given-conditions"},{"title":"Parse an OND file and return inverter data","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Inverter/ParseONDFile","href":"/api-reference/inverters/parse-an-ond-file-and-return-inverter-data"},{"title":"Get an inverter by ID","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Inverter/{inverterId}","href":"/api-reference/inverters/get-an-inverter-by-id"},{"title":"Update an inverter","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Inverter/{inverterId}","href":"/api-reference/inverters/update-an-inverter"},{"title":"Delete an inverter","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml delete /Inverter/{inverterId}","href":"/api-reference/inverters/delete-an-inverter"},{"title":"Get stored kVA for an inverter","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Inverter/{inverterId}/kVA","href":"/api-reference/inverters/get-stored-kva-for-an-inverter"}]},{"group":"Modules","pages":[{"title":"List all accessible modules","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Module","href":"/api-reference/modules/list-all-accessible-modules"},{"title":"Create a module","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module","href":"/api-reference/modules/create-a-module"},{"title":"Get module overview list","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Module/ModuleOverview","href":"/api-reference/modules/get-module-overview-list"},{"title":"Get default IAM curve for a given ASHRAE IAM coefficient","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Module/DefaultIAM","href":"/api-reference/modules/get-default-iam-curve-for-a-given-ashrae-iam-coefficient"},{"title":"Parse a PAN file and return module data","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/ImportPANFile","href":"/api-reference/modules/parse-a-pan-file-and-return-module-data"},{"title":"Create a module from parsed PAN file data","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/CreatePANFileModule","href":"/api-reference/modules/create-a-module-from-parsed-pan-file-data"},{"title":"Generate single-diode parameters from basic datasheet values","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/Generator/GenerateSingleDiodeParametersDefault","href":"/api-reference/modules/generate-single-diode-parameters-from-basic-datasheet-values"},{"title":"Advanced generation of single-diode parameters","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/Generator/GenerateSingleDiodeParametersAdvanced","href":"/api-reference/modules/advanced-generation-of-single-diode-parameters"},{"title":"Optimize series resistance for effective irradiance response","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/Generator/OptimizeSeriesResistance","href":"/api-reference/modules/optimize-series-resistance-for-effective-irradiance-response"},{"title":"Calculate effective irradiance response","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/Generator/CalculateEffectiveIrradianceResponse","href":"/api-reference/modules/calculate-effective-irradiance-response"},{"title":"Generate IV curve for a module","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/Generator/GenerateIVCurve","href":"/api-reference/modules/generate-iv-curve-for-a-module"},{"title":"Process IV curve data","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/Generator/ProcessIVCurves","href":"/api-reference/modules/process-iv-curve-data"},{"title":"Process key IV points for module parameter derivation","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/Generator/ProcessKeyIVPoints","href":"/api-reference/modules/process-key-iv-points-for-module-parameter-derivation"},{"title":"Get a module by ID","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Module/{moduleId}","href":"/api-reference/modules/get-a-module-by-id"},{"title":"Update a module","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Module/{moduleId}","href":"/api-reference/modules/update-a-module"},{"title":"Delete a module","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml delete /Module/{moduleId}","href":"/api-reference/modules/delete-a-module"},{"title":"Export a module","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Module/{moduleId}/Export","href":"/api-reference/modules/export-a-module"},{"title":"Get notes for a module","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Module/{moduleId}/Note","href":"/api-reference/modules/get-notes-for-a-module"},{"title":"Delete a module note","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml delete /Module/{moduleId}/Note/{noteId}","href":"/api-reference/modules/delete-a-module-note"}]},{"group":"ASHRAE","pages":[{"title":"Get nearest ASHRAE station by coordinates","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /ASHRAE","href":"/api-reference/ashrae/get-nearest-ashrae-station-by-coordinates"},{"title":"Get a specific ASHRAE station by name","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /ASHRAE/GetStation","href":"/api-reference/ashrae/get-a-specific-ashrae-station-by-name"}]},{"group":"System","pages":[{"title":"Get API version","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /System/Version","href":"/api-reference/system/get-api-version"},{"title":"Get maintenance mode status","description":"Returns the current system maintenance mode status.","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /System/MaintenanceMode","href":"/api-reference/system/get-maintenance-mode-status"}]},{"group":"Company","pages":[{"title":"Get company default settings","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Company/DefaultSettings","href":"/api-reference/company/get-company-default-settings"},{"title":"Update company default settings","description":"Updates default settings for your company. Requires Admin role. Default Settings are prediction input values customized per company.","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Company/DefaultSettings","href":"/api-reference/company/update-company-default-settings"},{"title":"Add a user to a company","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Company/{companyId}/User","href":"/api-reference/company/add-a-user-to-a-company"},{"title":"Generate API credentials for a user","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /User/{userId}/Secret","href":"/api-reference/company/generate-api-credentials-for-a-user"}]},{"group":"Country","pages":[{"title":"List all countries","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Country","href":"/api-reference/country/list-all-countries"}]}]},{"group":"API Tools","icon":"wrench","pages":[{"title":"Postman Collection","href":"/api-docs/postman"},{"title":"Import a PVsyst project","href":"/api-docs/pvsyst-import"},{"title":"Import a PVFARM project","href":"/api-docs/pvfarm-import"}]},{"group":"SDK Documentation","icon":"github","pages":[{"title":"Github SDK Repository","url":"https://github.com/plantpredict/python-sdk","href":"/api-docs/python-sdk"}]}]}]},{"tab":"Design Pro","icon":"compass-drafting","menu":[{"item":"User Guide","href":"https://terabase.atlassian.net/servicedesk/customer/portal/3/topic/058fa7a7-e6a7-4b23-8c73-84ae563d6cd7/article/1295253542"}]},{"tab":"Terrain Pro","icon":"mountain","menu":[{"item":"User Guide","pages":[{"title":"User Guide","href":"/user-guide/terrain-pro/terrain-pro-user-guide"}]}],"pages":[{"title":"Terrain Pro","href":"/user-guide/terrain-pro/terrain-pro-user-guide"}]},{"tab":"Voltage Pro","icon":"bolt","menu":[{"item":"User Guide","pages":[{"title":"User Guide","href":"/user-guide/voltage-pro/voltage-pro-user-guide"}]}],"pages":[{"title":"Voltage Pro","href":"/user-guide/voltage-pro/voltage-pro-user-guide"}]},{"tab":"Extensions","icon":"puzzle-piece","menu":[{"item":"PVRADAR Soiling","href":"https://pvradar.com/partners/terabase"},{"item":"PowerUQ","href":"https://www.poweruq.com/plantpredict-integration"}]},{"tab":"Release Notes","icon":"notebook","pages":[{"title":"Release Notes","href":"/release-notes/Current-Version"}]}]},"basePath":"","title":"Get company default settings - PlantPredict","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-CnLhKuUV.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}