Create Scans
An easy guide to use the Create Scans endpoint to start building an energy system for every location
Create Scans Endpoint
To successfully create a Scan for a single or multiple locations the following endpoint can be used:
Endpoint:https://api.novasole.com/scans/create
Request Method:POST
Request Body
The request body includes details about the Location, Energy Scenario, and Customer. Not all parameters are required and can be set to null.
Currently, only locations in the Netherlands, Belgium, and Denmark are supported. Belgian addresses require a street property, while Dutch addresses need a postal code.
The Energy Scenario defines user preferences for creating an energy system, including preferred products and electricity usage details.
To get a valid Campaign Id, use the Get Campaign Info endpoint or contact Support support@novasole.com if you need a specific Package Id or Module Id.
For multiple scans repeat the input model in the models list property. Be aware that multiple models in a single request could take longer than single models in multiple requests.
{
"models": [
{
"location": {
"address": {
"postalCode": "",
"houseNumber": 1,
"additive": null,
"street": null,
"place": null
},
"targetGroup": null
},
"energyScenario": {
"yearlyUsage": null,
"productPreferences": {
"campaignId": 1,
"packageId": null,
"moduleId": null
}
},
"customer": {
"customerId": null,
"email": "",
"firstName": "",
"insertion": null,
"lastName": "",
"organization": "",
"telephone": "",
"fullName": null
}
}
]
}Successful Response
A successful Create Scan request provides detailed insights about the created energy system and it’s location. This includes for example roof surface data, an overview of articles in the designed energy system, financial specifications, yearly energy flows (in kWh) and technical details about the calculation.
Example response:
{
"calculationInfo": {
"calculationId": 1,
"refId": "2025.01.01.1",
"creationDate": "2025-01-01T00:00:00.0+00:00"
},
"location": {
"addressInfo": {
"countryAndRegion": {
"countryId": 1,
"country": "name_of_country",
"regionId": null,
"region": null
},
"postalCode": "0000AA",
"houseNumber": 1,
"additive": null,
"secondAdditive": null,
"street": "name_of_street",
"place": "name_of_place",
"latitude": 0.0,
"longitude": 0.0
},
"buildingInfo": {
"buildingId": "0000000000000000",
"buildingType": "name_of_building_type",
"buildingSubType": "",
"energyLabel": {
"label": "A",
"buildingType": "name_of_building_type",
"buildingSubType": "name_of_building_sub_type"
},
"buildingYear": 0000,
"constructionYear": 0000,
"dwellingTypeId": 0,
"dwellingType": "name_of_dwelling_type"
},
"locationClimate": {
"ghi": 1000,
"goi": 1000,
"at": 00.0,
"irradiationDisk": "name_of_place",
"source": {
"pvGisSaf": null,
"pvGisTemperature": null,
"pvGisIrradiation": null,
"knmi": null,
"pvSol": null,
"pvGisMonthlyTemperature": null
}
},
"allSurfaces": {
"surfaces": [
{
"id": 1,
"roofTypeId": 1,
"roofType": "name_of_roof_type",
"area": 00.00,
"inclination": 00.00,
"orientation": -00.00,
"gutter": 00.00,
"ridge": null,
"shadowLoss": 00,
"roofpotential": 0
}
]
}
},
"energyScenario": {
"yearlyUsage": 0,
"productPreferences": {
"campaignId": 0,
"packageId": 0,
"moduleId": null
}
},
"customer": {
"customerId": 1,
"email": "email_address",
"firstName": "first_name",
"insertion": null,
"lastName": "last_name",
"organization": "name_of_organization",
"telephone": "0000000000",
"fullName": "firstname_lastname"
},
"energySystemInfo": {
"energySystemId": 1,
"priceSummary": {
"subtotal": 0000.0000,
"discount": 0,
"netPrice": 0000.0000,
"vatAmounts": {
"vatAmountNetPrice": 0.0000,
"batteryTax": {
"batteryTax": 0,
"batteryVatPercentage": 0,
"vatAmountBatteryTax": null
},
"vatAmount": 0.0000,
"vatRefund": 0
},
"grossPrice": 0000.0000
},
"powerTotalsSummary": {
"totalNrOfPv": 1,
"totalMaxNrOfPv": 1,
"totalInstalledPvPower": 1000,
"totalInstalledInverterPower": 1000
},
"articlesPerGroup": {
"solarPanelGroups": [
{
"groupArticles": [
{
"groupId": 1,
"buildingBlockId": 1,
"buildingBlock": "name_of_building_block",
"categoryId": 1,
"category": "name_of_category",
"name": "name_of_brand",
"model": "name_of_model",
"quantity": 1,
"unit": "name_of_unit",
"description": "description_of_category",
"articleCode": "0",
"eanCode": "0",
"warranty": 1,
"pricing": {
"purchasePrice": 000.0000,
"price": 000.0000,
"orderQuantity": 1,
"totalPrice": 000.0000,
"totalPriceDiscounted": 000.0000,
"margin": 000.0000,
"vatAmountDiscounted": 0.0000,
"vat": 0,
"discount": 0
}
}
]
}
],
"otherGroup": {
"groupArticles": [
{
"groupId": 1,
"buildingBlockId": 1,
"buildingBlock": "name_of_building_block",
"categoryId": 1,
"category": "name_of_category",
"name": "name_of_brand",
"model": "name_of_model",
"quantity": 1,
"unit": "name_of_unit",
"description": "description_of_category",
"articleCode": "0",
"eanCode": "0",
"warranty": 1,
"pricing": {
"purchasePrice": 000.0000,
"price": 000.0000,
"orderQuantity": 1,
"totalPrice": 000.0000,
"totalPriceDiscounted": 000.0000,
"margin": 000.0000,
"vatAmountDiscounted": 0.0000,
"vat": 0,
"discount": 0
}
}
]
}
},
"energyHarvesting": {
"inverterConfiguration": [],
"layoutImages": [
"url_of_roadmap_image_location.jpg",
"url_of_aerial_map_image_location.jpg"
]
},
"energyStorage": {},
"energyUse": {},
"energyManagement": {},
"billOfMaterials": null
},
"energySystemCalculationResults": {
"energyFlows": [
{
"yearIndex": 0,
"usage": {
"yearlyKWh": 0000,
"selfConsumptionPercentage": null,
"balancingFactor": null,
"productionExcessFactor": null,
"monthlyKWh": null
},
"production": {
"yearlyKWh": 0000,
"selfConsumptionPercentage": 0.0000,
"balancingFactor": 1,
"productionExcessFactor": 0.0000,
"monthlyKWh": null
},
"selfConsumption": {
"yearlyKWh": 0.0000,
"selfConsumptionPercentage": 0.0000,
"balancingFactor": 1,
"productionExcessFactor": 0.0000,
"monthlyKWh": null
},
"productionExcess": {
"yearlyKWh": 0.0000,
"selfConsumptionPercentage": 0.0000,
"balancingFactor": 1,
"productionExcessFactor": 0.0000,
"monthlyKWh": null
},
"balancingAmount": {
"yearlyKWh": 0.0000,
"selfConsumptionPercentage": 0.0000,
"balancingFactor": 1,
"productionExcessFactor": 0.0000,
"monthlyKWh": null
},
"productionExcessFeedIn": {
"yearlyKWh": 0.0000,
"selfConsumptionPercentage": 0.0000,
"balancingFactor": 1,
"productionExcessFactor": 0.0000,
"monthlyKWh": null
},
"usageGridTake": {
"yearlyKWh": 0.0000,
"selfConsumptionPercentage": 0.0000,
"balancingFactor": 1,
"productionExcessFactor": 0.0000,
"monthlyKWh": null
}
}
]
}
}