# Clevergy Documentation > Complete reference documentation for Clevergy - [Clevergy Documentation](https://docs.clever.gy/index.md) ## developer This reference is your key to a comprehensive understanding of the Clevergy integrations. - [Introduction](https://docs.clever.gy/developer.md): This reference is your key to a comprehensive understanding of the Clevergy integrations. ### getting-started #### authentication Depending on the use case, there are three ways to authenticate: - [Authentication](https://docs.clever.gy/developer/getting-started/authentication.md): Depending on the use case, there are three ways to authenticate: #### entities These are the entities of Clevergy - [Entities](https://docs.clever.gy/developer/getting-started/entities.md): These are the entities of Clevergy ##### how-clevergy-entities-works This section explains what happens in Clevergy when key events take place: creating or cancelling contracts, changing the holder, or deleting users and houses. It's meant to help you understand the automatic behaviors of the platform so you can operate with confidence. - [How Clevergy entities work](https://docs.clever.gy/developer/getting-started/entities/how-clevergy-entities-works.md): This section explains what happens in Clevergy when key events take place: creating or cancelling contracts, changing the holder, or deleting users and houses. It's meant to help you understand the automatic behaviors of the platform so you can operate with confidence. ### how-to-set-up #### battery-management The platform allows interacting with battery systems linked to a supply point through the Connect API. - [Battery management](https://docs.clever.gy/developer/how-to-set-up/battery-management.md): The platform allows interacting with battery systems linked to a supply point through the Connect API. #### contracts The platform allows managing energy contracts associated with a client through the Connect API. These contracts are visible to the client under their house contracts. - [Contracts](https://docs.clever.gy/developer/how-to-set-up/contracts.md): The platform allows managing energy contracts associated with a client through the Connect API. These contracts are visible to the client under their house contracts. #### create-client This guide explains the minimum required flow to onboard a customer in Clevergy under the Plan Starter. - [Create a new client](https://docs.clever.gy/developer/how-to-set-up/create-client.md): This guide explains the minimum required flow to onboard a customer in Clevergy under the Plan Starter. #### create-solar-client This guide explains the minimum required flow to onboard a customer in Clevergy under the Plan Pro. - [Create new solar client](https://docs.clever.gy/developer/how-to-set-up/create-solar-client.md): This guide explains the minimum required flow to onboard a customer in Clevergy under the Plan Pro. #### invoices This guide explains how to create and upload an invoice associated with an existing contract. It assumes that both the user and the contract (contractId) have already been created. - [Invoices](https://docs.clever.gy/developer/how-to-set-up/invoices.md): This guide explains how to create and upload an invoice associated with an existing contract. It assumes that both the user and the contract (contractId) have already been created. #### obtain-energy-data All steps needed to create a new client and obtain his energy data. - [Obtain energy data from my clients](https://docs.clever.gy/developer/how-to-set-up/obtain-energy-data.md): All steps needed to create a new client and obtain his energy data. #### sales-opportunities All steps needed to integrate sales opportunities with a client CRM or sales platform using the Connect API. - [Create sales opportunities integration via Connect](https://docs.clever.gy/developer/how-to-set-up/sales-opportunities.md): All steps needed to integrate sales opportunities with a client CRM or sales platform using the Connect API. #### solar-api-integration This guide explains the minimum required flow to onboard a client and connect a solar installation using Clevergy’s Solar API. - [Solar API integration](https://docs.clever.gy/developer/how-to-set-up/solar-api-integration.md): This guide explains the minimum required flow to onboard a client and connect a solar installation using Clevergy’s Solar API. #### ticket-integration All steps needed to integrate the ticket system with a client support platform (e.g: CRM) using Connect API. - [Create ticket integration via Connect](https://docs.clever.gy/developer/how-to-set-up/ticket-integration.md): All steps needed to integrate the ticket system with a client support platform (e.g: CRM) using Connect API. #### virtual-balance The platform allows managing the virtual balance from the Connect API. - [Virtual balance](https://docs.clever.gy/developer/how-to-set-up/virtual-balance.md): The platform allows managing the virtual balance from the Connect API. ### microfrontends What is a microfrontend? - [Microfrontends](https://docs.clever.gy/developer/microfrontends.md): What is a microfrontend? #### include-prices This is a guide to help you integrate the prices microfrontend in your application. - [Include energy prices microfrontend](https://docs.clever.gy/developer/microfrontends/include-prices.md): This is a guide to help you integrate the prices microfrontend in your application. #### include-smart-meter This is a guide to help you integrate the microfrontend that authorizes the connection with Datadis. - [Include integration smartmeter microfrontend](https://docs.clever.gy/developer/microfrontends/include-smart-meter.md): This is a guide to help you integrate the microfrontend that authorizes the connection with Datadis. ## helpdesk This reference is your key to a comprehensive understanding of the Clevergy functionality. - [Help desk](https://docs.clever.gy/helpdesk.md): This reference is your key to a comprehensive understanding of the Clevergy functionality. ### app #### authorizations With this feature, any Clevergy user can authorize another user to access the information of one of their homes within the app. This makes it easier to share energy data with employees, family members or any trusted person. - [Authorizations](https://docs.clever.gy/helpdesk/app/authorizations.md): With this feature, any Clevergy user can authorize another user to access the information of one of their homes within the app. This makes it easier to share energy data with employees, family members or any trusted person. #### euros Description - [Costs in euros](https://docs.clever.gy/helpdesk/app/euros.md): Description #### exhibition-mode This feature allows users with photovoltaic installations to create a public-facing "exhibition view" showcasing key performance indicators, real-time data and positive impact of their system. This mode is specifically designed to meet the requirements of publicly displaying funded projects, making it ideal for sharing on a television or any public screen. - [Exhibition mode](https://docs.clever.gy/helpdesk/app/exhibition-mode.md): This feature allows users with photovoltaic installations to create a public-facing "exhibition view" showcasing key performance indicators, real-time data and positive impact of their system. This mode is specifically designed to meet the requirements of publicly displaying funded projects, making it ideal for sharing on a television or any public screen. #### global-vision Global view provides a consolidated overview of all your supply points, allowing you to monitor aggregated energy consumption and production at a glance. This feature is designed for both companies managing multiple installations and residential users with more than one home. - [Global view](https://docs.clever.gy/helpdesk/app/global-vision.md): Global view provides a consolidated overview of all your supply points, allowing you to monitor aggregated energy consumption and production at a glance. This feature is designed for both companies managing multiple installations and residential users with more than one home. #### help Through the Help module in the app, clients can send support tickets digitally. This simplifies the management of customer issues by avoiding phone calls and centralizing all communication in a single place, improving the relationship between the customer and the utility. - [Help (support tickets)](https://docs.clever.gy/helpdesk/app/help.md): Through the Help module in the app, clients can send support tickets digitally. This simplifies the management of customer issues by avoiding phone calls and centralizing all communication in a single place, improving the relationship between the customer and the utility. #### multi-language The application supports language management, allowing a localized experience for the client. Currently, the available languages are: - [Multi-language](https://docs.clever.gy/helpdesk/app/multi-language.md): The application supports language management, allowing a localized experience for the client. Currently, the available languages are: #### notifications A simple guide to our push notification system and when users will receive them - [Notifications](https://docs.clever.gy/helpdesk/app/notifications.md): A simple guide to our push notification system and when users will receive them #### onboarding Onboarding is the process of introducing new users to the app to ensure a smooth start. It helps users understand the app’s value proposition and configure some settings before using it. - [Onboarding](https://docs.clever.gy/helpdesk/app/onboarding.md): Onboarding is the process of introducing new users to the app to ensure a smooth start. It helps users understand the app’s value proposition and configure some settings before using it. #### optimize Find personalized recommendations for renewable energy solutions to optimize your home's energy consumption. - [Optimize](https://docs.clever.gy/helpdesk/app/optimize.md): Find personalized recommendations for renewable energy solutions to optimize your home's energy consumption. ### connections Connections keep your customer data in sync between your ERP or CRM and Clevergy, so your users find their contracts, invoices and balance ready in the app without any manual work. - [Connections](https://docs.clever.gy/helpdesk/connections.md): Connections keep your customer data in sync between your ERP or CRM and Clevergy, so your users find their contracts, invoices and balance ready in the app without any manual work. #### audinfor The Audinfor connection keeps your customers, contracts, prices, invoices and virtual wallet in sync between Audinfor and Clevergy. - [Audinfor](https://docs.clever.gy/helpdesk/connections/audinfor.md): The Audinfor connection keeps your customers, contracts, prices, invoices and virtual wallet in sync between Audinfor and Clevergy. #### connect-api The Connect API lets you connect any ERP or CRM to Clevergy by sending your customer data directly, when your system is not in the list of available connections. - [Connect API](https://docs.clever.gy/helpdesk/connections/connect-api.md): The Connect API lets you connect any ERP or CRM to Clevergy by sending your customer data directly, when your system is not in the list of available connections. #### enexpa The Enexpa connection keeps your customers, contracts, invoices and virtual wallet in sync between Enexpa and Clevergy. - [Enexpa](https://docs.clever.gy/helpdesk/connections/enexpa.md): The Enexpa connection keeps your customers, contracts, invoices and virtual wallet in sync between Enexpa and Clevergy. #### gisce The Gisce connection keeps your customers, contracts and prices in sync between Gisce and Clevergy. - [Gisce](https://docs.clever.gy/helpdesk/connections/gisce.md): The Gisce connection keeps your customers, contracts and prices in sync between Gisce and Clevergy. #### neuro The Neuro Energía connection keeps your customers, contracts, prices and invoices in sync between Neuro Energía and Clevergy. - [Neuro Energía connection](https://docs.clever.gy/helpdesk/connections/neuro.md): The Neuro Energía connection keeps your customers, contracts, prices and invoices in sync between Neuro Energía and Clevergy. ### integrations Users can access and monitor their energy data by connecting external platforms and devices. The following integrations are available: - [Integrations](https://docs.clever.gy/helpdesk/integrations.md): Users can access and monitor their energy data by connecting external platforms and devices. The following integrations are available: #### datadis The Datadis integration allows access to electricity consumption data, based on the supply points associated with the user. - [Datadis integration](https://docs.clever.gy/helpdesk/integrations/datadis.md): The Datadis integration allows access to electricity consumption data, based on the supply points associated with the user. #### distributors The distributors integration allows access to users' consumption data by connecting with the electricity distributor. - [Distributors integration](https://docs.clever.gy/helpdesk/integrations/distributors.md): The distributors integration allows access to users' consumption data by connecting with the electricity distributor. #### electric-vehicle The electric vehicle integration lets users connect their car account and manage charging from the app. - [Electric vehicle integration](https://docs.clever.gy/helpdesk/integrations/electric-vehicle.md): The electric vehicle integration lets users connect their car account and manage charging from the app. #### inverters Clevergy supports integration with various inverter brands to provide real-time and historical data. - [Inverters integration](https://docs.clever.gy/helpdesk/integrations/inverters.md): Clevergy supports integration with various inverter brands to provide real-time and historical data. ##### enphase The Enphase integration allows administrators to connect and monitor Enphase inverters through Clevergy. - [Enphase integration](https://docs.clever.gy/helpdesk/integrations/inverters/enphase.md): The Enphase integration allows administrators to connect and monitor Enphase inverters through Clevergy. ##### fronius The Fronius integration allows administrators and end users to monitor and manage inverter data through the platform. - [Fronius integration](https://docs.clever.gy/helpdesk/integrations/inverters/fronius.md): The Fronius integration allows administrators and end users to monitor and manage inverter data through the platform. ##### goodwe The GoodWe integration allows administrators to connect and monitor GoodWe inverters through the platform. - [GoodWe integration](https://docs.clever.gy/helpdesk/integrations/inverters/goodwe.md): The GoodWe integration allows administrators to connect and monitor GoodWe inverters through the platform. ##### growatt The Growatt integration allows administrators to connect and monitor Growatt inverters through the platform. - [Growatt integration](https://docs.clever.gy/helpdesk/integrations/inverters/growatt.md): The Growatt integration allows administrators to connect and monitor Growatt inverters through the platform. ##### huawei The Huawei integration allows administrators and users to monitor and manage inverter data through the platform. - [Huawei integration](https://docs.clever.gy/helpdesk/integrations/inverters/huawei.md): The Huawei integration allows administrators and users to monitor and manage inverter data through the platform. ##### saj The SAJ integration allows administrators and users to monitor and manage inverter data through the platform. - [SAJ integration](https://docs.clever.gy/helpdesk/integrations/inverters/saj.md): The SAJ integration allows administrators and users to monitor and manage inverter data through the platform. ##### sigenergy The Sigenergy integration allows end users to connect their Sigenergy solar installation and battery, so you can monitor its production, grid exchange and battery through the platform. - [Sigenergy integration](https://docs.clever.gy/helpdesk/integrations/inverters/sigenergy.md): The Sigenergy integration allows end users to connect their Sigenergy solar installation and battery, so you can monitor its production, grid exchange and battery through the platform. ##### sma The SMA integration allows end users to connect their SMA solar installation by logging in with their SMA account (Sunny Portal), so you can monitor its production through the platform. - [SMA integration](https://docs.clever.gy/helpdesk/integrations/inverters/sma.md): The SMA integration allows end users to connect their SMA solar installation by logging in with their SMA account (Sunny Portal), so you can monitor its production through the platform. ##### solaredge The SolarEdge integration allows administrators to connect and monitor SolarEdge inverters through the platform. - [SolarEdge integration](https://docs.clever.gy/helpdesk/integrations/inverters/solaredge.md): The SolarEdge integration allows administrators to connect and monitor SolarEdge inverters through the platform. ##### solis The Solis integration allows administrators and users to monitor and manage inverter data through the platform. - [Solis integration](https://docs.clever.gy/helpdesk/integrations/inverters/solis.md): The Solis integration allows administrators and users to monitor and manage inverter data through the platform. ##### sungrow The Sungrow integration allows to connect and monitor Sungrow inverters through the platform. - [Sungrow integration](https://docs.clever.gy/helpdesk/integrations/inverters/sungrow.md): The Sungrow integration allows to connect and monitor Sungrow inverters through the platform. ##### wibeee The Wibeee integration allows users to connect and monitor Wibeee smart meters for solar energy monitoring through the platform. - [Wibeee integration](https://docs.clever.gy/helpdesk/integrations/inverters/wibeee.md): The Wibeee integration allows users to connect and monitor Wibeee smart meters for solar energy monitoring through the platform. #### shelly The Shelly integration allows to connect and manage smart devices for energy monitoring and control. - [Shelly integration](https://docs.clever.gy/helpdesk/integrations/shelly.md): The Shelly integration allows to connect and manage smart devices for energy monitoring and control. ### microfrontends-catalog Account setup and integrations - [Microfrontends Catalog](https://docs.clever.gy/helpdesk/microfrontends-catalog.md): Account setup and integrations #### account-setup-integrations ##### create-contract-opportunity The `` microfrontend allows users to complete the entire electricity contracting process from any digital touchpoint -your website, app, or landing page-, letting them choose a tariff directly or upload their electricity bill for a personalized recommendation. - [Create contract opportunity](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/create-contract-opportunity.md): The `` microfrontend allows users to complete the entire electricity contracting process from any digital touchpoint -your website, app, or landing page-, letting them choose a tariff directly or upload their electricity bill for a personalized recommendation. ##### house-contracts The `` microfrontend allows users to view and manage information related to their contracts. - [House contracts](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/house-contracts.md): The `` microfrontend allows users to view and manage information related to their contracts. ##### house-settings Description - [House settings](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/house-settings.md): Description ##### integration-electric-vehicle Description - [Integration electric vehicle](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-electric-vehicle.md): Description ##### integration-smart-devices Description - [Integration smart devices](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-smart-devices.md): Description ##### integration-smartmeter Description - [Integration smartmeter](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-smartmeter.md): Description ##### integration-solar-inverter Description - [Integration solar inverters](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-solar-inverter.md): Description ##### invoices This microfrontend is responsible for displaying customer invoice information. It provides two different visualization modes controlled by the data-visualization-mode parameter: - [Invoices](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/invoices.md): This microfrontend is responsible for displaying customer invoice information. It provides two different visualization modes controlled by the data-visualization-mode parameter: ##### smart-devices-settings Technical Documentation - [Smart devices settings](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/smart-devices-settings.md): Technical Documentation ##### virtual-battery Description - [Virtual battery](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/virtual-battery.md): Description ##### virtual-wallet Description - [Virtual wallet](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/virtual-wallet.md): Description #### energy-insights ##### breakdown Description - [Breakdown](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/breakdown.md): Description ##### consumption-cumulative - [Consumption cumulative](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/consumption-cumulative.md) ##### energy-chart Description - [Energy chart](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/energy-chart.md): Description ##### insights Description - [Insights](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/insights.md): Description ##### invoice-estimation Description - [Invoice estimation](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/invoice-estimation.md): Description ##### solar-amortization Description - [Solar amortization](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/solar-amortization.md): Description ##### solar-info - [Solar info](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/solar-info.md) ##### solar-summary This module is goig to be deprecated. Use the Insights module instead. - [Solar summary](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/solar-summary.md): This module is goig to be deprecated. Use the Insights module instead. #### energy-optimization-recommendations ##### alerts-settings - [Alerts settings](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-optimization-recommendations/alerts-settings.md) ##### energy-contract-tariffs Description - [Energy contract tariffs](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-optimization-recommendations/energy-contract-tariffs.md): Description ##### energy-prices - [Energy prices](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-optimization-recommendations/energy-prices.md) ##### house-comparison Description - [House comparison](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-optimization-recommendations/house-comparison.md): Description ##### recommendations - [Recommendations](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-optimization-recommendations/recommendations.md) ##### solar-recommender - [Solar recommender](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-optimization-recommendations/solar-recommender.md) ##### tips-panel - [Tips panel](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-optimization-recommendations/tips-panel.md) #### real-time-monitoring-devices-control ##### battery Description - [Battery monitoring](https://docs.clever.gy/helpdesk/microfrontends-catalog/real-time-monitoring-devices-control/battery.md): Description ##### electric-vehicle-charge Description - [Electric vehicle charging](https://docs.clever.gy/helpdesk/microfrontends-catalog/real-time-monitoring-devices-control/electric-vehicle-charge.md): Description ##### power-chart - [Power chart](https://docs.clever.gy/helpdesk/microfrontends-catalog/real-time-monitoring-devices-control/power-chart.md) ##### smart-devices - [Smart devices](https://docs.clever.gy/helpdesk/microfrontends-catalog/real-time-monitoring-devices-control/smart-devices.md) ##### solar-real-time - [Solar real-time](https://docs.clever.gy/helpdesk/microfrontends-catalog/real-time-monitoring-devices-control/solar-real-time.md) ### portal Clevergy Operations Portal is the main interface for managing your users, installations, and operational activity across the platform. - [Portal](https://docs.clever.gy/helpdesk/portal.md): Clevergy Operations Portal is the main interface for managing your users, installations, and operational activity across the platform. #### my-data The My Data section provides access to all your core business information and management tools. - [My Data](https://docs.clever.gy/helpdesk/portal/my-data.md): The My Data section provides access to all your core business information and management tools. ##### contracts Contracts store the energy contract information associated with a client, used to create their supply point and calculate energy costs shown to the client in the app. - [Contracts](https://docs.clever.gy/helpdesk/portal/my-data/contracts.md): Contracts store the energy contract information associated with a client, used to create their supply point and calculate energy costs shown to the client in the app. ###### contract-details In the contract details page you will find all the information associated with the energy contract. The fields shown depend on whether it is an electricity or a gas contract. - [Contract details](https://docs.clever.gy/helpdesk/portal/my-data/contracts/contract-details.md): In the contract details page you will find all the information associated with the energy contract. The fields shown depend on whether it is an electricity or a gas contract. ###### contract-list In this section, you can view the complete list of contracts registered in the system, along with the main indicators and available filters. - [Contract list](https://docs.clever.gy/helpdesk/portal/my-data/contracts/contract-list.md): In this section, you can view the complete list of contracts registered in the system, along with the main indicators and available filters. ##### installations Solar installations manage the connection with all compatible inverters. In the overview of the Installations section, you can find: - [Installations](https://docs.clever.gy/helpdesk/portal/my-data/installations.md): Solar installations manage the connection with all compatible inverters. In the overview of the Installations section, you can find: ###### installation-details In the installation details page you will find: - [Installation details](https://docs.clever.gy/helpdesk/portal/my-data/installations/installation-details.md): In the installation details page you will find: ###### link-installation You can link an installation to a house so that the client can view their installation information. This allows the homeowner to monitor their solar installation data directly through the mobile app. - [Link installation](https://docs.clever.gy/helpdesk/portal/my-data/installations/link-installation.md): You can link an installation to a house so that the client can view their installation information. This allows the homeowner to monitor their solar installation data directly through the mobile app. ###### smart-alerts Smart alerts complement native inverter alerts by adding additional logic to detect issues that may not trigger a direct inverter error. They are rule-based checks executed daily to analyze installation behavior and detect abnormal situations. - [Smart alerts for solar installations](https://docs.clever.gy/helpdesk/portal/my-data/installations/smart-alerts.md): Smart alerts complement native inverter alerts by adding additional logic to detect issues that may not trigger a direct inverter error. They are rule-based checks executed daily to analyze installation behavior and detect abnormal situations. ##### users Users are the main entities in Clevergy. At users section you can manage your users, their data and their related information. - [Users](https://docs.clever.gy/helpdesk/portal/my-data/users.md): Users are the main entities in Clevergy. At users section you can manage your users, their data and their related information. ###### create-a-contract From a user's page, you can view all the contracts associated with them and add a new one. - [Create a contract](https://docs.clever.gy/helpdesk/portal/my-data/users/create-a-contract.md): From a user's page, you can view all the contracts associated with them and add a new one. ###### create-a-house A house is an entity from which a user can visualize and manage the energy consumption of a specific location. - [Create a house](https://docs.clever.gy/helpdesk/portal/my-data/users/create-a-house.md): A house is an entity from which a user can visualize and manage the energy consumption of a specific location. ###### create-a-user You can easily create a user from the portal without external help. - [Create a user](https://docs.clever.gy/helpdesk/portal/my-data/users/create-a-user.md): You can easily create a user from the portal without external help. ###### personalized-push-notifications Send a personalized notification to a user - [Personalized push notifications](https://docs.clever.gy/helpdesk/portal/my-data/users/personalized-push-notifications.md): Send a personalized notification to a user ###### user-communications The portal supports several automated and manual email communications to keep users informed and engaged. Each type can be enabled independently based on your workspace configuration. - [User communications](https://docs.clever.gy/helpdesk/portal/my-data/users/user-communications.md): The portal supports several automated and manual email communications to keep users informed and engaged. Each type can be enabled independently based on your workspace configuration. ###### user-list In this section, you can view the complete list of users registered in the system, along with the main indicators and available filters. - [User list](https://docs.clever.gy/helpdesk/portal/my-data/users/user-list.md): In this section, you can view the complete list of users registered in the system, along with the main indicators and available filters. #### settings At settings section you can manage your account, integrations, and promotional campaigns. - [Settings](https://docs.clever.gy/helpdesk/portal/settings.md): At settings section you can manage your account, integrations, and promotional campaigns. ##### access-control The Access Control section lists every user with access to the Clevergy Portal and lets Admins manage them. - [Access control](https://docs.clever.gy/helpdesk/portal/settings/access-control.md): The Access Control section lists every user with access to the Clevergy Portal and lets Admins manage them. ###### roles-and-permissions Every user with access to the Clevergy Portal has a role, which decides what they can do once they log in. There are three preset access levels, designed to fit the way most teams are organized, so you can decide who can do what. - [Roles and permissions](https://docs.clever.gy/helpdesk/portal/settings/access-control/roles-and-permissions.md): Every user with access to the Clevergy Portal has a role, which decides what they can do once they log in. There are three preset access levels, designed to fit the way most teams are organized, so you can decide who can do what. ##### api-key-management The Connect API section provides access to your personal API Key, which is used to create integrations with the Clevergy platform. - [API key management](https://docs.clever.gy/helpdesk/portal/settings/api-key-management.md): The Connect API section provides access to your personal API Key, which is used to create integrations with the Clevergy platform. ##### banners Banners are configurable elements that are displayed on the home screen of the App. This functionality allows you to create promotional campaigns and generate sales opportunities in a targeted way to your users. - [Banners](https://docs.clever.gy/helpdesk/portal/settings/banners.md): Banners are configurable elements that are displayed on the home screen of the App. This functionality allows you to create promotional campaigns and generate sales opportunities in a targeted way to your users. ##### communications Description - [Communication sending rules](https://docs.clever.gy/helpdesk/portal/settings/communications.md): Description ##### tariffs The tariffs section provides an interface to create and manage custom electricity tariffs and assign them to clients. - [My tariffs](https://docs.clever.gy/helpdesk/portal/settings/tariffs.md): The tariffs section provides an interface to create and manage custom electricity tariffs and assign them to clients. #### workspaces Workspaces are specialized sections within the portal designed to help you efficiently manage your commercial and operational activities. - [Workspaces](https://docs.clever.gy/helpdesk/portal/workspaces.md): Workspaces are specialized sections within the portal designed to help you efficiently manage your commercial and operational activities. ##### communications The Communications workspace brings together everything your users receive from you, push notifications and emails, and lets you send push notifications from one place: to a single user or as a campaign. - [Communications](https://docs.clever.gy/helpdesk/portal/workspaces/communications.md): The Communications workspace brings together everything your users receive from you, push notifications and emails, and lets you send push notifications from one place: to a single user or as a campaign. ##### energy-communities In the Energy Communities section, you will have access to an overview of all your energy communities presented in a clear and organized manner. Upon entering, the first thing you will see is a summary of the most relevant data: the total power currently being generated by all your communities, the total number of energy communities you have created, and the total number of participating members. - [Energy Communities](https://docs.clever.gy/helpdesk/portal/workspaces/energy-communities.md): In the Energy Communities section, you will have access to an overview of all your energy communities presented in a clear and organized manner. Upon entering, the first thing you will see is a summary of the most relevant data: the total power currently being generated by all your communities, the total number of energy communities you have created, and the total number of participating members. ##### maintenance The Maintenance workspace centralizes operational management tasks related to all installations. - [Maintenance](https://docs.clever.gy/helpdesk/portal/workspaces/maintenance.md): The Maintenance workspace centralizes operational management tasks related to all installations. ###### alerts The Alerts tab allows the review and management of active operational alerts from a single centralized view. - [Alerts](https://docs.clever.gy/helpdesk/portal/workspaces/maintenance/alerts.md): The Alerts tab allows the review and management of active operational alerts from a single centralized view. ###### prevention The Prevention tab provides a performance overview of all installations, helping operations teams detect underperformance before it becomes a critical issue. - [Prevention](https://docs.clever.gy/helpdesk/portal/workspaces/maintenance/prevention.md): The Prevention tab provides a performance overview of all installations, helping operations teams detect underperformance before it becomes a critical issue. ##### sales-opportunities In the sales opportunities section, you can manage and convert sales leads, as it centralizes information to help qualify, follow up, and move each potential lead toward conversion. - [Sales opportunities](https://docs.clever.gy/helpdesk/portal/workspaces/sales-opportunities.md): In the sales opportunities section, you can manage and convert sales leads, as it centralizes information to help qualify, follow up, and move each potential lead toward conversion. ##### support-tickets At the support section you will find a list of support tickets. - [Support tickets](https://docs.clever.gy/helpdesk/portal/workspaces/support-tickets.md): At the support section you will find a list of support tickets. ### whatsapp We have developed a new feature that allows users to access all their energy provider and account data directly through WhatsApp. - [WhatsApp](https://docs.clever.gy/helpdesk/whatsapp.md): We have developed a new feature that allows users to access all their energy provider and account data directly through WhatsApp. ## search - [Search the documentation](https://docs.clever.gy/search.md) --- # Full Documentation Content [Skip to main content](#__docusaurus_skipToContent_fallback) [![Clevergy Logo](/img/logo-clevergy.png)![Clevergy Logo](/img/logo-clevergy.png)](https://docs.clever.gy/index.md) [Developer Guide](https://docs.clever.gy/developer/.md)[Connect API](https://docs.clever.gy/connect-api/clevergy-connect-api)[Webhooks](https://docs.clever.gy/webhooks/clevergy-webhooks)[Help Desk](https://docs.clever.gy/helpdesk/.md) Search # Search the documentation Type your search here Powered by[](https://www.algolia.com/) * [Blog](https://clever.gy/blog/) * [GitHub](https://github.com/clevergy) * [Clevergy Modules](https://modules.clever.gy) Copyright © 2026 The Clevergy Solution, SL --- # Introduction This reference is your key to a comprehensive understanding of the Clevergy integrations. **Connect API** enables Clevergy customers to build integrations with the Clevergy platform, gaining the ability to manage their users, retrieve essential information such as supplies and consumption data, and leverage valuable insights and recommendations. Connect API opens the door to a comprehensive set of features, allowing you to customize the Clevergy experience to your specific needs. **Microfrontends** are a set of pre-built components that allow you to integrate Clevergy's functionality into your application. They are built using web technologies (HTML, CSS, JavaScript) and can be easily integrated into any website or application. Using the navigation on the left, you'll find details for endpoints used in the API and how to insert a microfrontend in your site. To request access please write to **** --- # Authentication Depending on the use case, there are three ways to authenticate: * For calls to [Clevergy Connect API](https://docs.clever.gy/connect-api/clevergy-connect-api), you must use the [API Key](#authentication-with-api-key). * For integration with [microfrontends](https://docs.clever.gy/developer/microfrontends/.md), you must use the [JWT](#authentication-with-jwt). * For accessing the entire webview via URL, you can use the [Login with Token](#authentication-login-with-token) method. ## Authentication with API Key[​](#authentication-with-api-key "Direct link to Authentication with API Key") When calling [Clevergy Connect API](https://docs.clever.gy/connect-api/clevergy-connect-api), you have to use your API key. You need to write to your CSM, and we will provide you with the API key of your environment. To use the API, you will only need to add this header to your calls: ``` --header 'clevergy-api-key: AIzaSyBntS2wwTsq03-8lZnkeriuhbiunwdlm2Nh8n4Oc'// Example token ``` API key security Store your API key somewhere safe where you won't lose or reveal it. It is something important in security terms. If you lose it, ask to revoke the current one and generate a new one. ## Authentication with JWT[​](#authentication-with-jwt "Direct link to Authentication with JWT") For those [microfrontends](https://docs.clever.gy/developer/microfrontends/.md) that need to fetch data from our API, you have to provide a [JWT token](https://datatracker.ietf.org/doc/html/rfc7519). The following diagram explains the basic architecture of the solution. * **Your App**: This is the client that will hold all your code with Clevergy's microfrontends. It will be responsible of holding all the frontend code of the project both your code and Clevergy's microfrontends. * **Your API**: Your API should live in a server. It will hold your API key and therefore should not be accessible to the end user. Your API will be a secure proxy between Clevergy's API and your app to deliver safely the JWT. * **Clevergy Connect API**: Clevergy's Connect API has all the information needed to run and manage all microfrontends. This API can be accessed directly from your application using a user JWT to perform certain operations on behalf of the user. To obtain the JWT token, you have to use your **API key** calling to [Get user access token method of Connect API](https://docs.clever.gy/connect-api/retrieve-user-access-token). API key security Don't expose your API key to the end user. It should be stored in a secure place and used by your API to fetch the JWT. Those microfrontends that need authentication will have a `data-token` parameter that you have to set with the JWT token. Authentication example ``` ``` Token expiration After 1 hour, the token expires, so you will need to create a new one. Not all microfrontends need authentication, so check the [microfrontends catalog](https://docs.clever.gy/helpdesk/microfrontends-catalog/.md) to see if the microfrontend you are interested in needs authentication. ## Authentication login with token[​](#authentication-login-with-token "Direct link to Authentication login with token") This method allows accessing the entire webview by passing a JWT directly in the URL. To use this method, you will need your specific tenant name (`{tenant_name}`). Please [contact us](mailto:soporte.clientes@clever.gy) to obtain your assigned tenant name. ### **Paste the JWT in the URL:**[​](#paste-the-jwt-in-the-url "Direct link to paste-the-jwt-in-the-url") * **URL format:** Use the following structure, replacing `{tenant_name}` with your assigned tenant name and `your-jwt-token` with your actual JWT: ``` https://{tenant_name}.clever.gy/login-with-token?token=your-jwt-token ``` info Replace `{tenant_name}` with the actual name provided to you * **Example JWT:** ``` eyJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJodHRwczovL2lkZW50aXR5dG9vbGtpdC5nb29nbGVhcGlzLmNvbS9nb29nbGUuaWRlbnRpdHkuaWRlbnRpdHl0b29sa2l0LnYxLklkZW50aXR5VG9vbGtpdCIsImV4cCI6MTY3NTg3ODQyMiwiaWF0IjoxNjc1ODc0ODIyLCJpc3MiOiJwdWJsaWMtZnJvbnQtYmFja0BjbGV2ZXJneS5pYW0uZ3NlcnZpY2VhY2NvdW50LmNvbSIsInN1YiI6InB1YmxpYy1mcm9udC1iYWNrQGNsZXZlcmd5LmlhbS5nc2VydmljZWFjY291bnQuY29tIiwidGVuYW50X2lkIjoiaGFzdGVlLWU4MGJ3IiwidWlkIjoieWV0eXZ0eFZWaGc0bDBhSUZiSGZndDR2WFJTMiJ9.f4ZDtjdNsPslcgmCjZ_1GC3H5n9hOxFF0C1fWOLytGgGrrVR-84ARqNXPoSgV0sSWbdgr6PBwbBAcsBqmIIsCSjDN9CqOiB2Qt8x4jmGrARdawtsvy09PePAkaKQjawcemttf6vU8qbIFCfOCGfYBj8VPtuJs03t7i_urZalYk4-MFArcwYmHU_e_NJUR2ws5Wo5Pg0N4Vu-XdRpnMiGxQbsBOsXerVOp2Lii10cP7W3TYbxusJK1-103JeerVwBEEVrxjO_QNRaZzcKfEdTZxzZ2SKxw71jwBph-WFYqhV1HeYxAAnt3b9zQ4LCBPfB9ia4L5QuEnmdeDmDNmLMRg ``` * **Example of combined URL + JWT (using 'example-tenant' as `{tenant_name}`):** ``` https://example-tenant.clever.gy/login-with-token?token=eyJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJodHRwczovL2lkZW50aXR5dG9vbGtpdC5nb29nbGVhcGlzLmNvbS9nb29nbGUuaWRlbnRpdHkuaWRlbnRpdHl0b29sa2l0LnYxLklkZW50aXR5VG9vbGtpdCIsImV4cCI6MTY3NTg3ODQyMiwiaWF0IjoxNjc1ODc0ODIyLCJpc3MiOiJwdWJsaWMtZnJvbnQtYmFja0BjbGV2ZXJneS5pYW0uZ3NlcnZpY2VhY2NvdW50LmNvbSIsInN1YiI6InB1YmxpYy1mcm9udC1iYWNrQGNsZXZlcmd5LmlhbS5nc2VydmljZWFjY291bnQuY29tIiwidGVuYW50X2lkIjoiaGFzdGVlLWU4MGJ3IiwidWlkIjoieWV0eXZ0eFZWaGc0bDBhSUZiSGZndDR2WFJTMiJ9.f4ZDtjdNsPslcgmCjZ_1GC3H5n9hOxFF0C1fWOLytGgGrrVR-84ARqNXPoSgV0sSWbdgr6PBwbBAcsBqmIIsCSjDN9CqOiB2Qt8x4jmGrARdawtsvy09PePAkaKQjawcemttf6vU8qbIFCfOCGfYBj8VPtuJs03t7i_urZalYk4-MFArcwYmHU_e_NJUR2ws5Wo5Pg0N4Vu-XdRpnMiGxQbsBOsXerVOp2Lii10cP7W3TYbxusJK1-103JeerVwBEEVrxjO_QNRaZzcKfEdTZxzZ2SKxw71jwBph-WFYqhV1HeYxAAnt3b9zQ4LCBPfB9ia4L5QuEnmdeDmDNmLMRg ``` Token expiration After 1 hour, the token expires, so you will need to create a new one. ### **Access Granted**[​](#access-granted "Direct link to access-granted") Pasting the complete URL (with your valid tenant name `{tenant_name}` and token) into your browser will grant you access to the webview. --- # Entities These are the entities of Clevergy A **House** represents the end-user experience: it's just an aggregator of supply points, it doesn't hold the contract or the invoices directly. A contract generates a supply point, which is plugged into a house. ## Entities[​](#entities-1 "Direct link to Entities") | Entity | Relation | Features | | ---------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | **User** | 1 User ↔ n Contracts, 1 User ↔ n Houses | Manages contracts and houses, receives notifications, and accesses support | | **Contract** | 1 Contract ↔ 1 Supply Point | Belongs to the user and generates a supply point | | **House** | 1 House ↔ n Supply Points | Represents the end-user experience; aggregates supply points, controls energy, configures alerts, and generates leads | | **Invoices** | n Invoices ↔ 1 Contract | Invoices emitted for the contract | | **Integrations** | 1 Integration ↔ n Installations | Connects external systems for monitoring and control | | **Installation** | n Installation ↔ 1 Supply Point | Connects installation with a supply point to show your user the energy data | ## Integrations[​](#integrations "Direct link to Integrations") Check the integrations you can connect in Clevergy: [Integrations documentation](https://docs.clever.gy/helpdesk/integrations/.md) note **Supply Point** is a Clevergy's internal entity that groups the installations connected to a supply and links them to a house. It's not yet exposed as a public entity. Now that you know the entities, check [how Clevergy entities works](https://docs.clever.gy/developer/getting-started/entities/how-clevergy-entities-works.md) to understand what happens automatically when key events take place, such as creating or cancelling contracts. --- # How Clevergy entities work This section explains what happens in Clevergy when key events take place: creating or cancelling contracts, changing the holder, or deleting users and houses. It's meant to help you understand the automatic behaviors of the platform so you can operate with confidence. ## New contract[​](#new-contract "Direct link to New contract") Creating a contract for a user on a given CUPS. **What happens automatically:** * The contract **becomes active** and, if an FTP integration is created, **data starts being collected** from the contract's start date. * The end user **can see their consumption** in the app as soon as data becomes available. * If the CUPS was previously used by another client in your tenant, the new user **cannot see the previous client's data**. * If the CUPS already had an active contract, **the previous contract is automatically deactivated**. ## Change of holder[​](#change-of-holder "Direct link to Change of holder") A change of holder happens when a different user gets a contract for a CUPS that was previously active under another user. **What happens automatically:** * The previous contract is **deactivated** and **stops receiving data**. * The new contract **becomes active** and starts receiving data from its start date. * The previous user **keeps access to their historical data**. * The new user **only sees data** associated with their contract from its start date. * Solar installations set up by the commercializer using installer credentials are **not transferred automatically** to the new user. They remain available in the portal and can be assigned manually. * Devices connected personally by the previous user (solar inverters, smart devices, EVs, etc.) are **disconnected**. The new user needs to connect their own devices from the app. ## Contract cancellation[​](#contract-cancellation "Direct link to Contract cancellation") A cancellation happens when a contract ends without being replaced by a new contract. **What happens automatically:** * The contract is **deactivated**. * **Data stops being collected**. * Solar installations set up by the commercializer using installer credentials are **kept in the portal**, but are no longer linked to the user. They can be reassigned later if a new user takes over the CUPS. * Devices connected personally by the user (solar inverters, smart devices, EVs, etc.) are **disconnected**. * The user's house **becomes inactive** in the app. * Historical data **remains stored** and can still be accessed by the original user. * Once inactive, the contract **can no longer be modified**. ## User deletion[​](#user-deletion "Direct link to User deletion") **What happens automatically:** * All of the user's contracts **are deleted**, including any associated invoices. * All of the user's houses **are deleted**. Historical energy data associated with the user, including consumption and production data, **is deleted**. * All user-connected devices and their associated data **are deleted**. * The user's personal data **is removed**. ## House deletion[​](#house-deletion "Direct link to House deletion") note A house can only be deleted if it has no active contracts. **What happens automatically:** * If the house has any active contract, the deletion is **blocked**. * If all contracts are inactive, or the house has no contracts, it **can be deleted**. * All associated contracts and invoices **are deleted** as part of the operation. * All user-owned equipments connected to the house **are deleted**, as well as their data. * Tenant-owned equipments, such as solar equipment connected through installer credentials, are **not deleted**. They remain without an associated house. ## Key rules to keep in mind[​](#key-rules-to-keep-in-mind "Direct link to Key rules to keep in mind") * **One active contract per CUPS:** A CUPS can only have one active contract at a time. Creating a new one automatically deactivates the previous one. * **No active contract means no data:** Once a CUPS has no active contract, new data stops being collected. Historical data is always preserved if user or house is not deleted. * **B2C connections are personal:** Devices connected directly by the end user (solar inverters, smart devices, EVs, etc.) are disconnected when the contract is cancelled or the holder changes. The new user must connect their own devices. * **Installer solar remains available to the commercializer:** Solar installations connected using installer credentials remain in the portal after a cancellation or change of holder. The connection and all data associated with those devices are deleted. They are not automatically assigned to the new user. --- # Battery management The platform allows interacting with battery systems linked to a supply point through the Connect API. important Battery information (e.g. capacity, SOC history) is available for all users, but **battery control actions** (such as charging or discharging commands) are only available for users who have connected their system and granted permission via Huawei OAuth integration. We are actively working to support additional inverters in the near future. ## What you can do via API[​](#what-you-can-do-via-api "Direct link to What you can do via API") Through the API, you can: * **Monitor battery power** in real time, including current charging/discharging power (kW) and historical data over specified time ranges * **Access static battery information**, such as total capacity (kWh) and maximum charging/discharging power (kW) * **Retrieve battery SOC** within a defined time range, enabling historical visualization and monitoring * **Program battery operations**, by sending scheduled actions specifying time and target SOC. Actions execute automatically and end when target is reached or another action starts This enables remote battery control for energy optimization, charging during low-tariff periods, discharging during peak-price hours, or enhancing solar self-consumption. ## API Workflow[​](#api-workflow "Direct link to API Workflow") The following diagram shows the complete workflow for battery management via API: ## Example bodies for use cases[​](#example-bodies-for-use-cases "Direct link to Example bodies for use cases") ### Night Charge[​](#night-charge "Direct link to Night Charge") ``` { "actions": [{"date": "2025-10-14T01:00:00.000Z", "action": "CHARGE", "targetSOC": 80, "dispatchTimeMins": 300}] } ``` ### Peak Discharge[​](#peak-discharge "Direct link to Peak Discharge") ``` { "actions": [{"date": "2025-10-14T18:00:00.000Z", "action": "DISCHARGE", "powerKWDispatch": 3}] } ``` ### Solar Optimization[​](#solar-optimization "Direct link to Solar Optimization") ``` { "actions": [ {"date": "2025-10-14T08:00:00.000Z", "action": "CHARGE", "targetSOC": 100}, {"date": "2025-10-14T18:00:00.000Z", "action": "DISCHARGE", "targetSOC": 20}, {"date": "2025-10-14T22:00:00.000Z", "action": "CHARGE"} ] } ``` ### Full Day Schedule[​](#full-day-schedule "Direct link to Full Day Schedule") ``` { "actions": [ {"date": "2025-10-14T01:00:00.000Z", "action": "CHARGE", "targetSOC": 100, "dispatchTimeMins": 300}, {"date": "2025-10-14T08:00:00.000Z", "action": "PAUSE"}, {"date": "2025-10-14T12:00:00.000Z", "action": "CHARGE"}, {"date": "2025-10-14T18:00:00.000Z", "action": "DISCHARGE", "targetSOC": 30, "powerKWDispatch": 3} ] } ``` ## Available endpoints[​](#available-endpoints "Direct link to Available endpoints") [getTenantEquipments](https://docs.clever.gy/connect-api/get-tenant-equipments) [getStorageEquipment](https://docs.clever.gy/connect-api/get-storage-equipment) [getStorageEquipmentSoc](https://docs.clever.gy/connect-api/get-storage-equipment-soc) [scheduleStorageEquipmentAction](https://docs.clever.gy/connect-api/schedule-storage-equipment-action) --- # Contracts The platform allows managing energy contracts associated with a client through the Connect API. These contracts are visible to the client under their **[house contracts](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/house-contracts.md)**. There are two types of contracts supported: * **Electricity contracts** * **Gas contracts** ## Contract status[​](#contract-status "Direct link to Contract status") A contract can be either: * **Active**: the contract is currently in force. Data source connectors linked to it keep syncing new energy data. * **Inactive**: the contract is no longer in force. Its data source connectors are automatically unlinked - historical energy and invoice data remains available, but no new energy data will be synced. info The same CUPS can be linked to more than one user, but only one of them can have an active contract associated at the same time. When a new contract is created for a CUPS that already has an active one, the new contract becomes active and the previous one is automatically deactivated. ## Provided information to calculate costs in euros[​](#provided-information-to-calculate-costs-in-euros "Direct link to Provided information to calculate costs in euros") For electricity contracts, the pricing information provided is used by the platform to calculate the energy costs in euros (€) displayed to the client in the application based on their consumption data. See **[Costs in euros](https://docs.clever.gy/helpdesk/app/euros/.md)** for how the calculation works and which microfrontends show it. info Costs calculation (€) is only available for electricity contracts with tariff access 2.0TD. ## Electricity contracts[​](#electricity-contracts "Direct link to Electricity contracts") The information displayed in the app and used for price calculations comes directly from the contract endpoint. For power prices, you can provide a list with either 2 or 6 values, depending on the `tariffAccess` (2.0TD or 3.0TD / 6.1TD). The **tariff type** is also critical because it determines how prices should be filled. for both `energyPrices` and `surplusPrices`. | Type | Description | How to Fill | | ----------- | ------------------------------------------------------------ | ---------------------------------------------- | | **FIXED** | Prices are constant 24h everyday | List with one value: `[0.12]` | | **PERIOD** | Prices differ by consumption period | List with three/six values: `[0.18,0.12,0.09]` | | **PVPC** | Prices are automatically calculated based on the market PVPC | No need to fill (retrieved automatically) | | **INDEXED** | Prices depend on utility parameters and OMIE | No need to fill (retrieved automatically) | | **CUSTOM** | Prices must be added separately to the contract | No need to fill (see below) | ### Adding custom energy prices to a contract[​](#adding-custom-energy-prices-to-a-contract "Direct link to Adding custom energy prices to a contract") If your contract has **custom pricing** (e.g., hourly prices or any structure other than fixed or period), you can attach a pricing table via a secondary request using the `contractId` returned after contract creation. Each entry should include: * `date`: start of the pricing interval (format: `YYYY-MM-DDTHH:mm:ss`) * `price`: energy price for that interval, in euros per kWh (decimal format) * `surplusPrice`: surplus price for that interval, in euros per kWh (decimal format) ## Gas contracts[​](#gas-contracts "Direct link to Gas contracts") The information displayed in the app comes directly from the contract endpoint. ## How to upload the contract PDF for the client[​](#how-to-upload-the-contract-pdf-for-the-client "Direct link to How to upload the contract PDF for the client") After creating a contract, the response will include a `fileUrl`. This is a **signed URL** to upload the contract file. warning The upload link is temporary, so make sure to upload the PDF file immediately after receiving it. Only PDF files are allowed. Once the file is uploaded, the client can **download the PDF directly** from the app. ## Endpoints needed[​](#endpoints-needed "Direct link to Endpoints needed") [createElectricityContract](https://docs.clever.gy/connect-api/create-electricity-contract) [addContractEnergyPrices](https://docs.clever.gy/connect-api/add-contract-energy-prices) [createGasContract](https://docs.clever.gy/connect-api/create-gas-contract) --- # Create a new client This guide explains the minimum required flow to onboard a customer in Clevergy under the *Plan Starter*. ## Steps to create a client with contracts and invoices[​](#steps-to-create-a-client-with-contracts-and-invoices "Direct link to Steps to create a client with contracts and invoices") 1. **Create the client:** start by entering the client's personal data to generate a `userId`. 2. **Create a [contract](https://docs.clever.gy/developer/how-to-set-up/contracts.md):** use the `userId` to create at least one contract (either electricity or gas), which will generate a `contractId`. 3. **Create [invoices](https://docs.clever.gy/developer/how-to-set-up/invoices.md):** use the `contractId` to upload invoices associated with the contract. To retrieve energy consumption data, an **[additional integration](https://docs.clever.gy/helpdesk/integrations/.md)** is required. In most cases, Clevergy connects directly to the distributor using the `CUPS` identifier, allowing consumption data to be automatically obtained for the supply point. ## Endpoints needed[​](#endpoints-needed "Direct link to Endpoints needed") [createUser](https://docs.clever.gy/connect-api/create-user) [createElectricityContract](https://docs.clever.gy/connect-api/create-electricity-contract) [createGasContract](https://docs.clever.gy/connect-api/create-gas-contract) [createInvoice](https://docs.clever.gy/connect-api/create-invoice) --- # Create new solar client This guide explains the minimum required flow to onboard a customer in Clevergy under the *Plan Pro*. ## Steps to create a client with a solar installation[​](#steps-to-create-a-client-with-a-solar-installation "Direct link to Steps to create a client with a solar installation") 1. **Create a [client](https://docs.clever.gy/developer/how-to-set-up/create-client.md):** start by creating a client with an electricity contract. 2. **Create a [solar API integration](https://docs.clever.gy/developer/how-to-set-up/solar-api-integration.md)**: * If the inverter uses **user credentials**, the customer must complete the integration from the app. * If the inverter uses **installer credentials**, set it up from the [portal integrations](https://docs.clever.gy/helpdesk/integrations/inverters/.md) by providing the required details for each inverter. If you use **installer credentials**, once the integration is created and after the required waiting time for each inverter, you will retrieve all installation data. To make it visible to the client in the app, you need to link it to the house. This can be done either **[through the portal](https://docs.clever.gy/helpdesk/portal/my-data/installations/link-installation.md)** or via **Connect Api**: 3. **Retrieve installation data:** use the `name` or `plantCode` to search for installation metadata, including the `installationId`, which will be needed to link it to the house. 4. **Obtain the houseId:** use the `userId` to retrieve the client's houses, then select the `houseId` where you want to link the installation. 5. **Link the solar installation to the house:** finally, connect the solar installation using `installationId` to the `houseId` to enable your client monitoring of all inverter data, including energy production, consumption, real-time power, and solar savings. ## Endpoints needed[​](#endpoints-needed "Direct link to Endpoints needed") [getInstallations](https://docs.clever.gy/connect-api/get-installations) [getUserSupplies](https://docs.clever.gy/connect-api/get-user-supplies) [connectInstallation](https://docs.clever.gy/connect-api/connect-installation) --- # Invoices This guide explains how to create and upload an invoice associated with an existing contract. It assumes that both the user and the contract (`contractId`) have already been created. ## How it works[​](#how-it-works "Direct link to How it works") To create an invoice, you need to send a `POST` request to the corresponding endpoint using the `contractId`. The API response will return a `fileUrl`. This is a **signed URL** to upload the invoice file. warning The upload link is temporary (15 minutes), so make sure to upload the PDF file immediately after receiving it. If the PDF is not uploaded, the invoice will not be processed and will not be available to the customer. ## Type of invoices[​](#type-of-invoices "Direct link to Type of invoices") The system supports several types of invoices. Each invoice type (`ELECTRICITY`,`GAS` or `OTHER`) has specific fields that are **optional**, but it is **highly recommended** to include them to enable the invoice breakdown in the **[invoice microfrontend](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/invoices.md)** for electricity and consumptions for gas. ### Common fields for all invoices[​](#common-fields-for-all-invoices "Direct link to Common fields for all invoices") These fields are required for all types of invoices: * `issueDate`: the date the invoice was issued. * `invoicePeriodFrom`: start date of the billing period. * `invoicePeriodTo`: end date of the billing period. * `type`: invoice type, e.g., `ELECTRICITY`, `GAS`, `WATER` or `OTHER`. * `cost`: total cost of the invoice. * `externalId`: invoice external number * `obtainMethod`: method used to calculate consumption. Can be `REAL` or `ESTIMATED`. ### Electricity invoices[​](#electricity-invoices "Direct link to Electricity invoices") tip For electricity invoices, this additional information enables the invoice breakdown feature, helping reduce support tickets related to billing questions. * `powerCost`: cost of the contracted power. * `totalEnergyConsumption`: total energy consumption. * `energyCost`: cost of the energy consumed. * `totalEnergySurplus`: total energy surplus. * `surplusSaving`: savings from surplus energy. * `otherCost`: any other applicable costs (e.g. taxes) * `discountSaving`: any applicable discount savings. * `virtualWallet`: amount credited/used to/from the virtual wallet. And for pymes also: * `reactiveEnergyCost`: cost for reactive energy. * `excessPowerCost`: cost for exceeding contracted power. ### Gas invoices[​](#gas-invoices "Direct link to Gas invoices") tip For gas, consumption is calculated based on the values provided in the invoice, so it is important to include them. If `obtainMethod` is set to `ESTIMATED`, the system will notify the customer when multiple estimated invoices are issued consecutively. * `totalEnergyConsumption`: total energy consumption. ## Endpoints needed[​](#endpoints-needed "Direct link to Endpoints needed") [createInvoice](https://docs.clever.gy/connect-api/create-invoice) --- # Obtain energy data from my clients All steps needed to create a new client and obtain his energy data. ## Guide to create a new client to obtain his energy data[​](#guide-to-create-a-new-client-to-obtain-his-energy-data "Direct link to Guide to create a new client to obtain his energy data") 1. **Create a [client](https://docs.clever.gy/developer/how-to-set-up/create-client.md) or [solar client](https://docs.clever.gy/developer/how-to-set-up/create-solar-client.md):** start by creating a client and an integration to associate an energy data source. This could be with a solar inverter, an FTP from the distributor, or Datadis. 2. **Obtain the houseId:** use the `userId` to retrieve the client's houses, then select the `houseId` from you want to obtain energy data. 3. **Get energy data**: Use `houseid` to obtain the energy information of the house such as solar production, grid export, house consumption or energy charged or discharged from batteries. ## Endpoints needed[​](#endpoints-needed "Direct link to Endpoints needed") [getUserSupplies](https://docs.clever.gy/connect-api/get-user-supplies) [getEnergyByHouseId](https://docs.clever.gy/connect-api/get-energy-by-house-id) --- # Create sales opportunities integration via Connect All steps needed to integrate sales opportunities with a client CRM or sales platform using the Connect API. ## Webhook setup[​](#webhook-setup "Direct link to Webhook setup") Configure a `sales-opportunity` webhook endpoint to listen to sales opportunity events generated by Clevergy. Clevergy sends a webhook whenever a sales opportunity changes: * `CREATE` : A new sales opportunity is generated (e.g. a user starts a contracting flow from the app) * `UPDATE` : A sales opportunity is updated (status change) * `DELETE` : A sales opportunity is deleted note Webhooks are event notifications only. Sales opportunity data must always be retrieved via the Connect API. Currently, only `CONTRACT` product opportunities are supported. Other product values (`SOLAR`, `HEATPUMP`, `BATTERY`, `DEVICES`, `EV`, `OTHER`) are reserved for future use. ## Sales opportunity statuses[​](#sales-opportunity-statuses "Direct link to Sales opportunity statuses") | Status | Meaning | | ------------ | ------------------------------------------------------------------------------------------------------------------------------ | | `STARTED` | The user has initiated the opportunity by showing interest in a product (e.g. via a recommender or banner in the app). | | `POTENTIAL` | The opportunity was proactively suggested by Clevergy based on energy data and user behavior, without direct user interaction. | | `FORMALIZED` | The user has accepted a contract or proposal. | | `CONVERTED` | The payment has been received and the product or service is being delivered (e.g. the contract has been signed). | | `REJECTED` | The opportunity was lost, either because the user declined or stopped responding. | ## Sales opportunity flow[​](#sales-opportunity-flow "Direct link to Sales opportunity flow") This section describes a typical end-to-end flow for a `CONTRACT` sales opportunity. 1. **A sales opportunity is created** * **Webhook event:** `CREATE` 2. **Retrieve the opportunity details** * When a sales opportunity webhook event is triggered, fetch the full details via the Connect API using the `id` included in the webhook payload. * For `CONTRACT` opportunities, this includes the contracting payload fields (contact data, CUPS, IBAN, invoice references, etc.). 3. **List opportunities from your platform** * Use the list endpoint to retrieve all sales opportunities for the tenant, optionally filtered by `status` or `product`. 4. **Update the opportunity status** * As the opportunity progresses through your sales process, update its status (e.g. to `FORMALIZED` or `CONVERTED`). 5. **Reject or discard the opportunity (optional)** * Update the status to `REJECTED` if the opportunity does not move forward. 6. **Delete the opportunity (optional)** * Hard-deletes the opportunity and cascades the deletion to its related notes. ## Required endpoints[​](#required-endpoints "Direct link to Required endpoints") [getSalesOpportunities](https://docs.clever.gy/connect-api/get-sales-opportunities) [getContractSalesOpportunity](https://docs.clever.gy/connect-api/get-contract-sales-opportunity) [patchContractSalesOpportunity](https://docs.clever.gy/connect-api/patch-contract-sales-opportunity) [deleteSalesOpportunity](https://docs.clever.gy/connect-api/delete-sales-opportunity) --- # Solar API integration This guide explains the minimum required flow to onboard a client and connect a solar installation using Clevergy’s Solar API. ## Steps to create a solar client[​](#steps-to-create-a-solar-client "Direct link to Steps to create a solar client") 1. [Create the client](https://docs.clever.gy/connect-api/create-user): start by entering the client's personal data to generate a `userId`. 2. [Create a home](https://docs.clever.gy/connect-api/create-house): use the `userId` to create a supply point, which will generate a `houseId`. 3. Connect the solar inverter: the available integration flow depends on the inverter manufacturer. Some providers support installer-based integrations, others require user authorization, and some support both methods. A. **Installer credentials flow:** the solar integration is configured directly from the Clevergy Portal using installer credentials. Once configured: * **Retrieve installation data**: use the name or plantCode to search for installation metadata, including the installationId, which will be needed to link it to the house * **Obtain the houseId**: use the userId to retrieve the client's houses, then select the houseId where you want to link the installation. * **Link the solar installation to the house**: finally, connect the solar installation using installationId to the houseId to enable your client monitoring of all inverter data, including energy production, consumption, real-time power, and solar savings. note Some providers may limit advanced capabilities, such as battery control, when using installer credentials. B. User credentials flow: use [Clevergy's microfrontend](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-solar-inverter.md) to allow the user to securely connect their inverter. This requires the user token and the `houseId`. Once the authorization is completed, the installation is automatically linked to the user’s home. ## Accessing solar data[​](#accessing-solar-data "Direct link to Accessing solar data") After the inverter is connected, solar data becomes available through the Connect API. 1. [Get installation details](https://docs.clever.gy/connect-api/get-installations): retrieve general information about the solar installation, including metadata and linked equipment 2. [Get energy data](https://docs.clever.gy/connect-api/get-energy-by-house-id): retrieve production, consumption and self-consumption breakdown. 3. [Get power data](https://docs.clever.gy/connect-api/get-power-by-house-id): retrieve real-time power measurements. 4. [Manage battery](https://docs.clever.gy/developer/how-to-set-up/battery-management.md) (if available): retrieve battery status and configure charge/discharge behavior. ## Endpoints needed[​](#endpoints-needed "Direct link to Endpoints needed") [createUser](https://docs.clever.gy/connect-api/create-user) [createHouse](https://docs.clever.gy/connect-api/create-house) [connectInstallation](https://docs.clever.gy/connect-api/connect-installation) [getInstallations](https://docs.clever.gy/connect-api/get-installations) [getEnergyByHouseId](https://docs.clever.gy/connect-api/get-energy-by-house-id) [getPowerByHouseId](https://docs.clever.gy/connect-api/get-power-by-house-id) --- # Create ticket integration via Connect All steps needed to integrate the ticket system with a client support platform (e.g: CRM) using Connect API. ## Webhook setup[​](#webhook-setup "Direct link to Webhook setup") Configure a ticket webhook endpoint to listen to ticket events generated by Clevergy. Clevergy sends a webhook whenever a ticket changes: * `CREATE` : A user creates a new ticket from the app * `UPDATE` : A ticket is updated (new comment, status change) * `DELETE` : A ticket is deleted Webhooks are event notifications only. Ticket data must always be retrieved via the Connect API. ## Ticket statuses (proposed model)[​](#ticket-statuses-proposed-model "Direct link to Ticket statuses (proposed model)") Clevergy provides the following ticket statuses. Clients are free to implement their own logic. | Status | Meaning | | | --------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | `NEW` | New ticket created | User cannot interact until support replies | | `OPEN` | Pending operator response | User cannot interact until support replies | | `PENDING` | Support replied | Support has replied and the system is waiting for the user’s response. The user can reply from the app | | `SOLVED` | Issue resolved | User can confirm whether the issue has been resolved. If not, they can reply with additional details to continue the conversation within the same ticket | | `CLOSED` | Ticket closed | The user can no longer reply from the app. The ticket lifecycle is complete | ## Ticket flow[​](#ticket-flow "Direct link to Ticket flow") This section describes a typical end-to-end flow using the proposed status model. 1. **User creates a ticket from the app** * **Webhook event:** `CREATE` * **Ticket status:** `NEW` 2. **Retrieve ticket details** * When a ticket webhook event is triggered, fetch the full ticket information via Connect API using the `ticketId` included in the webhook payload. 3. **Reply to tickets from your platform** * Use the Connect API endpoint to add comments to tickets directly from your support tool. * **Proposed status after reply:** `PENDING` 4. **User replies from the app** * A user reply resets the flow and signals that new support action is required. * **Webhook event:** `UPDATE` * **Status updates to**: `OPEN` 5. **Support continues the conversation (optional)** * Support may: * Add additional comments * Set status back to `PENDING` while waiting for the user 6. **Resolve the ticket** * Once the issue is resolved: * **Proposed status:** `SOLVED` * At this stage, the user can confirm whether the issue has been resolved (**Yes / No**). * If the user indicates the issue is **not resolved**, they can reply with more details and the ticket status is updated to `PENDING` . Once reopened, normal webhook and Connect API flows apply * If the user confirms the issue **is resolved**, the ticket status is updated to `CLOSED`. 7. **Close the ticket** * After confirmation or internal validation: * **Final status:** `CLOSED` ## Required endpoints[​](#required-endpoints "Direct link to Required endpoints") [getTicketDetails](https://docs.clever.gy/connect-api/get-ticket-details) [addCommentToTicket](https://docs.clever.gy/connect-api/add-comment-to-ticket) [updateTicket](https://docs.clever.gy/connect-api/update-ticket) --- # Virtual balance The platform allows managing the virtual balance from the Connect API. important The virtual balance can be of type **wallet** or **battery**. The **wallet** unit is in **euros (EUR)** and the **battery** unit is in **kilowatt-hours (kWh)**. This has been developed this way because there are clients who manage the virtual balance in different currencies. After updating, this balance can be viewed both in the portal, for management by an operations person, and in the mobile application, where the client can visualize it. ## Wallet operations[​](#wallet-operations "Direct link to Wallet operations") Overview of wallet-related operations. [createVirtualWalletTransaction](https://docs.clever.gy/connect-api/create-virtual-wallet-transaction) ## Battery operations[​](#battery-operations "Direct link to Battery operations") Overview of battery-related operations. [createVirtualBatteryTransaction](https://docs.clever.gy/connect-api/create-virtual-battery-transaction) --- # Microfrontends ## What is a microfrontend?[​](#what-is-a-microfrontend "Direct link to What is a microfrontend?") A **"microfrontend"** is the simplest way to bring you [our functionalities](https://docs.clever.gy/helpdesk/microfrontends-catalog/.md) to your application. * **Technologies**: Our microfrontends are built using web technologies (HTML, CSS, JavaScript) so they can be used in any website or any application (mobile, desktop, etc.) that can embed webviews. The base of all of them is a `webcomponent` container. Inside this container it will render a React tree of components. * **Data and Authentication**: All the data is fetched directly from our API so you don't need to provide any data to the microfrontend aside from the input parameters. In those cases where the microfrontend needs to fetch API data owned by a user, you will need to [provide a JWT token](https://docs.clever.gy/developer/getting-started/authentication.md#authentication-with-jwt) previously obtained from the Connect API using your API key (server to server authentication). * **Styling**: The CSS applied to the page where the microfrontend is inserted does not affect the microfrontend itself and vice versa. There are some CSS variables available to customize the microfrontend to your needs. * **Events**: The microfrontend could emit events to notify the parent application about something that happened inside it in some cases. We provide a way to listen to those events from the parent application. ## Getting started with microfrontends[​](#getting-started-with-microfrontends "Direct link to Getting started with microfrontends") ### Add the script to your application[​](#add-the-script-to-your-application "Direct link to Add the script to your application") In order to be able to use any of our microfrontends, you just need to add the following script to your web page or the webview where the microfrontend will be inserted. Inside the `` tag is the best place for it. Add the script to your application ``` ``` The inserted script will define all the microfrontends so you can use them anywhere in your web page or the webview. ### Insert the microfrontend in your application[​](#insert-the-microfrontend-in-your-application "Direct link to Insert the microfrontend in your application") All our microfrontends are based in a webcomponent that you can insert by using a simple tag and some parameters such as this: Microfrontend example ``` ``` That one is just an example. Each microfrontend has its own name and parameters. Check the [microfrontends catalog](https://docs.clever.gy/helpdesk/microfrontends-catalog/.md) for more information about each microfrontend, its parameters, CSS variables and events. ### Customizing the style[​](#customizing-the-style "Direct link to Customizing the style") In order to customize the style of the microfrontends, you can use the following CSS variables. Clevergy variables are typed with the `--clevergy` prefix to avoid collisions with your local CSS styles. #### Common CSS variables[​](#common-css-variables "Direct link to Common CSS variables") This common CSS variables are used along our design system. Common CSS variables ``` ``` info If you don't define any CSS variables, it will use our default values. #### Customizing the style of a specific microfrontend[​](#customizing-the-style-of-a-specific-microfrontend "Direct link to Customizing the style of a specific microfrontend") As `:root` variables are global, they will affect all the microfrontends. If you need to customize the style of a specific microfrontend, you can use the tag name to scope the CSS variables to the microfrontend. Customize the style of a microfrontend ``` ``` #### Specific microfrontend CSS variables[​](#specific-microfrontend-css-variables "Direct link to Specific microfrontend CSS variables") There are some microfrontends that have specific CSS variables, so check the [microfrontends catalog](https://docs.clever.gy/helpdesk/microfrontends-catalog/.md) to see if the microfrontend you are interested in has specific CSS variables. info If there are specific variables that you wish to control, reach out to your CSM so that we can offer a solution. ### Listening to events[​](#listening-to-events "Direct link to Listening to events") When a microfrontend needs to notify the parent application about something that happened inside it, it will emit an event. You can listen to those events by using the `clevergy_subscribeToEvent` function. Because the function `clevergy_subscribeToEvent` is only available after our JS script is fully loaded, it's recommended to call it on the `window.load` event: Listening to events ``` ``` Not all microfrontends emit events, so check the [microfrontends catalog](https://docs.clever.gy/helpdesk/microfrontends-catalog/.md) to see if the microfrontend you are interested in emits events. ### Language[​](#language "Direct link to Language") All microfrontends are shown in Spanish by default. To specify the language there is an optional parameter for it named `data-language` which allows these values: * `es-ES` Spanish (by default) * `ca-ES` Catalán * `gl-ES` Gallego * `eu-ES` Basque * `en-US` American English Language example ``` ``` ### Authentication[​](#authentication "Direct link to Authentication") For those microfrontends that need to fetch data from our API, you have to provide a [JWT token](https://datatracker.ietf.org/doc/html/rfc7519). To pass the JWT Token to the microfrontend, you have to set a `data-token` parameter with the JWT token value. **Go to [Authentication section](https://docs.clever.gy/developer/getting-started/authentication.md#authentication-with-jwt) to see how to get a JWT token.** Authentication example ``` ``` Token expiration After 1 hour, the token expires, so you do need to create another new one. Not all microfrontends need authentication, so check the [microfrontends catalog](https://docs.clever.gy/helpdesk/microfrontends-catalog/.md) to see if the microfrontend you are interested in needs authentication. --- # Include energy prices microfrontend This is a guide to help you integrate the prices microfrontend in your application. ## Insert the microfrontend[​](#insert-the-microfrontend "Direct link to Insert the microfrontend") You are ready to include the prices microfrontend inside your application. To do so, you can add this snippet inside the section where the prices microfrontend will be. Insert the microfrontend ``` ``` You should view this microfrontend in your application now. ## Customizing the microfrontend[​](#customizing-the-microfrontend "Direct link to Customizing the microfrontend") All microfrontends allow you to customize them using different parameters. Try adding the surplus to that microfrontend by setting the `data-show-energy-price-surplus` to `true` and see what happens. Show surplus prices enabled ```
``` # Changing the language All microfrontends are shown in Spanish by default. To specify the language there is an optional parameter for it named `data-language` which allows these values: * `es-ES` Spanish (by default) * `ca-ES` Catalán * `gl-ES` Gallego * `eu-ES` Basque * `en-US` American English Catalan example ```
``` --- # Include integration smartmeter microfrontend This is a guide to help you integrate the microfrontend that authorizes the connection with Datadis. ## Insert the microfrontend[​](#insert-the-microfrontend "Direct link to Insert the microfrontend") You can insert the `` microfrontend by passing the JWT in the `data-token` parameter. Check the [Authentication section](https://docs.clever.gy/developer/getting-started/authentication.md#authentication-with-jwt) to see how to get a JWT token. Insert the microfrontend ``` ``` You should see this microfrontend in your application info What you see above is just an example with mock data. You should insert the microfrontend in your application. --- # Help desk This reference is your key to a comprehensive understanding of the Clevergy functionality. **Portal (for administrators):** Find documentation about the web portal, designed for administrators. It covers how to handle workspaces, sales opportunities and support tickets, how to access your core business information and management tools, or how to configure your account. **App (for end users):** Explore guides and FAQs for the Clevergy mobile app, aimed at end users. This section covers notifications, authorizations, onboarding, and tips to optimize your experience. **WhatsApp:** Explore what functionalities are available through WhatsApp channel, how the phone integration with your ERP/CRM works, and what queries can be performed. **Microfrontends catalog:** Discover detailed explanations of the different microfrontends available in Clevergy, for energy optimization, energy insights, or real-time device monitoring. **Integrations:** Learn about the available integrations (such as Shelly, Datadis, and inverters) and find instructions on how to set them up from both the portal (for administrators) and the app (for end users). --- # Authorizations With this feature, any Clevergy user can authorize another user to access the information of one of their homes within the app. This makes it easier to share energy data with employees, family members or any trusted person. ## How it works[​](#how-it-works "Direct link to How it works") * A primary user can authorize another user to view the information of a home within the app. * If the primary user has multiple homes, they can choose which ones to grant access to. * The authorized user will be able to see all the information of the assigned home within the app. ## Important considerations[​](#important-considerations "Direct link to Important considerations") * If the authorized user does not have an existing Clevergy account, one will be created automatically, and they will receive a welcome email. This email will include a link to download the app and a magic link for easy login. * An authorized user cannot authorize a third user. Only the primary user has the ability to manage authorizations. * The primary user can revoke authorization at any time. Once revoked, the authorized user will no longer have access to the home's information. ## How do I authorize another user?[​](#how-do-i-authorize-another-user "Direct link to How do I authorize another user?") To authorize another user, follow these steps: 1. Access the **Profile** tab in the app. 2. Select **Shared Access**. 3. Select the home you want to authorize and click on **Grant access to another person**. 4. Enter the email of the person you want to authorize and accept the terms. When finished, click on **Create shared access**. 5. If the user has an account, they will immediately be able to see your home’s information. If the user does not have an account, they will receive a welcome email with instructions. --- # Costs in euros ## Description[​](#description "Direct link to Description") **Calculating costs in euros** allows end users to visualize their energy consumption (kWh) converted to monetary costs (€). This feature helps users understand their expenses. ## Requirements[​](#requirements "Direct link to Requirements") To ensure the euros functionality works correctly for your users, they must meet the following requirements: ### **1. Active electricity contract**[​](#1-active-electricity-contract "Direct link to 1-active-electricity-contract") Users must have an active electricity contract in the app. warning For now, this functionality is only available for contracts with 2.0TD tariff access. Gas contracts are not supported yet. ### **2. Contract configured with its prices**[​](#2-contract-configured-with-its-prices "Direct link to 2-contract-configured-with-its-prices") The contract must be configured with its correct import and surplus tariffs, and with its prices for both power and energy, depending on the tariff. Contracts are usually retrieved from your ERP. If you send them through the Connect API, you can configure them there. See **[Contracts](https://docs.clever.gy/developer/how-to-set-up/contracts.md)** in the developer guide. The following information must be accurately set up: **Tariff type:** * **Import**: the tariff type for the energy the user consumes from the grid * **Surplus**: the tariff type for the energy the user exports to the grid **Fixed costs:** * **Contracted power**: the maximum power (kW) contracted with the energy provider * **Power tariff**: daily cost per kW of contracted power **Variable costs:** * **Price per kWh**: the cost per kilowatt-hour of energy consumed, according to the type of tariff (see the table below) tip The tariff types described below apply to both `importTariffType` and `surplusTariffType`. Each one is independent, so a contract can use a different type for import and for surplus. | Tariff type | Price used for each hour | | ----------- | ------------------------------------------------------------------------------------------ | | **FIXED** | The same price for all hours. | | **PERIOD** | The same price for every hour of each period (peak, flat, off-peak). | | **PVPC** | The regulated PVPC price for that hour, which Clevergy retrieves automatically. | | **INDEXED** | The OMIE price of that hour, applying the formula of each energy retailer: `A * OMIE + B`. | | **CUSTOM** | The prices sent to the contract by your ERP or through the Connect API. | For **INDEXED** tariffs, you need to provide us with the formula of estimation costs (the values of **A** and **B**). Already billed prices can also be loaded into the contract, through your ERP or the Connect API, so the calculation uses the prices of the invoice. ## How cost is calculated[​](#how-cost-is-calculated "Direct link to How cost is calculated") We use the energy data received from the distributor and calculate, hour by hour, the fixed costs and the variable costs separately. The sum of both gives the cost in euros. ### **Fixed costs**[​](#fixed-costs "Direct link to fixed-costs") Fixed costs do not depend on the energy consumed: * **Contracted power**: the power (kW) contracted by the user * **Power tariff**: the price of the contracted power, in €/kW/day * **Social bonus financing**: the cost is 0.024688 €/day * **Equipment rental**: the cost is 0.0266 €/day * **Electricity tax (IE)**: 5.113% * **VAT**: 21% ``` Hourly fixed cost = { [ (Contracted kW * Power tariff) / 24 + (Social bonus financing €/day / 24) ] * (1 + IE) + (Equipment rental / 24) } * (1 + VAT) ``` ### **Variable costs**[​](#variable-costs "Direct link to variable-costs") Variable costs depend on the energy consumed each hour and the price per kWh of import and surplus. * **Energy import**: kWh consumed \* import price per kWh. * **Energy surplus**: kWh exported \* surplus price per kWh. ``` Hourly energy import = (kWh imported * Import price) * (1 + IE) * (1 + VAT) Hourly energy surplus = (kWh exported * Surplus price) * (1 + IE) * (1 + VAT) ``` info Import and surplus are calculated separately. When we show the result to the end user, the variable cost is import minus surplus, with a minimum of 0, so it is never negative. This minimum only applies to the variable costs, not to the fixed costs. ## Microfrontends that include Euros[​](#microfrontends-that-include-euros "Direct link to Microfrontends that include Euros") The following app microfrontends include the euros functionality for your users: * **[Invoice estimation](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/invoice-estimation.md)**: users can see how much they have spent in the current billing period and the estimate of their next bill * **[Alerts settings](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-optimization-recommendations/alerts-settings.md)**: users can set spending limits in euros and receive notifications * **[Solar amortization](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/solar-amortization.md)**: users can see the savings of their solar installation in euros and when it will pay for itself These microfrontends also include euros and are still active, but **they will be deprecated soon**: * **[Energy chart](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/energy-chart.md)**: users can see the evolution of their expenses in euros over time * **[Consumption breakdown](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/breakdown.md)**: users can analyze what part of their bill corresponds to each type of expense ## Frequently asked questions[​](#frequently-asked-questions "Direct link to Frequently asked questions") ### **Why don't the euros in the app match my users' bills?**[​](#why-dont-the-euros-in-the-app-match-my-users-bills "Direct link to why-dont-the-euros-in-the-app-match-my-users-bills") The euros in the app are calculated from the distributor's energy data and the prices configured in the contract. Any differences with actual bills are typically due to billing periods or specific contract terms that may vary from the calculation used in the app. That is why we always talk about an "estimated value": the euros are a reference to understand expenses, not an exact match to the cent with the bill. ### **Why do the costs have a delay?**[​](#why-do-the-costs-have-a-delay "Direct link to why-do-the-costs-have-a-delay") Hourly consumption comes from the distributor, and distributors send it with an average delay of between 2 and 7 days. The costs in the app are calculated from that data, so they are updated once the distributor sends it. ### **Can my users set custom spending limits?**[​](#can-my-users-set-custom-spending-limits "Direct link to can-my-users-set-custom-spending-limits") Yes, users can configure spending alerts by going to **My profile** → **Alerts Settings**, setting limits in euros for different periods, and receiving notifications when they exceed them. ### **Do the euros include all costs from my users' bills?**[​](#do-the-euros-include-all-costs-from-my-users-bills "Direct link to do-the-euros-include-all-costs-from-my-users-bills") Almost all of them. The euros include: * Energy imported and energy surplus * Contracted power * Social bonus financing * Equipment rental * Taxes The euros do not include the discounts and credits applied from the **[virtual battery](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/virtual-battery.md)**. If you have any other questions, contact our support team. --- # Exhibition mode This feature allows users with photovoltaic installations to create a public-facing "exhibition view" showcasing key performance indicators, real-time data and positive impact of their system. This mode is specifically designed to meet the requirements of publicly displaying funded projects, making it ideal for sharing on a television or any public screen. ## How to create an exhibition view[​](#how-to-create-an-exhibition-view "Direct link to How to create an exhibition view") info This feature is exclusively available on tablets and desktop versions of the application. 1. On the main dashboard, for a house with photovoltaic panels, click on the "**More**" option. 2. From the dropdown menu, select "**Exhibition Mode**". Upon selecting "Exhibition Mode", you will be prompted to configure the following: * **Display name:** enter the name you want to be displayed prominently on the exhibition view. * **Subtitle:** provide a brief subtitle or description to further contextualize the display. Once the name and subtitle are entered, the exhibition view will be generated, displaying the following information: * **[Real-time installation data](https://docs.clever.gy/helpdesk/microfrontends-catalog/real-time-monitoring-devices-control/solar-real-time.md)**: live power data reflecting the current status of the photovoltaic system. * **[Today's power data](https://docs.clever.gy/helpdesk/microfrontends-catalog/real-time-monitoring-devices-control/power-chart.md):** a summary of the energy production and consumption for the current day. * **[Current month's energy summary](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/solar-summary.md):** an overview of the energy generated, consumed, and the balance for the current month. * **Key performance indicators (KPIs):** * Consumption: total energy consumed this month and year. * Production: total energy generated by the solar panels this month and year. * CO2 emission reduction: estimated amount of carbon dioxide emissions avoided due to solar energy generation this month and year. ## Displaying the exhibition view:[​](#displaying-the-exhibition-view "Direct link to Displaying the exhibition view:") The generated "Exhibition Mode" view is designed to be easily displayed on a television screen, public display, or any other type of monitor. Simply access the generated link on the desired screen to showcase the real-time performance and impact of the solar installation. ## Default logos (mandatory for funded projects)[​](#default-logos-mandatory-for-funded-projects "Direct link to Default logos (mandatory for funded projects)") The exhibition view will automatically display the following logos, fulfilling the requirements for publicly acknowledging funding: * Funded by the EU * Ministry for Ecological Transition and the Demographic Challenge * IDAE * Recovery, Transformation and Resilience Plan ### Adding your institution's logo[​](#adding-your-institutions-logo "Direct link to Adding your institution's logo") Currently, the option to automatically upload your institution's logo to the exhibition view is not available. To include your logo, please follow the standard support ticket creation process, specifying that you would like your logo added to your "Exhibition Mode" view. Our support team will assist you with this request. --- # Global view Global view provides a consolidated overview of all your supply points, allowing you to monitor aggregated energy consumption and production at a glance. This feature is designed for both companies managing multiple installations and residential users with more than one home. ## How it works[​](#how-it-works "Direct link to How it works") **Aggregated data**
When you have two or more supply points, Global view automatically aggregates the total consumption and production data for each period. **Monthly navigation**
A date selector lets you easily switch between months, enabling you to review historical performance and make comparisons. **Side-by-side comparison**
Compare energy metrics across all your supply points in one unified view, so you can quickly identify performance differences. ## Visual components[​](#visual-components "Direct link to Visual components") **Global KPIs**
The dashboard displays key performance indicators summarizing total energy consumption and production. **Interactive charts**
Consumption and production charts provide visual insights into trends over time. These charts are interactive, allowing you to hover over data points for more details. ## How to access global view[​](#how-to-access-global-view "Direct link to How to access global view") **Eligibility**
This feature is available only to users with two or more supply points. Users with a single supply point will not see this view. **Navigation**
Access Global view via the main dashboard or within the analysis section of the app. The traditional house selector has been removed in favor of a unified view, and settings are now split into user-level and supply point (house) configurations. ## Important considerations[​](#important-considerations "Direct link to Important considerations") **Target audience** * Companies managing multiple installations. * Residential users with more than one home. **Data comparison**
Global view allows for quick and effective comparisons between supply points, providing a clear overview of overall energy performance. **Timezone handling**
All data displayed in the app is shown in the local time of the house. This ensures that energy consumption and production data reflects the actual time periods when energy was used or generated at each location. --- # Help (support tickets) Through the *Help* module in the app, clients can send support tickets digitally. This simplifies the management of customer issues by avoiding phone calls and centralizing all communication in a single place, improving the relationship between the customer and the utility. Once a ticket is created, it is sent to the support team. The request can be managed either from the **[portal](https://docs.clever.gy/helpdesk/portal/workspaces/support-tickets/.md)** or directly from your own CRM, which could be integrated through our **[webhook system](https://docs.clever.gy/developer/how-to-set-up/ticket-integration.md)**. ## Types of issues[​](#types-of-issues "Direct link to Types of issues") Clients can create different types of support tickets depending on their needs. ### Predefined issues[​](#predefined-issues "Direct link to Predefined issues") Clevergy provides predefined forms for several common issues for an utility. For example, the **contract modification issue** allows clients to submit: * **Change of contract holder:** provide full name, ID, email, phone number, and IBAN. * **Change of bank account:** provide the new IBAN. * **Change of contracted power:** specify the new contracted power (P1, P2). These forms are designed to collect the necessary information in a structured way, solving issues faster and easier to process. info This feature is configurable so you can choose which types of issues to show or hide within your own application. ### Generic issues[​](#generic-issues "Direct link to Generic issues") Clients can submit a general issue describing their problem or question in free text under the subject *Other issues*. They can also attach files to their tickets to provide further context, such as screenshots or supporting documents. Additionally, your team can define specific subjects to guide clients when submitting certain types of issues and categorize them. For example, subjects like *I have problem with my surplus* or *Power outage*. ## Ticket life cycle[​](#ticket-life-cycle "Direct link to Ticket life cycle") Tickets visible to the client in the app can have the following statuses: * **In progress**: the client has created the ticket or replied to the conversation and is waiting for a response from the support team. * **New answer**: the support team has replied, and the client can view the new message in the app. * **Solved**: the support team has provided a solution. The client can confirm whether the issue has been resolved. If it is resolved, the ticket is updated to *Closed*. Otherwise, the client can reply within the same conversation thread. * **Closed** : the issue has been confirmed as resolved and no further action is required. At this point, the ticket cannot be reopened. The full ticket conversation remains available in the app, allowing clients to review previous messages. ## Ticket reference[​](#ticket-reference "Direct link to Ticket reference") Every ticket has a unique **reference** that identifies it for both the client and the utility. The reference is shown in the app, in the ticket detail, so clients can quote it whenever they contact you about that ticket. The same reference is visible in the **[portal](https://docs.clever.gy/helpdesk/portal/workspaces/support-tickets/.md)**, where your team can use it to find the ticket. This way, client and support team always refer to the same request. ## Notifications[​](#notifications "Direct link to Notifications") Whenever the support team replies to a ticket, the client will receive: * An **email notification** (if email communications are enabled). * A **push notification in the app** (if notifications are enabled on the client's device). These notifications allow the clients to quickly return to the app and review the response. --- # Multi-language The application supports language management, allowing a localized experience for the client. Currently, the available languages are: * Spanish * Galician * Catalan * Basque * English ## Language selection flow[​](#language-selection-flow "Direct link to Language selection flow") ### Utility-level default configuration[​](#utility-level-default-configuration "Direct link to Utility-level default configuration") If your team import clients through the connect API, you can define a default language for those clients. If no language is specified during the import process, your default language configuration will be applied as the initial value. ### Client-level preference[​](#client-level-preference "Direct link to Client-level preference") When the client accesses the application for the first time, the application automatically detects the browser language. If the detected language is available, it is proposed as the preferred language. The client can manually change the language at any time from *My account* section within the application. Once updated, this language is stored as the client's preferred language and takes precedence over any utility-level configuration. ## Language usage in communications[​](#language-usage-in-communications "Direct link to Language usage in communications") The selected language (or, if not available, the applicable default language) will be consistently used across all user touchpoints, including: * Application interface * Push notifications * Emails * Any other future communications This ensures a coherent and personalized experience across all channels. --- # Notifications A simple guide to our push notification system and when users will receive them | Category | Notification | Title | Body | When | Frequency | | ---------------- | -------------------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------ | | Contract Status | **Consumption Data Ready** | **"Your consumption data is now available!"** | "Log in now and discover how to save on your electricity bill." | When first consumption data becomes available | One-time only | | Contract Status | **Contract Active** | **"Your contract is ready!"** | "Log in now and discover how to save on your electricity bill." | When contract status becomes active | One-time only for first consumption notification | | Invoices | **New invoice** | **"New \[electricity/gas] invoice available"** | "Log in now and view your invoice" | When new invoice is available | One-time for invoice | | Usage Monitoring | **Spending Limit** | **"Spending limit reached"** | "You've reached \[X] kWh, your preset consumption limit for this month." | When user reaches their preset limit | One-time per limit | | Solar | **Surplus Alert** | **"Maximize your solar surplus!"** | "Last week you exported \[X]% of your generated energy to the grid. Use this energy during sunlight hours - it's free!" | End of week with significant surplus | Weekly (if applicable) | | Solar | **Peak Export** | **"Save more with your solar panels"** | "This month you exported more surplus energy between X:00 and XX:00. Try using more energy during these hours to lower your electricity bill." | At the end of each month | Monthly (if applicable) | | Gas | **Estimated invoices** | **"Update your gas meter reading"** | "We've estimated your consumption for the last 2 invoices. Submit your reading and we'll update the actual amount." | When new gas invoice is available and last two are estimated | One-time for gas invoice | | Support | **Support Update** | **"New response to your query"** | "Check the app to read the response from our support team." | When support team responds | As needed | --- # Onboarding Onboarding is the process of introducing new users to the app to ensure a smooth start. It helps users understand the app’s value proposition and configure some settings before using it. ## 1. Splash screen[​](#1-splash-screen "Direct link to 1. Splash screen") It is the first screen users see when opening the app. It displays your company logo and sets the initial brand impression. ## 2. Value proposition screen[​](#2-value-proposition-screen "Direct link to 2. Value proposition screen") It appears after the splash screen and before the login/registration screen. It contains: 1. **Title** * The main message you want to display. * Recommendation: less than 50 characters in length. 2. **Key points** * Maximum of five bullet items: a concise summary of your value proposition. * Recommendation: less than 60 characters each. ### How can I personalize this info in the app?[​](#how-can-i-personalize-this-info-in-the-app "Direct link to How can I personalize this info in the app?") Please send the following details to us and we will update them: * Title. * Key points. Once we receive this information, we'll update the onboarding screen accordingly. ## 3. Login / Registration screen[​](#3-login--registration-screen "Direct link to 3. Login / Registration screen") This screen allows users to log in if they already have an account or register if they are new. ### How do I log in to the app?[​](#how-do-i-log-in-to-the-app "Direct link to How do I log in to the app?") 1. **Magic link** * Enter the email address where you want the login link to be sent and click **"Send link to this email"**. * You will receive an email, and you’ll need to click the link from the same device to log in. * If you don’t receive it, check your spam folder. * The link will be valid for 1 hour. 2. **Username and password** * Click **"Use email and password"** at the bottom banner. * Enter your email and password. * Click **"Log in"**. ### How can I reset my password if I forget it?[​](#how-can-i-reset-my-password-if-i-forget-it "Direct link to How can I reset my password if I forget it?") * Click **"Forgot your password?"**. * Enter your email and click **"Reset password"**. * You will receive an email with a link to reset your password. * Open the email and click **"Click here to change your password"**. * Back in the app, enter your new password and click **"Change password"**. ## 4. Notification activation[​](#4-notification-activation "Direct link to 4. Notification activation") This screen encourages users to enable notifications to receive important alerts, energy-saving tips, and consumption updates. Users can choose to activate notifications or skip this step. --- # Optimize Find personalized recommendations for renewable energy solutions to optimize your home's energy consumption. Availability Feature availability may vary depending on the contracted plan. ## Requirements[​](#requirements "Direct link to Requirements") To ensure the recommenders display correctly, users must meet certain criteria: * **General requirement**: Recommenders become available only after completing your home configuration and accumulating at least one full month of consumption data, which is used as the basis for all calculations. **Specific requirements for recommenders** * **Solar panel recommender**: Available for single-family homes where consumption during solar hours (between 10:00h to 17:00h) exceeds 20% of total daily consumption, and the user does not already have solar panels installed. * **Battery recommender:** Available for any home that already has solar panels installed, and do not yet have a battery system. * **Aerothermal recommender:** Available for two user profiles, always provided that the user does not already have an aerothermal system: * Users with solar panels and more than 20% surplus generation relative to total solar production. * Users living in a single-family home or apartment > 100 m² with any of the following : gas boiler, electric water heater, or electric radiator. * **Appliances recommender:** Available when home's energy consumption in any category (cleaning, kitchen, or HVAC) is 30% higher than the efficient consumption benchmark ## Solar Panel Recommender[​](#solar-panel-recommender "Direct link to Solar Panel Recommender") Calculate how much energy you could generate and save with solar panels. See your estimated annual savings, the amount of energy you could produce, days of free energy, and your potential CO₂ reduction, all based on your real consumption. ## Battery Recommender[​](#battery-recommender "Direct link to Battery Recommender") Check if you have surplus solar energy and see how installing a battery can help you store and use that excess, increasing your savings. ## Aerothermal Recommender[​](#aerothermal-recommender "Direct link to Aerothermal Recommender") See how an aerothermal system can help you use outdoor air energy for heating, cooling, and hot water, making your home more efficient and sustainable. ## Appliances Recommender[​](#appliances-recommender "Direct link to Appliances Recommender") Check if your cleaning, kitchen, or HVAC appliances use more energy than efficient models. This analysis is based on your consumption data from the **last month**, so recommendations always reflect recent usage patterns rather than your entire history. Get personalized tips and product suggestions to help you save energy and reduce your consumption. --- # Connections Connections keep your customer data in sync between your ERP or CRM and Clevergy, so your users find their contracts, invoices and balance ready in the app without any manual work. A connection can work in two ways: * **Clevergy connector**: Clevergy connects to your ERP and retrieves the data on a regular basis. You only need to provide access. * **Connect API**: your ERP, CRM or technology provider sends the data to Clevergy through the **[Connect API](https://docs.clever.gy/helpdesk/connections/connect-api.md)**. The following connections are available: * **[Audinfor](https://docs.clever.gy/helpdesk/connections/audinfor.md)** * **[Enexpa](https://docs.clever.gy/helpdesk/connections/enexpa.md)** * **[Gisce](https://docs.clever.gy/helpdesk/connections/gisce.md)** * **[Neuro Energía](https://docs.clever.gy/helpdesk/connections/neuro.md)** * **[Connect API](https://docs.clever.gy/helpdesk/connections/connect-api.md)**: connect any other ERP or CRM. ## Connections capabilities summary[​](#connections-capabilities-summary "Direct link to Connections capabilities summary") note * Consumption data does not come from the ERP. Clevergy retrieves it separately through **[Datadis](https://docs.clever.gy/helpdesk/integrations/datadis.md)** or the **[distributors](https://docs.clever.gy/helpdesk/integrations/distributors.md)**, using the CUPS of each contract. * Some features depend on specific data. If a connection does not provide it, the related feature is not shown in the app or is shown with less detail. | Connection | Customers | Contracts | Prices | Invoices | Invoice breakdown | Virtual wallet | Gas | | ----------------- | --------- | --------- | ------ | -------- | ----------------- | -------------- | --- | | **Audinfor** | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | **Enexpa** | ✅ | ✅ | ➖ | ✅ | ➖ | ✅ | ➖ | | **Gisce** | ✅ | ✅ | ✅ | ➖ | ➖ | ➖ | ➖ | | **Neuro Energía** | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ | ➖ | | **Connect API** | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ## What each data enables in the app[​](#what-each-data-enables-in-the-app "Direct link to What each data enables in the app") | Data | What your users get | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Customers | User account and access to the app. | | Contracts | Their supply points and contract details in **[House contracts](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/house-contracts.md)**. | | Prices | Consumption shown in euros and the details of their tariff. See **[Costs in euros](https://docs.clever.gy/helpdesk/app/euros/.md)**. | | Invoices | Their invoices, with the PDF available to download, in **[Invoices](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/invoices.md)**. | | Invoice breakdown | An explained electricity invoice, with energy, power, taxes and surplus detailed. | | Virtual wallet | The balance and movements of their **[Virtual wallet](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/virtual-wallet.md)**. | | Gas | Their gas contracts and invoices, alongside the electricity ones. | --- # Audinfor The Audinfor connection keeps your customers, contracts, prices, invoices and virtual wallet in sync between Audinfor and Clevergy. ## How it works[​](#how-it-works "Direct link to How it works") Clevergy connects to your Audinfor environment and retrieves the data every day, so you don't need to send anything manually. ## Synchronized data[​](#synchronized-data "Direct link to Synchronized data") | Data | Available | Details | | ----------------- | --------- | ---------------------------------------------------------------------------------- | | Customers | ✅ | Created from your contracts. | | Contracts | ✅ | Electricity and gas contracts, with their supply point. | | Prices | ✅ | Updated every day when a contract's prices change. | | Invoices | ✅ | Electricity and gas invoices. New invoices are added every day, including the PDF. | | Invoice breakdown | ✅ | Included with each invoice. | | Virtual wallet | ✅ | Balance updated every day. | | Gas | ✅ | Gas contracts and invoices are synchronized like electricity ones. | ## How to activate it[​](#how-to-activate-it "Direct link to How to activate it") 1. Contact your Clevergy account manager to request the Audinfor connection. 2. Provide the access credentials to your Audinfor environment. Audinfor can help you obtain them. 3. Clevergy sets up the connection and runs an initial load of your customers. Once the initial load is complete, your users can access the app with their data ready. --- # Connect API The Connect API lets you connect any ERP or CRM to Clevergy by sending your customer data directly, when your system is not in the list of available connections. ## How it works[​](#how-it-works "Direct link to How it works") Your ERP, CRM or technology provider sends the data to Clevergy whenever it changes. Clevergy provides the access credentials and the documentation needed to do it. ## Data you can send[​](#data-you-can-send "Direct link to Data you can send") | Data | What your users get | Guide | | --------------- | -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | Customers | User account and access to the app. | **[Create a new client](https://docs.clever.gy/developer/how-to-set-up/create-client.md)** | | Contracts | Electricity and gas contracts, with their prices. | **[Contracts](https://docs.clever.gy/developer/how-to-set-up/contracts.md)** | | Invoices | Electricity and gas invoices, with the PDF and, optionally, the breakdown. | **[Invoices](https://docs.clever.gy/developer/how-to-set-up/invoices.md)** | | Virtual wallet | Virtual wallet or virtual battery balance. | **[Virtual balance](https://docs.clever.gy/developer/how-to-set-up/virtual-balance.md)** | | Support tickets | Support requests from the app sent to your support platform. | **[Ticket integration](https://docs.clever.gy/developer/how-to-set-up/ticket-integration.md)** | ## How to activate it[​](#how-to-activate-it "Direct link to How to activate it") 1. Contact your Clevergy account manager to request access to the Connect API. 2. Clevergy provides the access credentials. 3. Your team or provider follows the **[developer guides](https://docs.clever.gy/developer/.md)** to start sending data. --- # Enexpa The Enexpa connection keeps your customers, contracts, invoices and virtual wallet in sync between Enexpa and Clevergy. ## How it works[​](#how-it-works "Direct link to How it works") Clevergy connects to your Enexpa environment and retrieves the data every day, so you don't need to send anything manually. ## Synchronized data[​](#synchronized-data "Direct link to Synchronized data") | Data | Available | Details | | ----------------- | --------- | ----------------------------------------------------------------------------------------------------------- | | Customers | ✅ | Created from your contracts. | | Contracts | ✅ | Contracts with their supply point. | | Prices | ➖ | Not available. | | Invoices | ✅ | All invoices are loaded for each new supply point, and new invoices are added every day, including the PDF. | | Invoice breakdown | ➖ | Not available. | | Virtual wallet | ✅ | Taken from the virtual battery balances included in each invoice. | | Gas | ➖ | Not available. Only electricity contracts and invoices are synchronized. | ## How to activate it[​](#how-to-activate-it "Direct link to How to activate it") 1. Contact your Clevergy account manager to request the Enexpa connection. 2. Provide the access credentials to your Enexpa environment. Enexpa can help you obtain them. 3. Clevergy sets up the connection and runs an initial load of your customers. --- # Gisce The Gisce connection keeps your customers, contracts and prices in sync between Gisce and Clevergy. ## How it works[​](#how-it-works "Direct link to How it works") Clevergy connects to your Gisce environment and regularly checks for new or updated customers, contracts and prices, so you don't need to send anything manually. ## Synchronized data[​](#synchronized-data "Direct link to Synchronized data") | Data | Available | Details | | ----------------- | --------- | ---------------------------------------------------------------------------------------------------- | | Customers | ✅ | New and updated customers are synchronized regularly. | | Contracts | ✅ | New and updated contracts are synchronized regularly. | | Prices | ✅ | Fixed and per-period prices come with the contract. Indexed and custom prices are updated every day. | | Invoices | ➖ | Not available yet. | | Invoice breakdown | ➖ | Not available yet. | | Virtual wallet | ➖ | Not available yet. | | Gas | ➖ | Not available yet. Only electricity contracts are synchronized. | ## How to activate it[​](#how-to-activate-it "Direct link to How to activate it") 1. Contact your Clevergy account manager to request the Gisce connection. 2. Provide the access credentials to your Gisce environment. Gisce can help you obtain them. 3. Clevergy sets up the connection and runs an initial load of your customers. --- # Neuro Energía connection The Neuro Energía connection keeps your customers, contracts, prices and invoices in sync between Neuro Energía and Clevergy. ## How it works[​](#how-it-works "Direct link to How it works") Neuro Energía sends your data to Clevergy through the **[Connect API](https://docs.clever.gy/helpdesk/connections/connect-api.md)** whenever it changes, so you don't need to send anything manually. ## Synchronized data[​](#synchronized-data "Direct link to Synchronized data") | Data | Available | Details | | ----------------- | --------- | ---------------------------------------------------------------------------- | | Customers | ✅ | Sent by Neuro Energía. | | Contracts | ✅ | Sent by Neuro Energía. | | Prices | ✅ | Sent by Neuro Energía. | | Invoices | ✅ | Sent by Neuro Energía, including the PDF. | | Invoice breakdown | ✅ | Sent by Neuro Energía. | | Virtual wallet | ➖ | Not available yet. | | Gas | ➖ | Not available yet. Only electricity contracts and invoices are synchronized. | ## How to activate it[​](#how-to-activate-it "Direct link to How to activate it") 1. Contact your Clevergy account manager to request the Neuro Energía connection. 2. Clevergy provides the access credentials for the Connect API. 3. Neuro Energía configures the connection and starts sending your data. --- # Integrations Users can access and monitor their energy data by connecting external platforms and devices. The following integrations are available: * [Datadis](https://docs.clever.gy/helpdesk/integrations/datadis.md): Retrieve electricity consumption data for supplies under your name. * [Shelly](https://docs.clever.gy/helpdesk/integrations/shelly.md): Link and manage your smart devices. * Inverters: Connect and monitor your solar devices. Supported brands include: * [Huawei](https://docs.clever.gy/helpdesk/integrations/inverters/huawei.md) * [Fronius](https://docs.clever.gy/helpdesk/integrations/inverters/fronius.md) * [GoodWe](https://docs.clever.gy/helpdesk/integrations/inverters/goodwe.md) * [SolarEdge](https://docs.clever.gy/helpdesk/integrations/inverters/solaredge.md) * [Sungrow](https://docs.clever.gy/helpdesk/integrations/inverters/sungrow.md) * [Growatt](https://docs.clever.gy/helpdesk/integrations/inverters/growatt.md) * [Enphase](https://docs.clever.gy/helpdesk/integrations/inverters/enphase.md) * [SMA](https://docs.clever.gy/helpdesk/integrations/inverters/sma.md) * [SAJ](https://docs.clever.gy/helpdesk/integrations/inverters/saj.md) * [Wibeee](https://docs.clever.gy/helpdesk/integrations/inverters/wibeee.md) * [Solis](https://docs.clever.gy/helpdesk/integrations/inverters/solis.md) * [Sigenergy](https://docs.clever.gy/helpdesk/integrations/inverters/sigenergy.md) * [Distributors](https://docs.clever.gy/helpdesk/integrations/distributors.md): Connect with a distributor to retrieve your customers' consumption data. * [Electric vehicle](https://docs.clever.gy/helpdesk/integrations/electric-vehicle.md): Connect your car account and manage charging. Select an integration from the list to see detailed setup and usage instructions for both the app and the portal. ## Integrations capabilities summary[​](#integrations-capabilities-summary "Direct link to Integrations capabilities summary") note * Data availability may depend on the configuration and permissions of each account or installation. * Historical data is stored from the moment inverters are connected to Clevergy. Some previous historical data may also be available, depending on the integration. * Some data points may be updated periodically rather than in real time. For setup and troubleshooting details, please refer to the documentation page of each integration. | Integration | Access credentials | Plant information | Real-time power | Energy production | Energy consumption | Historical energy data | Power data | Battery control | Battery status | Alerts | | ---------------- | ------------------ | ----------------- | --------------- | ----------------- | ------------------ | ---------------------- | ---------- | --------------- | -------------- | ------ | | **Datadis** | | ➖ | ➖ | ➖ | ✅ | ✅ | ➖ | ➖ | ➖ | ➖ | | **Distributors** | | ➖ | ➖ | ➖ | ✅ | ✅ | ➖ | ➖ | ➖ | ➖ | | **Shelly** | | ➖ | ✅ | ➖ | ✅ | ✅ | ✅ | ➖ | ➖ | ➖ | | **Huawei** | Installer | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ | ✅ | ✅ | | | User | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | **Fronius** | Installer | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ | ✅ | ✅ | | | User | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ | ✅ | ✅ | | **GoodWe** | Installer | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ | ✅ | ✅ | | | User | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | **SolarEdge** | Installer | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ | ✅ | ➖ | | **Sungrow** | Installer | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | | User | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | **Growatt** | Installer | ✅ | ➖ | ✅ | ➖ | ✅ | ✅ | ➖ | ➖ | ✅ | | **Enphase** | Installer | ✅ | ➖ | ➖ | ✅ | ✅ | ✅ | ➖ | ✅ | ✅ | | **SMA** | User | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ | ✅ | ✅ | | **SAJ** | Installer | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ | ✅ | ✅ | | **Wibeee** | User | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ | ➖ | ➖ | | **Solis** | User | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ | ✅ | ✅ | | **Sigenergy** | User | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ | ✅ | ➖ | --- # Datadis integration The Datadis integration allows access to electricity consumption data, based on the supply points associated with the user. ## Setup from the portal[​](#setup-from-the-portal "Direct link to Setup from the portal") Administrators can manage and monitor Datadis integrations for users, using their credentials if they are **Datadis partners**. To become a Datadis partner, a formal agreement with Datadis must be signed. Once registered, partners can onboard users through two methods: 1. **Registration via external application** External apps can redirect users to Datadis registration using a link or embedded form. Supported flows: * **Digital certificate:** For users with DNI/NIE. * **DNI/NIE + CUPS:** Requires an image of the document and a valid CUPS code. * **CIF + CUPS:** Exclusive for CIF, requiring the associated CUPS. Document validation is required before the user is fully registered. Both GET and POST methods are supported, with structured success and error responses. **Monitoring registration status** Datadis provides integration statuses that help monitor each user’s progress: * `NOT_UPLOADED`: User added to Clevergy but not yet registered in Datadis * `NOT_HOLDER`: No supply points found in Datadis after 7 days. * `WAITING_SUPPLIES`: Supply points found, but not matching with the home in Clevergy * `CONNECTED`: Supply point successfully linked . * `DISCONNECTED`: Datadis stops sending data from a previously connected house. 2. **Registration in the private area** Partners can manually register users from the Datadis partner area after verifying identity and CUPS: * **Individuals**: DNI/NIE + CUPS * **Companies**: CIF + CUPS ## Setup from the app[​](#setup-from-the-app "Direct link to Setup from the app") Users can access their home's electricity consumption data. To do this, users must authorize Clevergy to access their data through the Datadis platform by following these steps: ### How to connect with Datadis[​](#how-to-connect-with-datadis "Direct link to How to connect with Datadis") To start the integration process: * Go to **Connections** section in the app and select Datadis to start the authorization process. You might also be able to access it by tapping any call-to-action shown when no data source is connected. * Enter your full name and identification number (DNI or CIF). * An in-app browser will open to begin the Datadis authorization process: * Individuals must upload a photo of their DNI and enter their CUPS code. * Companies must provide their CUPS code and CIF/NIF. * Complete the steps on the screen to finalize the authorization. Check the microfrontend [here](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-smartmeter.md). ### What happens after completing the authorization?[​](#what-happens-after-completing-the-authorization "Direct link to What happens after completing the authorization?") Once the process is finished, Datadis will verify your information with your electricity distributor. This verification can take some time. note While the verification is ongoing, the app will display a message: "Waiting for consumption data from your distributor". As soon as access is confirmed, your consumption data will begin to appear in the app, and you can start using all available features. ### What information Clevergy retrieves from Datadis[​](#what-information-clevergy-retrieves-from-datadis "Direct link to What information Clevergy retrieves from Datadis") * **Consumption history**: As soon as access is granted, Clevergy retrieves up to 12 months of hourly consumption data, helping you visualize past energy usage. * **Data update frequency**: Consumption data is updated daily at 6 AM. Occasionally, updates may be delayed depending on the distributor's data availability. If data is missing for more than 14 days, the app will show a notification and Clevergy will follow up with Datadis. * **Consumption latency**: On average, the most recent data available comes with a 2-day delay, meaning data shown today typically corresponds to the day before yesterday. * **Maximum power demand**: We retrieve your maximum power demand for the past 12 months, which allows Clevergy to suggest optimizations to your contracted power. * **Neighbor comparison**: Clevergy also accesses aggregated consumption data from users in your postal code, enabling you to compare your usage with others in your area. ### Important considerations[​](#important-considerations "Direct link to Important considerations") * **Datadis errors**: In some cases, data cannot be retrieved due to issues with the distributor or authorization process. If you don’t see data after several days, please contact Clevergy support. We will work to resolve the issue as quickly as possible. * **Legal conditions**: All authorization and data access is governed by Datadis' legal terms and conditions. Clevergy retrieves and processes consumption data in full compliance with these terms and only with user consent. --- # Distributors integration The distributors integration allows access to users' consumption data by connecting with the electricity distributor. note To integrate a user via FTP (i.e., to obtain their data through this method), the user must have an **active electricity contract**. This is how we ensure we don't access data we shouldn't, and that it isn't shared improperly. You can check whether a contract already exists by searching for its CUPS in the **[contract list](https://docs.clever.gy/helpdesk/portal/my-data/contracts/contract-list.md)**. Currently, the following distributors are integrated: * ASEME * e-distribución * i-DE * UFD ## Setup from the portal[​](#setup-from-the-portal "Direct link to Setup from the portal") Follow these steps to integrate a distributor: 1. Go to [Settings → My Integrations](https://portal.clever.gy/dashboard/$tenant$/integrations). 2. Click the **Add** button in the Distributors section. 3. Select the **distributor**. 4. Fill in the following fields: * **Name:** A descriptive name to identify the distributor. * **FTP address:** The link used to access files on a server via the File Transfer Protocol (FTP). * **Username** and **Password:** Credentials required to authorize access to the data. Once the integration is created, the CUPS information is loaded automatically every day at 15:00, matched against the CUPS from the client's active electricity contract. --- # Electric vehicle integration The electric vehicle integration lets users connect their car account and manage charging from the app. ## Setup from the app[​](#setup-from-the-app "Direct link to Setup from the app") To link your vehicle, follow these steps: 1. Go to **Profile -> Connections**. 2. Tap **Electric vehicle**. 3. Select your vehicle brand and sign in with your manufacturer account. 4. Grant the requested permissions to complete the connection. Once linked, users can check battery status, view estimated range, and start or stop charging. note Only one vehicle can be linked per house. Keep in mind that behavior may vary depending on the brand and model: * Some manufacturers require additional user actions to enable certain features (such as creating an account, activating subscriptions, or adjusting settings in the official app or directly in the vehicle). * Some brands allow only one active session per user account. When connected through Clevergy, this may cause the user to be automatically logged out from the manufacturer’s app. Check the microfrontend [here](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-electric-vehicle.md). --- # Inverters integration Clevergy supports integration with various inverter brands to provide real-time and historical data. Availability Feature availability may vary depending on the contracted plan. ## Connection types[​](#connection-types "Direct link to Connection types") Depending on the brand, an inverter can be integrated in one or both of these ways: * **Installer credentials → Setup from the portal (administrators):** requires API credentials issued by the inverter manufacturer, which usually involves a request or approval process on their side. Once configured, it applies to all installations linked to those credentials. * **User credentials → Setup from the App (end users):** the end user logs in with their own account for the manufacturer's platform, without needing to request any credentials beforehand. ## Available inverter integrations[​](#available-inverter-integrations "Direct link to Available inverter integrations") note "Paid" means the manufacturer charges for API access (SolarEdge, Enphase, SMA). This is a cost set by the manufacturer, not by Clevergy. | Brand | Connection type | API access | How to get credentials | Approval time | | -------------------------------------------------------------------------------- | --------------- | ---------- | ----------------------------------------------------------------------------------------- | --------------- | | [Huawei](https://docs.clever.gy/helpdesk/integrations/inverters/huawei.md) | Installer, User | Free | Self-service, created directly in FusionSolar | Immediate | | [Fronius](https://docs.clever.gy/helpdesk/integrations/inverters/fronius.md) | Installer, User | Free | Request API access by email, then generate a key in Solar.web | 2 weeks | | [GoodWe](https://docs.clever.gy/helpdesk/integrations/inverters/goodwe.md) | Installer, User | Free | Request by email, NDA with digital signature | 1 month or more | | [SolarEdge](https://docs.clever.gy/helpdesk/integrations/inverters/solaredge.md) | Installer | Paid | Self-service, generated directly in the monitoring portal | Immediate | | [Sungrow](https://docs.clever.gy/helpdesk/integrations/inverters/sungrow.md) | Installer, User | Free | Create an application in the Sungrow developer portal | A few days | | [Growatt](https://docs.clever.gy/helpdesk/integrations/inverters/growatt.md) | Installer | Free | Request an API application in the Growatt platform | 2 weeks | | [Enphase](https://docs.clever.gy/helpdesk/integrations/inverters/enphase.md) | Installer | Paid | Create an application in the Enphase Developer Portal | Immediate | | [SMA](https://docs.clever.gy/helpdesk/integrations/inverters/sma.md) | User | Paid | Request client credentials from SMA (with your redirect URL), then add them in the portal | 2 weeks | | [SAJ](https://docs.clever.gy/helpdesk/integrations/inverters/saj.md) | Installer | Free | Account linking + signed authorization letter + app creation | A few days | | [Wibeee](https://docs.clever.gy/helpdesk/integrations/inverters/wibeee.md) | User | Free | No credentials needed, just log in with your Wibeee account | Immediate | | [Solis](https://docs.clever.gy/helpdesk/integrations/inverters/solis.md) | Installer, User | Free | Request by email and sign an NDA to receive API credentials | A few days | | [Sigenergy](https://docs.clever.gy/helpdesk/integrations/inverters/sigenergy.md) | User | Free | No credentials needed, just log in with your MySigen account | Immediate | Select a brand to see detailed setup and usage instructions. --- # Enphase integration The Enphase integration allows administrators to connect and monitor Enphase inverters through Clevergy. note Enphase enforces request limits based on the configured app plan. Exceeding the quota will block data synchronizations until the monthly reset. By default, Clevergy syncs Enphase data weekly. To increase the frequency, you must upgrade to a plan with higher request limits. ## Requesting API credentials[​](#requesting-api-credentials "Direct link to Requesting API credentials") Follow these steps to create your application in the Enphase Developer Portal. 1. Log in to the [Enphase Developer Portal](https://developer-v4.enphase.com/login). 2. Create an application under Partner plan by providing the [Enlighten Credentials](https://enlighten.enphaseenergy.com/). 3. Copy the generated **API Key / Client ID / Client Secret** . ## Setup from the portal (administrators)[​](#setup-from-the-portal-administrators "Direct link to Setup from the portal (administrators)") Follow these steps to integrate the Enphase inverter using installer credentials: 1. In the Clevergy portal, go to [Settings → My Integrations](https://portal.clever.gy/dashboard/$tenant$/integrations). 2. Click **Add Inverter** and choose **Enphase**. 3. Complete the required fields: * **Name:** Identifier for this integration in the portal (e.g. Production, Test). * **Username / Password**: from the Enlighten portal. * **API Key / Client ID / Client Secret:** Values obtained when creating the application in the Enphase Developer Portal. 4. Save the integration. Clevergy will start synchronizing the Enphase plant. Once completed, your Enphase inverter is integrated. Data synchronization for installer credentials integrations is performed overnight. After completing the setup, data will be available in the portal the following day. ## Monitoring capabilities[​](#monitoring-capabilities "Direct link to Monitoring capabilities") Once integrated, you will have access to: * Real-time installation data, energy production, and historical energy data: update frequency depends on your Enphase app pricing plan (by default, Clevergy syncs weekly; higher-frequency updates require a plan with higher request limits) * System alerts and installation status * Battery monitoring (if applicable) --- # Fronius integration The Fronius integration allows administrators and end users to monitor and manage inverter data through the platform. ## Requesting API credentials[​](#requesting-api-credentials "Direct link to Requesting API credentials") Follow these steps to request API access and generate your credentials. This is only needed for installer credentials. 1. Contact to request activation of API access. This process may take some time. 2. Once activated, log in to [Fronius Solar.web](https://api-mgmt.solarweb.com/login). 3. In the top right menu, go to **User Settings → REST API**. 4. Click **Create New Key** to generate your credentials and save them: * **Access Key ID**: Unique API identifier. * **Access Key Value**: API secret key (only visible once). ## Setup from the portal (administrators)[​](#setup-from-the-portal-administrators "Direct link to Setup from the portal (administrators)") ### Installer credentials integration[​](#installer-credentials-integration "Direct link to Installer credentials integration") Follow these steps to integrate the Fronius inverter using the installer's credentials: 1. In the portal, go to [Settings → My Integrations](https://portal.clever.gy/dashboard/$tenant$/integrations). 2. Click **Add Inverter**, select **Fronius** and fill in: * **Name**: Identifier for this integration in the portal (e.g. Production, Test). * **Access Key ID** and **Access Key Value** obtained above. Once added, your Fronius inverter is integrated. ### User credentials integration[​](#user-credentials-integration "Direct link to User credentials integration") Follow these steps to integrate the Fronius inverter using the end user credentials: * In the **Integrations** section, administrators can configure the Fronius B2C integration under the **Inverters** subsection. * To enable this integration for end users, check in [Settings](https://portal.clever.gy/dashboard/$tenant$/integrations) if it is activated. If the integration does not appear, you can request its activation. ## Setup from the App (end users)[​](#setup-from-the-app-end-users "Direct link to Setup from the App (end users)") Steps: 1. Go to **More → Connections → Solar installation and batteries** in the app. 2. Tap on **Fronius** to start the connection process. 3. On the **Connect your device** screen, enter your username and password, and confirm the connection request. 4. Authorize the integration by checking the required permission boxes. Once authorized, your Fronius installation will be connected and ready for monitoring through the app. Check the microfrontend [here](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-solar-inverter.md). ## Monitoring capabilities[​](#monitoring-capabilities "Direct link to Monitoring capabilities") Once integrated, you will have access to: * Real-time installation data updated every 15 min * Energy production and consumption updated daily * Historical energy data * Production and consumption graphs * System alerts and installation status note Fronius occasionally updates their terms and conditions. If prompted, you must accept the updated terms to continue using the API. --- # GoodWe integration The GoodWe integration allows administrators to connect and monitor GoodWe inverters through the platform. ## Requesting API credentials[​](#requesting-api-credentials "Direct link to Requesting API credentials") The request depends on the type of connection. In both cases, contact GoodWe support at and a GoodWe engineer will reach out to you. Once your request is approved, GoodWe's after-sales team sends you a **Client ID** and a **Client Secret**. ### Installer credentials[​](#installer-credentials "Direct link to Installer credentials") For admins, installers and other users who already have an organization account on the SEMS or SEMS+ platform. If you do not have one, register [here](https://semsplus.goodwe.com/#/login). Provide the following information: * **Organization code:** your organization code in SEMS+. * **Registered account:** make sure the account belongs to the target organization. * **Email:** if your stations belong to the European, American, Australian or international servers. * **Company name.** ### User credentials[​](#user-credentials "Direct link to User credentials") For organizations that want their end users to connect their own GoodWe stations. Provide the following information: * **Company name.** * **Registered email address.** * **Application name.** * **Application description:** a brief introduction of the application. * **Application icon:** JPG or PNG. * **Redirect URI.** ## Setup from the portal (administrators)[​](#setup-from-the-portal-administrators "Direct link to Setup from the portal (administrators)") ### Installer credentials integration[​](#installer-credentials-integration "Direct link to Installer credentials integration") Follow these steps to integrate the Goodwe inverter using the installer's credentials: 1. Go to [Settings → My Integrations](https://portal.clever.gy/dashboard/$tenant$/integrations) in the portal. 2. Click **Add Inverter**. 3. Select the **GoodWe** brand. 4. Fill in the required fields: * **Name:** Identifier for this integration in the portal (e.g. Production, Test). * **Client ID** and **Client Secret:** Obtained after completing the credential request process above. * **Domain URL** (optional): If left empty, European domain is used by default. Use this field to set the correct regional URL when your installations are located outside Europe. Once completed, your GoodWe inverter is integrated. ## Setup from the App (end users)[​](#setup-from-the-app-end-users "Direct link to Setup from the App (end users)") With user credentials, the end user connects their own GoodWe account from the app, without the installer needing to request API credentials from GoodWe. Only end users who meet the following requirements will be able to complete this process: * Have a GoodWe monitoring platform (SEMS+) username and password. * Have **owner** permissions associated with their installation. Steps: 1. Go to **More → Connections → Solar installation and batteries** in the app. 2. Tap on **GoodWe** to start the connection process. 3. On the **Connect your installation** screen, confirm the connection request. 4. Log in to the GoodWe platform with your credentials. 5. Authorize the integration by accepting the requested permissions. Once authorized, your GoodWe installation will be connected and ready for monitoring through the app. ## Monitoring capabilities[​](#monitoring-capabilities "Direct link to Monitoring capabilities") Once integrated, you will have access to: * Real-time installation data updated every 15 min * Energy production and consumption updated hourly * Historical energy data available from the connection date only * Production and consumption graphs * System alerts and installation status * Battery monitoring * Battery management: charge, discharge, idle or self-consumption modes, up to a target state of charge or the end of the scheduled interval (user credentials only) note Battery commands are asynchronous: GoodWe accepts the request first and the inverter applies it afterwards. Once the scheduled interval ends or the command is disabled, the inverter returns to self-consumption mode. --- # Growatt integration The Growatt integration allows administrators to connect and monitor Growatt inverters through the platform. ## Requesting API credentials[​](#requesting-api-credentials "Direct link to Requesting API credentials") Follow these steps to request your Growatt API credentials. 1. Log in to the [Growatt monitoring platform](https://oss.growatt.com/login?lang=en) as an installer or site admin. 2. Go to **System Setting → System Management** and choose to Add API Request. 3. Once the request is approved by Growatt, you will receive the API credentials by email. ## Setup from the portal (administrators)[​](#setup-from-the-portal-administrators "Direct link to Setup from the portal (administrators)") ### Installer credentials integration[​](#installer-credentials-integration "Direct link to Installer credentials integration") Follow these steps to integrate the Growatt inverter using the installer's credentials: 1. Go to [Settings → My Integrations](https://portal.clever.gy/dashboard/$tenant$/integrations) in the portal. 2. Click **Add Inverter**. 3. Select the **Growatt** brand. 4. Fill in the required fields: * **Name:** Identifier for this integration in the portal (e.g. Production, Test). * **Token:** The API credentials received by email from Growatt. Once completed, your Growatt inverter is integrated. ## Monitoring capabilities[​](#monitoring-capabilities "Direct link to Monitoring capabilities") Once integrated, you will have access to: * Real-time installation data not available * Energy production updated daily * Historical energy data available * Production and consumption graphs * System alerts and installation status note Growatt offers a wide catalog of devices and, in some cases, specific endpoint updates may be required to expose all available telemetry. --- # Huawei integration The Huawei integration allows administrators and users to monitor and manage inverter data through the platform. ## Requesting API credentials[​](#requesting-api-credentials "Direct link to Requesting API credentials") Follow these steps to create the API account in Fusion Solar. This is only needed for installer credentials. 1. Log in to [Fusion Solar](https://eu5.fusionsolar.huawei.com/unisso/login.action). 2. Navigate to **More → System → Enterprise Management** and select **Northbound Management**. 3. Click **Add** to create a new API account. 4. Complete the required fields: * **Username:** The name of your company followed by "api" (e.g., "Instaladora PJX api"). * **Password:** Create a secure password for the API account. * **Associated Account:** A dropdown will appear. Select the account with **Admin** permissions. * **Expiration Date:** Select the maximum expiration date available (or the latest possible date). 5. Select each of the installations you want to grant API access to. 6. Enable the API monitoring access permissions by turning on the switch button. 7. Confirm by clicking **OK**. ## Setup from the portal (administrators)[​](#setup-from-the-portal-administrators "Direct link to Setup from the portal (administrators)") ### Installer credentials integration[​](#installer-credentials-integration "Direct link to Installer credentials integration") Follow these steps to integrate the Huawei inverter using installer credentials: 1. Go to [Settings → My Integrations](https://portal.clever.gy/dashboard/$tenant$/integrations). 2. Click the **Add Inverter** button. 3. Select **Huawei** brand. 4. Fill in the following fields: * **Name:** Identifier for this integration in the portal (e.g. Production, Test). * **Username** and **Password:** These are the API account credentials created above in Fusion Solar (Northbound Management) by an **Administrator** account, and they are not the same as the login credentials used to access the Fusion Solar portal. * **Domain URL** (optional): If left empty, European domain is used by default. Use this field to set the correct regional URL when your installations are located outside Europe. Once completed, your Huawei inverter is integrated. Data synchronization for installer credentials integrations is performed overnight. After completing the setup, data will be available in the portal the following day. ### User credentials integration[​](#user-credentials-integration "Direct link to User credentials integration") Follow these steps to integrate a Huawei inverter using user credentials: 1. In the **Integrations** section, administrators can configure the Huawei OAuth integration under the **Inverters** subsection. 2. To enable this integration for end users, check in [Settings → My Integrations](https://portal.clever.gy/dashboard/$tenant$/integrations) if it is activated. If the integration does not appear, you can request its activation. Once completed, your Huawei inverter is integrated and data will be available immediately in the portal. ## Setup from the App (end users)[​](#setup-from-the-app-end-users "Direct link to Setup from the App (end users)") Only end users who meet the following requirements will be able to complete this process: * Have **FusionSolar** username and password. * Have **owner** permissions associated with their installation. OAuth permissions must be configured in the portal before allowing **end users** to connect their plant through the app. Steps: 1. Go to **More → Connections → Solar installation and batteries** in the app. 2. Tap on **Huawei** to start the connection process. 3. On the **Connect your installation** screen, confirm the connection request. 4. Log in to **FusionSolar** using your username and password. 5. Authorize the integration by checking the required permission boxes. Once authorized, your Huawei installation will be connected and ready for monitoring through the app. Check the microfrontend [here](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-solar-inverter.md). ## Monitoring capabilities[​](#monitoring-capabilities "Direct link to Monitoring capabilities") Once integrated, you will have access to: * Real-time installation data updated every 15 min (installer credentials) or every 5 min (user credentials) * Energy production and consumption updated daily (installer credentials) or hourly (user credentials) * Historical energy data available for up to 30 previous days * Production and consumption graphs * System alerts and installation status * Battery monitoring and management (if applicable) ### Battery behaviour[​](#battery-behaviour "Direct link to Battery behaviour") Battery charge and discharge actions are time-bound; once the specified duration ends, the inverter automatically reverts to the previous operating mode or its default configuration. --- # SAJ integration The SAJ integration allows administrators and users to monitor and manage inverter data through the platform. ## Requesting API credentials[​](#requesting-api-credentials "Direct link to Requesting API credentials") Before starting the integration, you must complete the authorization process in both the [SAJ monitoring portal](https://eop.saj-electric.com/login) and the [SAJ developer portal](https://developer.saj-electric.com/login). 1. Create an account in the [SAJ monitoring portal](https://eop.saj-electric.com/login) if you do not already have one. 2. Using the same email address, create a developer account in the [SAJ developer portal](https://developer.saj-electric.com/login). 3. Contact SAJ support at `consulta@saj-electric.com` to request API access for your account. 4. Once API access has been enabled, log in to the [SAJ developer portal](https://developer.saj-electric.com/login) and copy your **Organization ID** (displayed when hovering over the info icon). 5. Go to the [SAJ monitoring portal](https://eop.saj-electric.com/login) open the **API** section and click on **Select third-party developers.** 6. Enter your Organization ID and select **Apply for binding**. The application will be sent to the developer email. 7. Once the application has been approved, choose to **Start configuration.** 8. Download the document **“Authorization Letter of Distributor/Installer to Developer”**, sign it, and upload the signed copy back to the portal. 9. Wait for SAJ to review and approve the authorization request (this usually takes around 3 business days). 10. Once approved, go back to the API section in the [SAJ monitoring portal](https://eop.saj-electric.com/login) and select the plants you want to authorize for API access. 11. In the [SAJ developer portal](https://developer.saj-electric.com/login) go to **Console > App > Create an App** and create a new application. Wait for your app to be approved by SAJ (this usually takes 1-2 business days). 12. Open the application and go to **Settings and Development > App Configuration** to obtain the **App ID** and **Secret ID** required for the integration ## Setup from the portal (administrators)[​](#setup-from-the-portal-administrators "Direct link to Setup from the portal (administrators)") ### Installer credentials integration[​](#installer-credentials-integration "Direct link to Installer credentials integration") * Go to [Settings → My Integrations](https://portal.clever.gy/dashboard/$tenant$/integrations). * Click the **Add Inverter** button. * Select SAJ brand. * Fill in the following fields: * **Name:** Identifier for this integration in the portal (e.g. Production, Test). * **App ID** and **App Secret:** These are the credentials for the app created in the [SAJ developer portal](https://developer.saj-electric.com/login) (see requesting API credentials above). * Once completed, your SAJ inverter is integrated. Data synchronization will start automatically. Please note that some data (such as the historical energy data) might take some time to be available. ## Monitoring capabilities[​](#monitoring-capabilities "Direct link to Monitoring capabilities") Once integrated, you will have access to: * Real-time installation data updated every 15 min * Hourly energy production and consumption * Historical energy data available for up to 2 previous months * Production and consumption graphs * System alerts and installation status --- # Sigenergy integration The Sigenergy integration allows end users to connect their Sigenergy solar installation and battery, so you can monitor its production, grid exchange and battery through the platform. ## Setup from the portal (administrators)[​](#setup-from-the-portal-administrators "Direct link to Setup from the portal (administrators)") From the Integrations section, administrators can enable the Sigenergy integration so that end users can connect their own accounts. No credentials from Sigenergy are needed. * Go to [Settings → My Integrations](https://portal.clever.gy/dashboard/$tenant$/integrations). * Click the **Add Inverter** button. * Select the **Sigenergy B2C** brand. * Fill in the following fields: * **Name:** Identifier for this integration in the portal (e.g. Production, Test). ## Setup from the App (end users)[​](#setup-from-the-app-end-users "Direct link to Setup from the App (end users)") Only end users who meet the following requirement will be able to complete this process: * Have the **email and password** they use to log in to the **MySigen** app. Steps: 1. Go to **More → Connections → Solar installation and batteries** in the app. 2. Tap on **Sigenergy** to start the connection process. 3. On the **Connect your installation** screen, enter your MySigen email and password. 4. Tap the button to confirm the connection. Once connected, your Sigenergy installation will appear in the app within a few seconds and will be ready for monitoring. The last 12 months of energy data are loaded in the background and may take some time to appear. Check the microfrontend [here](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-solar-inverter.md). ## Monitoring capabilities[​](#monitoring-capabilities "Direct link to Monitoring capabilities") Once integrated, you will have access to: * Real-time solar production, grid import and export, and battery power, updated every 5 min * Battery state of charge, updated every 5 min * Daily energy production, updated once a day * Historical energy data for the last 12 months * Production and consumption graphs * Installation status note **No alerts and no battery control are available.** --- # SMA integration The SMA integration allows end users to connect their SMA solar installation by logging in with their SMA account (Sunny Portal), so you can monitor its production through the platform. Each tenant uses its own SMA application: you request your own client credentials from SMA and add them in the portal. ## Requesting API credentials[​](#requesting-api-credentials "Direct link to Requesting API credentials") Follow these steps to request your SMA client credentials. 1. Contact SMA developer support to request access to the **SMA Monitoring API** and ask for a **Client ID** and **Client Secret**. SMA may ask you to sign an agreement. 2. When SMA asks for the redirect URL of your application, give them: `https://integrations-proxy.clever.gy/external-oauth/$tenant$/sma/callback` Replace `$tenant$` with your tenant identifier. Without this URL, end users cannot complete the connection. 3. SMA will issue your **Client ID** and **Client Secret**. Store them securely. ## Setup from the portal (administrators)[​](#setup-from-the-portal-administrators "Direct link to Setup from the portal (administrators)") Before end users can connect their SMA systems, an administrator must add the client credentials in the portal: 1. Go to [Settings → My Integrations](https://portal.clever.gy/dashboard/$tenant$/integrations). 2. Click the **Add Inverter** button. 3. Select the **SMA** brand. 4. Fill in the following fields: * **Name:** Identifier for this integration in the portal (e.g. Production, Test). * **Client ID** and **Client Secret:** The credentials SMA issued to you. Once completed, end users will be able to connect their SMA systems by logging in with their SMA account. To check whether the integration is available for end users, go to [Settings → My Integrations](https://portal.clever.gy/dashboard/$tenant$/integrations). If the integration does not appear, you can request its activation. ## Setup from the App (end users)[​](#setup-from-the-app-end-users "Direct link to Setup from the App (end users)") Only end users who meet the following requirements will be able to complete this process: * Have an SMA account (Sunny Portal) with access to their installation. Steps: 1. Go to **More → Connections → Solar installation and batteries** in the app. 2. Tap on **SMA** to start the connection process. 3. On SMA's login page, log in with your SMA account. 4. Authorize Clevergy to read your installation's data. Once authorized, your SMA installation will appear in the app within a few seconds and will be ready for monitoring. The last 12 months of energy data are loaded in the background and may take about an hour to appear. Check the microfrontend [here](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-solar-inverter.md). ## Monitoring capabilities[​](#monitoring-capabilities "Direct link to Monitoring capabilities") Once integrated, you will have access to: * Real-time installation data updated every 5 min. Grid import and export too, when the installation has an SMA energy meter * Energy production and consumption updated daily * Historical energy data available for the last 12 months * Production and consumption graphs * System alerts and installation status, including peak power * Battery monitoring (if applicable) --- # SolarEdge integration The SolarEdge integration allows administrators to connect and monitor SolarEdge inverters through the platform. ## Requesting API credentials[​](#requesting-api-credentials "Direct link to Requesting API credentials") 1. Create an account in the [SolarEdge Developer Portal](https://api-docs.solaredge.com/) and follow its documentation for the onboarding process and application setup. 2. Once the account is created, connect it to the relevant fleet(s) through the **Applications** section of the Developer Portal. SolarEdge will return a **Client ID** and a **Client Secret**. For questions about the onboarding process, contact SolarEdge at . ## Setup from the portal (administrators)[​](#setup-from-the-portal-administrators "Direct link to Setup from the portal (administrators)") ### Installer credentials integration[​](#installer-credentials-integration "Direct link to Installer credentials integration") Follow these steps to integrate the SolarEdge inverter using the installer's credentials: 1. Go to [Settings → My Integrations](https://portal.clever.gy/dashboard/$tenant$/integrations) in the portal. 2. Click **Add Inverter**. 3. Select the **SolarEdge** brand. 4. Fill in the required fields: * **Name:** Identifier for this integration in the portal (e.g. Production, Test). * **Client ID** and **Client Secret:** The credentials obtained in the credential request above. Once completed, your SolarEdge inverter is integrated. ## Monitoring capabilities[​](#monitoring-capabilities "Direct link to Monitoring capabilities") Once integrated, you will have access to: * Real-time installation data updated every 15 min * Energy production and consumption updated hourly * Historical energy data available * Production and consumption graphs * System alerts and installation status --- # Solis integration The Solis integration allows administrators and users to monitor and manage inverter data through the platform. ## Requesting API credentials[​](#requesting-api-credentials "Direct link to Requesting API credentials") Follow these steps to request your Solis API credentials. 1. Send an email to [iberiapresales@solisinverters.com ](mailto:iberiapresales@solisinverters.com)requesting access to the Solis API. 2. Solis will ask you to sign an NDA. 3. Once signed, Solis will send back an Excel file with the credentials needed to complete the integration below. ## Setup from the portal (administrators)[​](#setup-from-the-portal-administrators "Direct link to Setup from the portal (administrators)") ### User credentials integration[​](#user-credentials-integration "Direct link to User credentials integration") Follow these steps to integrate a Solis inverter using user credentials: 1. Go to [Settings → My Integrations](https://portal.clever.gy/dashboard/$tenant$/integrations). 2. Click the **Add Inverter** button. 3. Select **Solis** brand. 4. Fill in the following fields: * **Name:** Identifier for this integration in the portal (e.g. Production, Test). * **API Key** and **API Secret:** These are the credentials provided by Solis after completing the API access request above. Once completed, your Solis inverter is integrated. ## Setup from the App (end users)[​](#setup-from-the-app-end-users "Direct link to Setup from the App (end users)") Only end users who meet the following requirements will be able to complete this process: * Have a Solis Cloud account with username and password. * Have **owner** permissions associated with their installation. Check the microfrontend [here](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-solar-inverter.md). ## Monitoring capabilities[​](#monitoring-capabilities "Direct link to Monitoring capabilities") Once integrated, you will have access to: * Real-time installation data updated every 15 min * Hourly energy production and consumption * Historical energy data available * Production and consumption graphs * System alerts and installation status * Battery status monitoring --- # Sungrow integration The Sungrow integration allows to connect and monitor Sungrow inverters through the platform. ## Requesting API credentials[​](#requesting-api-credentials "Direct link to Requesting API credentials") ### Installer credentials[​](#installer-credentials "Direct link to Installer credentials") Follow these steps to create the application for installer credentials in the Sungrow developer portal: 1. Log in to the [Sungrow developer portal](https://developer-api.isolarcloud.eu/#/login) 2. Go to Applications and create a new application. 3. Fill in the required information and select NOT to authorize with Oauth2.0 4. Click **Create application** and wait for Sungrow to approve it. Once the application is approved, you will be able to access your credentials. This approval process can take a few days. ### User credentials[​](#user-credentials "Direct link to User credentials") Follow these steps to create the application for user credentials in the Sungrow developer portal: 1. Log in to the [Sungrow developer portal](https://developer-api.isolarcloud.com/#/login) 2. Go to Applications and create a new application. 3. Fill in the required information and authorize the application using Oauth2.0 4. Click **Create application** and wait for Sungrow to approve it. Once the application is approved, you will be able to access your credentials. This approval process can take a few days. ## Setup from the portal (administrators)[​](#setup-from-the-portal-administrators "Direct link to Setup from the portal (administrators)") ### Installer credentials integration[​](#installer-credentials-integration "Direct link to Installer credentials integration") Follow these steps to integrate a Sungrow inverter using installer credentials: 1. Go to [Settings → My Integrations](https://portal.clever.gy/dashboard/$tenant$/integrations) in the Clevergy portal. 2. Click **Add Inverter**. 3. Select **Sungrow(installer)** as the brand. 4. Fill in the required fields: * **Name:** Identifier for this integration in the portal (e.g. Production, Test). * **Username:** The username shown in the application details in the [Sungrow Developer Portal account](https://developer-api.isolarcloud.com/#/home) after the app is approved. * **Password:** The password used to access the [Sungrow Developer Portal account](https://developer-api.isolarcloud.com/#/home). * **App Key** and **Access Key:** Provided by Sungrow after application approval. If you open the application details in the Sungrow Developer Portal, you will see the username, the App Key, and the Access Key (shown as Key in that section). * **Domain URL** (optional): If left empty, European domain is used by default. Use this field to set the correct regional URL when your installations are located outside Europe. Once completed, your Sungrow inverter is integrated. ### User credentials integration[​](#user-credentials-integration "Direct link to User credentials integration") Follow these steps to integrate a Sungrow inverter using user credentials: 1. Go to [Settings → My Integrations](https://portal.clever.gy/dashboard/$tenant$/integrations) in the Clevergy portal. 2. Click **Add Inverter**. 3. Select **Sungrow(user)** as the brand. 4. Fill in the required fields: * **Name:** Identifier for this integration in the portal (e.g. Production, Test). * **App Key** and **Access Key:** Provided by Sungrow after application approval. If you open the application details in the Sungrow Developer Portal, you will see the App Key and the Access Key (shown as Key in that section). * **Domain URL** (optional): If left empty, European domain is used by default. Use this field to set the correct regional URL when your installations are located outside Europe. Once completed, your Sungrow inverter is integrated and data will be available immediately in the portal. ## Setup from the App (end users)[​](#setup-from-the-app-end-users "Direct link to Setup from the App (end users)") Only end users who meet the following requirements will be able to complete this process: * Have Sungrow monitoring platform username and password. * Have **owner** permissions associated with their installation. Steps: 1. Go to **More → Connections → Solar installation and batteries** in the app. 2. Tap on **Sungrow** to start the connection process. 3. On the **Connect your installation** screen, confirm the connection request. 4. Log in to the Sungrow platform with your credentials. 5. Authorize the integration by checking the required permission boxes. Once authorized, your Sungrow installation will be connected and ready for monitoring through the app. ## Monitoring capabilities[​](#monitoring-capabilities "Direct link to Monitoring capabilities") Once integrated, you will have access to: * Real-time installation data updated every 5 min * Energy production and consumption updated daily * Historical energy data available * Production and consumption graphs * System alerts and installation status * Battery monitoring and management (if applicable) note Battery actions are not time-limited, the inverter maintains the current state (charge, discharge, or pause) until a new command is received. --- # Wibeee integration The Wibeee integration allows users to connect and monitor Wibeee smart meters for solar energy monitoring through the platform. ## Setup from the portal (administrators)[​](#setup-from-the-portal-administrators "Direct link to Setup from the portal (administrators)") From the Integrations section, administrators can enable the Wibeee integration. * Go to [Settings → My Integrations](https://portal.clever.gy/dashboard/$tenant$/integrations). * Click the **Add Inverter** button. * Select Wibeee brand. * Fill in the following fields: * **Name:** Identifier for this integration in the portal (e.g. Production, Test). ## Setup from the App (end users)[​](#setup-from-the-app-end-users "Direct link to Setup from the App (end users)") Only end users who meet the following requirements will be able to complete this process: * Have **Wibeee** username and password. * Have **owner** permissions associated with their installation. Steps: 1. Go to **More → Connections → Solar installation and batteries** in the app. 2. Tap on **Wibeee** to start the connection process. 3. On the **Connect your device** screen, enter your username and password, and confirm the connection request. 4. Authorize the integration by checking the required permission boxes. Once authorized, your Wibeee installation will be connected and ready for monitoring through the app. Check the microfrontend [here](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-solar-inverter.md). ## Monitoring capabilities[​](#monitoring-capabilities "Direct link to Monitoring capabilities") Once integrated, you will have access to: * Real-time installation consumption and generation data updated every 15 min * Energy production and consumption updated daily * Historical energy data * Production and consumption power balance --- # Shelly integration The Shelly integration allows to connect and manage smart devices for energy monitoring and control. note Only Shelly Plug S and Shelly EM are currently supported. ## Setup from the portal[​](#setup-from-the-portal "Direct link to Setup from the portal") From the **Integrations** section, administrators can configure the Shelly integration in the **Smart Devices** section.
To enable this integration for your users, check in [Settings](https://portal.clever.gy/dashboard/$tenant$/integrations) if it is activated. If the integration doesn't appear, you can request activation. ## Setup from the app[​](#setup-from-the-app "Direct link to Setup from the app") To set up your Shelly devices in the app, follow these steps: 1. Go to **Profile → Connections**. 2. Click on **Shelly** to start the connection process. A screen to **Connect your devices** will appear. Choose **Connect** to assign your Shelly Plug S or Shelly EM to your home. * Enter your Shelly credentials (email and password) to authorize the connection. * Check **Activate integration** to enable data monitoring. * Optionally, enable **Control the device** if you want to control it through the app. * Device type is detected automatically and **cannot be changed**. Once connected, your Shelly devices will appear in the Smart Devices list in the app, ready for monitoring and control. Check the microfrontend [here](https://docs.clever.gy/helpdesk/microfrontends-catalog/real-time-monitoring-devices-control/smart-devices.md). ### Device configuration[​](#device-configuration "Direct link to Device configuration") #### Shelly Plug S (standard appliances)[​](#shelly-plug-s-standard-appliances "Direct link to Shelly Plug S (standard appliances)") Once linked, the Plug S will appear **without the “Unassigned” label**. * You can: * Assign or modify the **category** (e.g., lamp, electric heater). * Review and edit device settings. * **Rename** the device from the **Shelly Cloud app or web**. * **Remove** the device from the app when needed. * Once configured, it provides: * Real-time consumption data * If control permissions are granted, a **switch** will appear next to the device to turn it on/off remotely. ### Shelly EM (aerothermal or main circuits)[​](#shelly-em-aerothermal-or-main-circuits "Direct link to Shelly EM (aerothermal or main circuits)") Typically used for **aerothermal systems**, but can also monitor any major circuit. * If unconfigured, the device will show an **“Unassigned” label**. * You must: * Assign it to the **"Aerothermal"** category (or other main circuit type). * Confirm by clicking **Save**. * Once configured, it provides: * Real-time consumption data * Daily energy balance and trends * As with other devices, you can **remove** the EM from the app at any time. * Device naming must be managed from the **Shelly Cloud platform**. note When Shelly EM measures solar or energy grid: * If no other device is present, Shelly data is used. * If another inverter or grid meter is connected (e.g. Datadis), their data takes priority. ## Common issues and solutions[​](#common-issues-and-solutions "Direct link to Common issues and solutions") ### Device connection loss in aerothermal monitoring[​](#device-connection-loss-in-aerothermal-monitoring "Direct link to Device connection loss in aerothermal monitoring") Usually caused by weak Wi-Fi connection. * Try moving the router closer. * If the issue persists, instant power data may be unavailable at times, but consumption tracking continues for historical data analysis. ### Sudden shutdown of Shelly Plus Plug S: appliance stops receiving power[​](#sudden-shutdown-of-shelly-plus-plug-s-appliance-stops-receiving-power "Direct link to Sudden shutdown of Shelly Plus Plug S: appliance stops receiving power") The appliance may have hit a power limit set in Shelly Cloud. **To fix:** * Open Shelly Plus Plug S settings in the Shelly app. * Adjust the maximum power threshold to **2500W**. * Click **Save**. To prevent future shutdowns, enable **default power-on mode** in Shelly Cloud, so the plug automatically turns on if it shuts off. --- # Microfrontends Catalog ### Account setup and integrations[​](#account-setup-and-integrations "Direct link to Account setup and integrations") #### Energy essentials[​](#energy-essentials "Direct link to Energy essentials") * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/house-contracts.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/create-contract-opportunity.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/invoices.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/virtual-battery.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/virtual-wallet.md) #### Energy insights[​](#energy-insights "Direct link to Energy insights") * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/house-settings.md) #### Energy management[​](#energy-management "Direct link to Energy management") * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-smartmeter.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-electric-vehicle.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-solar-inverter.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/smart-devices-settings.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-smart-devices.md) ### Energy overview[​](#energy-overview "Direct link to Energy overview") #### Energy essentials[​](#energy-essentials-1 "Direct link to Energy essentials") * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-optimization-recommendations/energy-prices.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/energy-chart.md) #### Energy insights[​](#energy-insights-1 "Direct link to Energy insights") * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/breakdown.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/consumption-cumulative.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/invoice-estimation.md) #### Energy management[​](#energy-management-1 "Direct link to Energy management") * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/solar-info.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/insights.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/solar-summary.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/solar-amortization.md) ### Energy optimization and recommendations[​](#energy-optimization-and-recommendations "Direct link to Energy optimization and recommendations") #### Energy insights[​](#energy-insights-2 "Direct link to Energy insights") * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-optimization-recommendations/energy-contract-tariffs.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-optimization-recommendations/alerts-settings.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-optimization-recommendations/house-comparison.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-optimization-recommendations/recommendations.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-optimization-recommendations/solar-recommender.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-optimization-recommendations/tips-panel.md) ### Real time monitoring and devices control[​](#real-time-monitoring-and-devices-control "Direct link to Real time monitoring and devices control") #### Energy management[​](#energy-management-2 "Direct link to Energy management") * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/real-time-monitoring-devices-control/power-chart.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/real-time-monitoring-devices-control/battery.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/real-time-monitoring-devices-control/smart-devices.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/real-time-monitoring-devices-control/solar-real-time.md) * [``](https://docs.clever.gy/helpdesk/microfrontends-catalog/real-time-monitoring-devices-control/electric-vehicle-charge.md) --- # Create contract opportunity The `` microfrontend allows users to complete the entire electricity contracting process from any digital touchpoint -your website, app, or landing page-, letting them choose a tariff directly or upload their electricity bill for a personalized recommendation. ## Client prerequisites[​](#client-prerequisites "Direct link to Client prerequisites") * **Configure tariffs**: Set up available tariffs in the Clevergy portal (`portal.clever.gy`) or via the API. The required authentication mechanism depends on how and where the microfrontend is used: * **New contracts outside the app**: [Contact us](mailto:soporte.clientes@clever.gy) to receive your `data-client-key`. * **Existing users for second residence contracting**: Provide a valid JWT for the authenticated user. ## User journey[​](#user-journey "Direct link to User journey") 1. The user starts by viewing the available tariffs and may optionally upload their electricity bill, which enables automatic analysis and personalized tariff recommendations. * The microfrontend can be configured to start directly uploading an invoice via the `data-start-step` parameter. When this mode is enabled, the user cannot skip the invoice upload step and the top 3 tariffs with the highest estimated savings are displayed after analysis. 2. If no bill is uploaded, the user manually selects a tariff. For authenticated users, available personal data (ID number, full name, email, and phone) is automatically pre-filled, and any missing fields are completed during the process and saved to the user profile. Supply data (address and CUPS) must be provided by the user (it is intentionally left empty for authenticated users, as for them this flow supports contracting for a second residence). 3. If a bill is uploaded, the microfrontend analyzes the user's consumption to recommend the most suitable tariff and automatically extracts and pre-fills any available personal and supply data. * It also performs a power analysis and suggests an optimized contracted power when applicable, unless this feature is disabled via the `data-suggest-power-optimization` attribute. 4. The user then enters their bank details (account holder name and IBAN). 5. Finally, the user reviews all collected information in a confirmation screen before completing the contract. ## Sales opportunity management[​](#sales-opportunity-management "Direct link to Sales opportunity management") Clevergy automatically manages the creation and updating of a sales opportunity throughout the contracting flow: * An electricity contract sales opportunity is created as soon as the user completes their personal information. * The opportunity is incrementally updated as the user advances through the process, ensuring that no lead is lost even if the flow is abandoned. * The opportunity automatically flags any ownership or power changes detected during the process. * When the user completes the final confirmation, the opportunity status is updated to “Formalized”, indicating a successfully finalized contract. * If a referral code was provided with the attribute `data-referral-code`, it is attached to the opportunity for referral tracking. For more details, see the [sales opportunities documentation](https://docs.clever.gy/helpdesk/portal/workspaces/sales-opportunities/.md). ## Technical documentation[​](#technical-documentation "Direct link to Technical documentation") [Check out the full documentation for `clevergy-create-contract-opportunity`.](https://modules.clever.gy/?path=/docs/clevergy-create-contract-opportunity--documentation) --- # House contracts The `` microfrontend allows users to view and manage information related to their contracts. ## Contract types[​](#contract-types "Direct link to Contract types") This microfrontend supports the following contract types: * Electricity contracts * Gas contracts This microfrontend displays all the information available for each contract (`startDate`, `endDate`, `tariffAccess`, `tariffName`, `powerPrice`, `energyPrice`... ). For more information about how to create contracts, see **[contracts](https://docs.clever.gy/developer/how-to-set-up/contracts.md)**. ## Contract statuses[​](#contract-statuses "Direct link to Contract statuses") Contracts can be displayed in the following states: * `Active`: contracts that are currently in force. * `Inactive`: contracts that have been cancelled. [Check out the full documentation for `clevergy-house-contracts`.](https://modules.clever.gy/?path=/docs/clevergy-house-contracts--documentation) --- # House settings ## Description[​](#description "Direct link to Description") The `` microfrontend empowers customers to configure their home details for personalized energy analysis and recommendations. This microfrontend collects essential information about the home that enables more accurate insights across the platform. ## Requirements[​](#requirements "Direct link to Requirements") To ensure this microfrontend functions correctly, users must have: * **An active account:** Users need to be registered and logged in to access and save their house settings. ## Use cases with examples[​](#use-cases-with-examples "Direct link to Use cases with examples") ### 1. Initial configuration[​](#1-initial-configuration "Direct link to 1. Initial configuration") Users can easily set up their home profile by entering details about their living space. [House Settings](https://modules.clever.gy/iframe.html?id=clevergy-house-settings--clevergy-settings-default\&viewMode=story\&nav=0) ### 2. Configuration options[​](#2-configuration-options "Direct link to 2. Configuration options") The microfrontend provides comprehensive settings including: * House type (apartment, single-family home) * House size (m²) * Number of occupants * Gas equipment * Self-consumption equipment * Electric appliances * Other equipment ### 3. Benefits of configuration[​](#3-benefits-of-configuration "Direct link to 3. Benefits of configuration") By configuring their house settings, users unlock advanced features across the platform: * **[Advanced Home Comparison](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-optimization-recommendations/house-comparison.md#2-advanced-version)**: Access to more detailed comparisons with similar homes * **[Breakdown at the appliance level](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/breakdown.md#1-appliance-level-consumption-analysis)**: Ability to see energy consumption broken down by individual appliances * **Personalized energy insights**: More accurate recommendations based on specific home configuration tip Encouraging users to configure their house settings enables them to gain more accurate energy insights and meaningful comparisons. ## Technical documentation[​](#technical-documentation "Direct link to Technical documentation") [Check out the full documentation for `clevergy-house-settings`.](https://modules.clever.gy/?path=/docs/clevergy-house-settings--documentation) --- # Integration electric vehicle ## Description[​](#description "Direct link to Description") The `` microfrontend allows end-users to link their electric vehicle by entering their vehicle account credentials. Once linked, users can view status, start or stop charging, and track battery state of charge and estimated driving range. **Only one vehicle can be linked per house**. ## Integration Flow[​](#integration-flow "Direct link to Integration Flow") [Integration electric vehicle](https://modules.clever.gy/iframe.html?id=clevergy-integration-electric-vehicle-b2c--clevergy-integration-electric-vehicle-default\&viewMode=story\&nav=0) 1. After confirming, the user is redirected to the Enode flow, where they select their vehicle brand, sign in with their manufacturer account, and grant the required permissions. 2. Once the Enode flow is completed successfully, the vehicle is linked to the user account and a confirmation is shown in the microfrontend. 3. After completing the process, real-time status, charge control and telemetry are available through the [Electric vehicle charging](https://docs.clever.gy/helpdesk/microfrontends-catalog/real-time-monitoring-devices-control/electric-vehicle-charge.md) microfrontend. --- # Integration smart devices ## Description[​](#description "Direct link to Description") The `` microfrontend lets end users link supported smart devices to a home so they can monitor and manage energy usage from your website or app. ## Technical Documentation[​](#technical-documentation "Direct link to Technical Documentation") [Check out the full documentation for `clevergy-integration-smart-devices`.](https://modules.clever.gy/?path=/docs/clevergy-integration-smart-devices--documentation) --- # Integration smartmeter ## Description[​](#description "Direct link to Description") The Smart Meter integration allows users to connect their electricity consumption data to the platform, providing valuable insights into their energy usage. Authentication is required **only once per user**, regardless of how many homes they want to link. ## Technical documentation[​](#technical-documentation "Direct link to Technical documentation") [Check out the full documentation for `clevergy-integration-smartmeter`.](https://modules.clever.gy/?path=/docs/clevergy-integration-smartmeter--documentation) --- # Integration solar inverters ## Description[​](#description "Direct link to Description") The `` microfrontend allows end-users to directly connect their compatible solar installations (Huawei, Fronius, SMA, Sungrow and Sigenergy, among others) using their personal inverter-account credentials. This microfrontend can be embedded in any client's website. ## Integration flow[​](#integration-flow "Direct link to Integration flow") [Integration solar inverters](https://modules.clever.gy/iframe.html?id=clevergy-integration-solar-inverters--default\&viewMode=story\&nav=0) 1. **Process initiation**: The user clicks a button on the website or app where the microfrontend is embedded. 2. **Provider login / redirect**: Depending on the inverter brand, the user either: * Enters their inverter account credentials directly in the microfrontend, or * Is redirected to the inverter’s official portal to authenticate. 3. **Connection confirmation**: After successful authentication, the system establishes a connection with the selected solar installation and displays a confirmation message. info After a successful connection, it may take a few minutes for the data to be available in other microfrontends such as [Energy Chart](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/energy-chart.md), [Consumption Cumulative](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/consumption-cumulative.md), and [Power Chart](https://docs.clever.gy/helpdesk/microfrontends-catalog/real-time-monitoring-devices-control/power-chart.md). The entire process is secure, and neither the username nor the password is stored. ## Technical Documentation[​](#technical-documentation "Direct link to Technical Documentation") [Check out the full documentation for `clevergy-integration-solar-inverters`.](https://modules.clever.gy/?path=/docs/clevergy-integration-solar-inverters--documentation) --- # Invoices This microfrontend is responsible for displaying customer invoice information. It provides two different visualization modes controlled by the `data-visualization-mode` parameter: * `last-invoice` * `list` Each mode defines how invoice data is fetched, displayed, and interacted with. ## 1. Last invoice mode[​](#1-last-invoice-mode "Direct link to 1. Last invoice mode") When `data-visualization-mode` is set to `last_invoice`, the microfrontend displays the **most recent invoice**, regardless of its type (electricity or gas). Also shows some key invoice information, including the billing period, total cost, and -when applicable- the invoice breakdown. info The invoice breakdown is **only available for electricity invoices**. In this case, the client can view a detailed breakdown of cost components such as energy consumption, power costs, taxes, and surplus benefits, as well as download the invoice. To enable this feature, additional data must be provided for each invoice. You can find the setup instructions in the [following documentation](https://docs.clever.gy/developer/how-to-set-up/invoices.md) For gas invoices, the breakdown is not displayed, but the invoice can still be downloaded directly. ## 2. List mode[​](#2-list-mode "Direct link to 2. List mode") When `data-visualization-mode` is set to `list`, the microfrontend displays a historical overview of invoices, including their total cost. Invoices are ordered by issue date (most recent first) and grouped by year for easier navigation. This mode also provides a visual representation of monthly spending evolution, helping clients analyze cost trends and better understand their consumption patterns over time. Through the magnifying glass icon located on the right side of each invoice, the client can either view the detailed invoice breakdown (when additional invoice metadata has been provided) or download the invoice directly (when such metadata is not available). ## Technical documentation[​](#technical-documentation "Direct link to Technical documentation") [Check out the full documentation for `clevergy-invoices`.](https://modules.clever.gy/?path=/docs/clevergy-invoices--documentation) --- # Smart devices settings ## Technical Documentation[​](#technical-documentation "Direct link to Technical Documentation") [Check out the full documentation for `clevergy-smart-devices-settings`.](https://modules.clever.gy/?path=/docs/clevergy-smart-devices-settings--documentation) --- # Virtual battery ## Description[​](#description "Direct link to Description") The Virtual Battery allows users with solar panels to store their surplus energy as a virtual kW balance. When their production exceeds consumption, the excess energy is saved and later used to offset grid consumption, reducing their electricity bill. ## Technical documentation[​](#technical-documentation "Direct link to Technical documentation") [Check out the full documentation for `clevergy-virtual-battery`.](https://modules.clever.gy/?path=/docs/clevergy-virtual-battery--documentation) --- # Virtual wallet ## Description[​](#description "Direct link to Description") The Virtual Wallet provides users with a euro-based credit that is applied as a discount at the end of each billing cycle. This credit is generated from surplus solar energy converted into monetary value, as well as from promotions and referral programs. The balance is tracked automatically and applied directly to the user's invoice. ## Technical documentation[​](#technical-documentation "Direct link to Technical documentation") [Check out the full documentation for `clevergy-virtual-wallet`.](https://modules.clever.gy/?path=/docs/clevergy-virtual-wallet--documentation) --- # Breakdown ## Description[​](#description "Direct link to Description") The `` microfrontend helps users identify which appliances consume the most energy, enabling them to make data-driven decisions for energy savings. This tool displays home energy consumption by appliance categories, providing clear visibility into energy usage patterns. ## Requirements[​](#requirements "Direct link to Requirements") To ensure this microfrontend displays correctly, users must have: * **Sufficient consumption data:** The system needs enough historical consumption data to identify appliance patterns accurately. * **House settings configured:** For the most accurate breakdown, users should complete their house settings with details about their appliances. ## Use cases with examples[​](#use-cases-with-examples "Direct link to Use cases with examples") ### 1. Appliance-level consumption analysis[​](#1-appliance-level-consumption-analysis "Direct link to 1. Appliance-level consumption analysis") Users can visualize their energy usage distributed across different appliance categories to identify major consumption sources. [Energy Breakdown](https://modules.clever.gy/iframe.html?id=clevergy-breakdown--clevergy-breakdown-default\&viewMode=story\&nav=0) ### 2. Key features[​](#2-key-features "Direct link to 2. Key features") The microfrontend provides comprehensive insights including: * Visual breakdown of energy consumption by appliance * Identification of high-consumption devices * Percentage distribution of energy usage * Historical consumption trends by appliance ### 3. View availability[​](#3-view-availability "Direct link to 3. View availability") info Only available in monthly and yearly views because: * Requires sufficient data for pattern recognition * Daily views show irregular, non-representative usage * Algorithm works best with larger datasets ### 4. How it works[​](#4-how-it-works "Direct link to 4. How it works") Our algorithm analyzes energy consumption patterns to identify signature usage profiles of common household appliances. The system: 1. Collects high-resolution energy consumption data 2. Processes usage patterns to identify specific appliance signatures 3. Categorizes consumption by appliance type 4. Presents a clear breakdown of energy usage This intelligence helps users make informed decisions about which appliances might benefit from replacement or modified usage patterns to reduce their overall energy consumption. ## Technical documentation[​](#technical-documentation "Direct link to Technical documentation") [Check out the full documentation for `clevergy-breakdown`.](https://modules.clever.gy/?path=/docs/clevergy-breakdown--documentation) --- # Consumption cumulative [Check out the full documentation for `clevergy-consumption-cumulative`.](https://modules.clever.gy/?path=/docs/clevergy-consumption-cumulative--documentation) --- # Energy chart ## Description[​](#description "Direct link to Description") The `` microfrontend provides an interactive visualization of energy consumption and production data. It offers two views of the energy data, `grid` or `house`, so people can track their energy patterns across different time periods and identify opportunities for optimization. * **Grid view:** shows only the data from the distribution company (FTP or Datadis), that is, the kWh imported from and exported to the grid. These are the values that appear on the electricity bill. * **House view:** shows the total consumption of the home (including self-consumption, if any) together with the production. It is mainly useful for people who have connected their solar inverter. You choose the view with the `data-electricity-view` attribute, which accepts `grid` or `house`. ## Requirements[​](#requirements "Direct link to Requirements") To ensure this microfrontend displays correctly, clients must have: * **A configured integration:** It is necessary to have an integration set up to connect to the data. The grid view requires distribution company data, either via FTP (see **[Distributors](https://docs.clever.gy/helpdesk/integrations/distributors.md)**) or via **[Datadis](https://docs.clever.gy/helpdesk/integrations/datadis.md)**. The House view requires a **[solar inverter](https://docs.clever.gy/helpdesk/integrations/inverters/.md)**, or data provided via the connect API by your team. * **Available energy data:** Even if the house is linked, the energy source must return data correctly. Without available data, the chart will not be able to display information. ## Use cases with examples[​](#use-cases-with-examples "Direct link to Use cases with examples") ### 1. Grid view: imported and exported energy[​](#1-grid-view-imported-and-exported-energy "Direct link to 1. Grid view: imported and exported energy") The grid view is available to all people in your app. It shows the energy imported from and exported to the grid, based on distribution company data, which is the energy that is billed. People can monitor their daily, weekly, or monthly grid consumption to identify opportunities for energy savings. [Grid consumption](https://modules.clever.gy/iframe.html?id=clevergy-energy-chart--grid-energy-consumption\&viewMode=story\&nav=0) ### 2. House view with a solar inverter[​](#2-house-view-with-a-solar-inverter "Direct link to 2. House view with a solar inverter") The house view shows the total consumption of the home, including the energy self-consumed from the solar installation, together with the solar production. It lets people compare production with consumption to optimize self-consumption and maximize the benefits of their installation. [House consumption and production](https://modules.clever.gy/iframe.html?id=clevergy-energy-chart--energy-chart-default\&viewMode=story\&nav=0) ### 3. Comparing gas consumption over time[​](#3-comparing-gas-consumption-over-time "Direct link to 3. Comparing gas consumption over time") info Requires gas contracts and uploaded invoices to access this feature. Enables analysis and comparison of gas consumption based on invoice data. Since gas consumption is obtained from invoices, the microfrontend displays **consumption data for the last 14 months only**, allowing clients to compare recent months with previous periods and better understand seasonal variability and consumption patterns over time. [Gas consumption](https://modules.clever.gy/iframe.html?id=clevergy-energy-chart--gas-consumption\&viewMode=story\&nav=0) ### 4. Energy community production[​](#4-energy-community-production "Direct link to 4. Energy community production") info Requires connection to an energy community to access this feature. Members of energy communities can visualize the production corresponding to their share based on their coefficient, helping them understand their portion of community benefits. [Energy community production](https://modules.clever.gy/iframe.html?id=clevergy-energy-chart--energy-community-production\&viewMode=story\&nav=0) ### 5. Cost (deprecated soon)[​](#5-cost-deprecated-soon "Direct link to 5. Cost (deprecated soon)") note This feature is being deprecated. We found that showing euros with such a fine granularity does not provide value, and it is better to present costs in another way. Use the **[invoice estimation](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/invoice-estimation.md)** module to show the forecast of the bill, or the **[invoices](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/invoices.md)** module to show the chart of past invoices. If the client has a contract with their tariff and prices configured, the chart can display the **cost** of the energy instead of the kWh, in both the grid and house views. [Grid cost](https://modules.clever.gy/iframe.html?id=clevergy-energy-chart--grid-energy-cost\&viewMode=story\&nav=0) ## Technical documentation[​](#technical-documentation "Direct link to Technical documentation") [Check out the full documentation for `clevergy-energy-chart`.](https://modules.clever.gy/?path=/docs/clevergy-energy-chart--documentation) --- # Insights ## Description[​](#description "Direct link to Description") The `` microfrontend shows users insights about their habits at home. ## What it shows[​](#what-it-shows "Direct link to What it shows") So far, the module shows: * **How much of your installation you use:** of the energy you produce, how much you consume yourself. * **How self-sufficient you are:** of the energy you consume at home, how much comes from renewable sources. * **How much of your consumption comes from the battery:** of the energy you consume at home, how much comes from the battery. [Insights with battery](https://modules.clever.gy/iframe.html?id=clevergy-insights--clevergy-insights-with-battery\&viewMode=story\&nav=0) ## Requirements[​](#requirements "Direct link to Requirements") Not every insight is available to every user: * **Installation use and self-sufficiency:** only available to users with a connected inverter. * **Battery consumption:** only available to users with a battery. [Check out the full documentation for `clevergy-insights`.](https://modules.clever.gy/?path=/docs/clevergy-insights--documentation) --- # Invoice estimation ## Description[​](#description "Direct link to Description") The `` microfrontend shows users how much they have spent (in euros) so far in the current billing period and estimates what their next electricity bill will be. It replaces the older [Consumption cumulative](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/consumption-cumulative.md) module, which will be progressively deprecated as clients migrate to this new module. ## Requirements[​](#requirements "Direct link to Requirements") For this microfrontend to display correctly, users must have: * **An active electricity contract:** The module is only available to users with an active electricity supply contract. * **Configured contract prices:** The module needs power and consumption prices to calculate costs. If the tariff has surplus (energy export) data but no prices configured, or if a dynamic tariff has no prices covering the dates of the current period, prices will be considered unavailable for that period. Without these requirements, the microfrontend will show a "not yet available" message instead of its content. note If you are still seeing the Consumption cumulative module and would like to switch to this new module, contact your Customer Success Manager. ## How it works[​](#how-it-works "Direct link to How it works") * **Current billing period:** The module shows the accumulated cost from the end date of the user's last invoice up to today. For new users without any previous invoices, the period starts on the electricity contract's start date instead. * **Estimated bill amount:** During the first 30 days of the billing period, the module projects what the final bill will look like based on spending so far. Once the period runs longer than 30 days without a new invoice being issued, it shows the actual accumulated cost instead of a projection. ## Use cases with examples[​](#use-cases-with-examples "Direct link to Use cases with examples") ### 1. Default[​](#1-default "Direct link to 1. Default") The module renders normally, showing the accumulated cost and estimated bill amount. [Invoice Estimation Default](https://modules.clever.gy/iframe.html?id=clevergy-invoice-estimation--clevergy-invoice-estimation-default\&viewMode=story\&nav=0) ### 2. Data not available[​](#2-data-not-available "Direct link to 2. Data not available") If consumption data has not been updated, or the contract prices have not been configured correctly, the module shows a "not yet available" message. [Invoice Estimation Without Consumption](https://modules.clever.gy/iframe.html?id=clevergy-invoice-estimation--clevergy-invoice-estimation-without-consumptions\&viewMode=story\&nav=0) ## Technical documentation[​](#technical-documentation "Direct link to Technical documentation") [Check out the full documentation for `clevergy-invoice-estimation`.](https://modules.clever.gy/?path=/docs/clevergy-invoice-estimation--documentation) --- # Solar amortization ## Description[​](#description "Direct link to Description") The `` microfrontend helps homeowners understand the financial benefits of their solar investment. It provides clear visualization of when the system will pay for itself and tracks ongoing savings, making complex financial returns easy to understand. ## Requirements[​](#requirements "Direct link to Requirements") For this microfrontend to display correctly, users must have: * **A linked solar installation:** The system needs access to the user's solar installation data to perform calculations. * **Configured contract prices:** Users must have their electricity contract prices set up in the system to enable accurate calculations based on their specific tariff. Without these requirements, the microfrontend will not render. ## Use cases with examples[​](#use-cases-with-examples "Direct link to Use cases with examples") ### 1. Initial configuration[​](#1-initial-configuration "Direct link to 1. Initial configuration") info This feature requires a connected solar installation. When setting up for the first time, people are guided through a simple process to input their initial investment details: * Total cost of their solar installation * Any subsidies or grants they received to offset the cost The system then calculates historical savings based on self-consumption and surplus energy sold back to the grid. While we provide estimated figures based on standard rates, users can adjust these values if they have more precise information from previous calculations. ### 2. Configured microfrontend[​](#2-configured-microfrontend "Direct link to 2. Configured microfrontend") Once set up, the dashboard presents a clear picture of the investment performance, showing: * Current progress toward complete payback * Projected date when the installation will be fully paid off * Helpful context messages that explain what the data means This view gives homeowners confidence in their investment decision and helps them track their progress over time. ### 3. Monthly performance[​](#3-monthly-performance "Direct link to 3. Monthly performance") info To obtain this, your users will need to have their contract prices in order to make the calculations based on their tariff. This is necessary for obtaining the savings. After collecting actual production data, the calculations become more personalized. Monthly savings are determined by combining: * Value of energy not purchased from the grid (self-consumption) * Income from surplus energy exported to the grid This approach provides an accurate picture of financial benefits that reflects the user's specific energy habits and local tariffs. ### 4. Messages system[​](#4-messages-system "Direct link to 4. Messages system") To make the experience more engaging, the microfrontend displays timely messages: * **Milestone alerts** celebrate progress at key points (25%, 50%, 75%, and 100% amortization) * **Monthly comparisons** highlight savings improvements over previous periods * **Practical equivalents** translate abstract energy numbers into everyday appliance usage ## Technical documentation[​](#technical-documentation "Direct link to Technical documentation") [Check out the full documentation for `clevergy-solar-amortization`.](https://modules.clever.gy/?path=/docs/clevergy-solar-amortization--documentation) --- # Solar info [Check out the full documentation for `clevergy-solar-info`.](https://modules.clever.gy/?path=/docs/clevergy-solar-info--documentation) --- # Solar summary danger This module is goig to be deprecated. Use the **[Insights](https://docs.clever.gy/helpdesk/microfrontends-catalog/energy-insights/insights.md)** module instead. [Check out the full documentation for `clevergy-solar-summary`.](https://modules.clever.gy/?path=/docs/clevergy-solar-summary--documentation) --- # Alerts settings [Check out the full documentation for `clevergy-alerts-settings`.](https://modules.clever.gy/?path=/docs/clevergy-alerts-settings--documentation) --- # Energy contract tariffs ## Description[​](#description "Direct link to Description") The `` microfrontend displays the energy prices corresponding to each client's contracted tariff, with or without surplus. The chart adapts automatically to the customer's tariff type: * **Indexed**: prices linked to the spot market * **PVPC**: regulated price set by the Spanish government * **Period**: different prices per time slot (peak, flat, off-peak) * **Fixed**: a single price per kWh regardless of consumption time * **Custom**: for tariffs that do not follow any standard pattern ## Technical documentation[​](#technical-documentation "Direct link to Technical documentation") [Check out the full documentation for `clevergy-contract-tariffs`.](https://modules.clever.gy/?path=/docs/clevergy-contract-tariffs--documentation) --- # Energy prices [Check out the full documentation for `clevergy-energy-prices`.](https://modules.clever.gy/?path=/docs/clevergy-energy-prices--documentation) --- # House comparison ## Description[​](#description "Direct link to Description") The `` microfrontend helps customers understand their energy consumption by comparing with relevant household groups. It provides meaningful benchmarks that contextualize usage patterns and motivate energy-saving behaviors. ## Requirements[​](#requirements "Direct link to Requirements") To ensure this microfrontend displays correctly, users must have: * **Consumption data available:** The system needs access to the user's consumption data to make comparisons. * **House settings configured:** For advanced comparisons (similar homes and efficient homes), users must complete their house settings with details about size, type, and other characteristics. note This microfrontend is hidden if the home has solar generation, as accurate consumption comparisons are not possible. ## Use cases with examples[​](#use-cases-with-examples "Direct link to Use cases with examples") ### 1. Basic version[​](#1-basic-version "Direct link to 1. Basic version") A simplified comparison showing the user's consumption against local neighborhood averages. [Basic Home Comparison](https://modules.clever.gy/iframe.html?id=clevergy-house-comparison--view-default\&viewMode=story\&nav=0\&args=data-show-dates-selector:true;data-variant:basic) ### 2. Advanced version[​](#2-advanced-version "Direct link to 2. Advanced version") info Requires completed house settings to access similar homes and efficient homes comparisons. Provides more detailed comparisons with similar household types and efficient homes in the same category. [Advanced Home Comparison](https://modules.clever.gy/iframe.html?id=clevergy-house-comparison--view-default\&viewMode=story\&nav=0\&args=data-show-dates-selector:true;data-variant:advanced) **Available metrics:** * Your household consumption * Local neighborhood average consumption ## Comparison types[​](#comparison-types "Direct link to Comparison types") **Efficient homes** Benchmark against the top 30% energy-efficient households in your category to understand your improvement potential. **Similar homes** Compare with households matching your profile based on size and type. Advanced version exclusive. **Neighborhood average** View local consumption patterns from your postal code area for regional context. ## Technical documentation[​](#technical-documentation "Direct link to Technical documentation") [Check out the full documentation for `clevergy-house-comparison`.](https://modules.clever.gy/?path=/docs/clevergy-house-comparison--documentation) --- # Recommendations [Check out the full documentation for `clevergy-recommendations`.](https://modules.clever.gy/?path=/docs/clevergy-recommendations--documentation) --- # Solar recommender [Check out the full documentation for `clevergy-solar-recommender`.](https://modules.clever.gy/?path=/docs/clevergy-solar-recommender--documentation) --- # Tips panel [Check out the full documentation for `clevergy-tips-panel`.](https://modules.clever.gy/?path=/docs/clevergy-tips-panel--documentation) --- # Battery monitoring ## Description[​](#description "Direct link to Description") The `` microfrontend provides real-time monitoring and control of your Huawei battery system. This microfrontend enables users to track their battery's state of charge and control charging/discharging operations through an intuitive interface. ## Requirements[​](#requirements "Direct link to Requirements") To ensure this microfrontend displays correctly, users must have: * **Huawei battery system:** A compatible Huawei battery system must be installed. * **Authentication credentials:** One of the following: * **API Key (read-only access):** Only allows monitoring battery status. * **OAuth credentials (full access):** Enables both monitoring and control operations. info The microfrontend automatically adapts its interface based on the authentication level. ## Use cases with examples[​](#use-cases-with-examples "Direct link to Use cases with examples") ### 1. Battery status monitoring[​](#1-battery-status-monitoring "Direct link to 1. Battery status monitoring") View real-time battery information including: * Current state of charge (%) * Charging/discharging power (kW) * Battery status indicator [Battery Status](https://modules.clever.gy/iframe.html?id=clevergy-battery--clevergy-battery-no-actionable\&viewMode=story\&nav=0) ### 2. Battery control[​](#2-battery-control "Direct link to 2. Battery control") info Control buttons are only visible with OAuth authentication. Users with API Key access will not see these controls. Manage your battery operation with three control options: * **Charge:** Manually start battery charging * **Discharge:** Manually initiate battery discharge * **Stop:** Halt current battery operation [Battery Control](https://modules.clever.gy/iframe.html?id=clevergy-battery--clevergy-battery-default\&viewMode=story\&nav=0) ## Technical documentation[​](#technical-documentation "Direct link to Technical documentation") [Check out the full documentation for `clevergy-battery`.](https://modules.clever.gy/?path=/docs/clevergy-battery--documentation) --- # Electric vehicle charging ## Description[​](#description "Direct link to Description") The `` microfrontend provides real-time monitoring and control of a linked electric vehicle. Once the vehicle is linked (see [Integration electric vehicle](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/integration-electric-vehicle.md)), users can view its status, start or stop charging, and track battery state of charge and estimated driving range. ## States[​](#states "Direct link to States") * **Not linked**: No vehicle account is linked yet. Users must complete the linking process to enable data and controls. * **Linked (not plugged in)**: The vehicle is linked but not plugged into a charger. Charging is not available in this state. * **Linked and plugged**: The vehicle is linked and plugged in, ready to start charging. * **Charging**: Active charging session in progress. When a charge command is initiated, the interface displays the estimated time to full charge. ## Telemetry[​](#telemetry "Direct link to Telemetry") * Battery state of charge (%) * Estimated driving range (km) * Data refreshes every 5 minutes. ## Technical documentation[​](#technical-documentation "Direct link to Technical documentation") [Check out the full documentation for `clevergy-electric-vehicle-charge`.](https://modules.clever.gy/?path=/docs/clevergy-electric-vehicle-charge--documentation) --- # Power chart [Check out the full documentation for `clevergy-power-chart`.](https://modules.clever.gy/?path=/docs/clevergy-power-chart--documentation) --- # Smart devices [Check out the full documentation for `clevergy-smart-devices`.](https://modules.clever.gy/?path=/docs/clevergy-smart-devices--documentation) --- # Solar real-time [Check out the full documentation for `clevergy-solar-real-time`.](https://modules.clever.gy/?path=/docs/clevergy-solar-real-time--documentation) --- # Portal [Clevergy Operations Portal](https://portal.clever.gy) is the main interface for managing your users, installations, and operational activity across the platform. ## Dashboard KPIs[​](#dashboard-kpis "Direct link to Dashboard KPIs") The main dashboard displays key metrics at a glance: * **Total users**: Total number of registered users. * **Completed users**: Users who have completed onboarding and have valid data. * **New tickets**: Support tickets created and not yet processed. * **Open sales opportunities**: Active commercial opportunities not yet closed. * **Total supply points**: Unique supply points (e.g. homes or locations) linked to an energy contract. * **PV (Photovoltaic)**: Installations with solar generation systems. * **Aerothermal**: Installations with aerothermal systems. * **Batteries**: Installations that include energy storage systems. You can also check the **New users** and **Active users** evolution charts to track growth and engagement over time. ## User profile[​](#user-profile "Direct link to User profile") Access your profile by clicking your username in the top-right corner of the portal. The popup shows your email, [role](https://docs.clever.gy/helpdesk/portal/settings/access-control/roles-and-permissions.md), and company, and allows you to log out of your account. ## [🗃Workspaces](https://docs.clever.gy/helpdesk/portal/workspaces/.md) [5 items](https://docs.clever.gy/helpdesk/portal/workspaces/.md) ## [🗃My Data](https://docs.clever.gy/helpdesk/portal/my-data/.md) [3 items](https://docs.clever.gy/helpdesk/portal/my-data/.md) ## [🗃Settings](https://docs.clever.gy/helpdesk/portal/settings/.md) [5 items](https://docs.clever.gy/helpdesk/portal/settings/.md) --- # My Data The My Data section provides access to all your core business information and management tools. ## Available Sections[​](#available-sections "Direct link to Available Sections") ### Users[​](#users "Direct link to Users") Manage all aspects of your user accounts: * View and edit user profiles * Track user status and registration * Send individual notifications * Manage user access * View linked houses [Learn more about Users Management](https://docs.clever.gy/helpdesk/portal/my-data/users/.md) ### Installations[​](#installations "Direct link to Installations") Monitor and manage your solar installations: * Track installation status * View performance metrics * Monitor alerts and issues * Manage inverter connections * Access installation details [Learn more about Installations Management](https://docs.clever.gy/helpdesk/portal/my-data/installations/.md) ### Energy Communities[​](#energy-communities "Direct link to Energy Communities") Oversee your energy sharing communities: * Create and manage communities * Add and remove members * Monitor energy sharing * View community statistics * Manage community settings [Learn more about Energy Communities](https://docs.clever.gy/helpdesk/portal/workspaces/energy-communities/.md) ## Navigation[​](#navigation "Direct link to Navigation") Access these sections through the left sidebar menu under "My Data". Each section provides specialized tools and detailed information for managing different aspects of your business. --- # Contracts Contracts store the energy contract information associated with a client, used to create their supply point and calculate energy costs shown to the client in the app. ## [📄️Contract list](https://docs.clever.gy/helpdesk/portal/my-data/contracts/contract-list.md) [In this section, you can view the complete list of contracts registered in the system, along with the main indicators and available filters.](https://docs.clever.gy/helpdesk/portal/my-data/contracts/contract-list.md) ## [📄️Contract details](https://docs.clever.gy/helpdesk/portal/my-data/contracts/contract-details.md) [In the contract details page you will find all the information associated with the energy contract. The fields shown depend on whether it is an electricity or a gas contract.](https://docs.clever.gy/helpdesk/portal/my-data/contracts/contract-details.md) --- # Contract details In the contract details page you will find all the information associated with the energy contract. The fields shown depend on whether it is an **electricity** or a **gas** contract. ## Electricity contract[​](#electricity-contract "Direct link to Electricity contract") * Contract number * CUPS * Address and postal code * Start date and end date * Status: `ACTIVE`, `INACTIVE` * Tariff access: `2.0TD`, `3.0TD`, `6.1TD` * Tariff name * Retailer name and distributor name * Contract holder * Contracted power (P1-P6) * Import and surplus tariff type: `FIXED`, `PVPC`, `INDEXED`, `PERIOD`, `CUSTOM` * Energy prices and surplus prices (up to 6 periods) * Power prices (P1-P6) * IBAN ## Gas contract[​](#gas-contract "Direct link to Gas contract") * Contract number * CUPS * Address and postal code * Start date and end date * Status: `ACTIVE`, `INACTIVE` * Tariff access: `RL01` to `RL11` * Tariff name * Retailer name and distributor name * Contract holder * Pressure * Fixed price (€/day) and energy price (€/kWh) * IBAN --- # Contract list In this section, you can view the complete list of contracts registered in the system, along with the main indicators and available filters. ## Visible KPIs[​](#visible-kpis "Direct link to Visible KPIs") * **Total active contracts** * **Contracts that have used Clevergy (app or microfrotend)** ## Available filters[​](#available-filters "Direct link to Available filters") * **Status**: filter by active or inactive contracts. * **Self-consumption**: filter by whether the contract has self-consumption (yes/no). * **Contract type**: filter by electricity or gas contracts. * **Search by CUPS, DNI, or contract number**: search field to locate a specific contract. ## Contract table[​](#contract-table "Direct link to Contract table") The table displays the following information for each contract: * **Contract number** * **CUPS** * **DNI** * **Type** * **Status** * **Start date** * **End date** At the top right of the table, the total number of results is shown based on the filters. note Contracts can't be created from this list. Normally, contracts are loaded automatically through the Connect API or the integration with the client's ERP/CRM. Also, you can create a contract manually from the user's page (see **[Create a contract](https://docs.clever.gy/helpdesk/portal/my-data/users/create-a-contract.md)**). --- # Installations Solar installations manage the connection with all compatible inverters. In the overview of the **[Installations](https://portal.clever.gy/dashboard/$tenant$/installations)** section, you can find: * **KPIs** showing the total number of installations, how many are linked to a house and how many are disconnected. * A **detailed list of installations**, including: name, address, whether the installation has a battery, installation date, peak power, status, plant code, and inverter brand. * **Filters** to narrow down the view by integration, linked vs. not linked status, and installation status, plus a search bar to quickly find installations by name. This list of installations is updated every 3 hours. ## [📄️Installation details](https://docs.clever.gy/helpdesk/portal/my-data/installations/installation-details.md) [In the installation details page you will find:](https://docs.clever.gy/helpdesk/portal/my-data/installations/installation-details.md) ## [📄️Smart alerts for solar installations](https://docs.clever.gy/helpdesk/portal/my-data/installations/smart-alerts.md) [Smart alerts complement native inverter alerts by adding additional logic to detect issues that may not trigger a direct inverter error. They are rule-based checks executed daily to analyze installation behavior and detect abnormal situations.](https://docs.clever.gy/helpdesk/portal/my-data/installations/smart-alerts.md) ## [📄️Link installation](https://docs.clever.gy/helpdesk/portal/my-data/installations/link-installation.md) [You can link an installation to a house so that the client can view their installation information. This allows the homeowner to monitor their solar installation data directly through the mobile app.](https://docs.clever.gy/helpdesk/portal/my-data/installations/link-installation.md) --- # Installation details In the installation details page you will find: * **Basic details**: plant name, address, installation date, peak power, inverter brand and linked house. * \*\* Power and energy information\*\*: * Energy graph showing production and consumption data * Current power production * Power balance * Battery usage (if applicable) * **Alerts**: * A historical view of the alerts, including severity, alert name, registration date, and last occurrence date. These alerts are only visible to the Operations team and are not shown to end users. * **Actions available**: * [Link/unlink a house](https://docs.clever.gy/helpdesk/portal/my-data/installations/link-installation.md) * Access inverter website * Edit installation data (`plantName`, `address`, `peak power`) from this page or via Connect API. If these values are updated manually through either method, they will not be overwritten by subsequent changes on the inverter website. * Peak power sync rule: inverter data only overwrites the stored peak power value when it is `0` . --- # Link installation You can link an installation to a house so that the client can view their installation information. This allows the homeowner to monitor their solar installation data directly through the mobile app. ## Managing installation links[​](#managing-installation-links "Direct link to Managing installation links") The installation can be linked or unlinked to a house using the action menu (three dots) located in the top right corner of the installation details page. * **Link to house**: connect the installation to a specific house, enabling the house owner to access installation data. * **Unlink from house**: remove the connection between the installation and the house, eliminating access to the installation data. --- # Smart alerts for solar installations Smart alerts complement native inverter alerts by adding additional logic to detect issues that may not trigger a direct inverter error. They are rule-based checks executed daily to analyze installation behavior and detect abnormal situations. ## Difference between inverter alerts and smart alerts[​](#difference-between-inverter-alerts-and-smart-alerts "Direct link to Difference between inverter alerts and smart alerts") 1. **More data sources**
Smart alerts are not limited to inverter status alone. They can combine production data, external data sources (such as weather information), and installation context. They apply across all inverter brands. 2. **Maintenance-oriented logic**
Smart alerts automate key operational checks, allowing energy retailers to quickly identify installations that are not producing as expected and take action at scale. ## Available smart alerts[​](#available-smart-alerts "Direct link to Available smart alerts") ### Inverter power at zero alert[​](#inverter-power-at-zero-alert "Direct link to Inverter power at zero alert") Triggers when a solar installation produces no energy during the day, indicating a potential critical system issue. **Alert logic:** * The system analyzes the total production power recorded during the day. * If the accumulated production is close to zero, the installation is flagged as non-producing. * When this condition is detected, an alert is generated, indicating a possible inverter disconnection, failure, or electrical issue. ### Performance loss alert[​](#performance-loss-alert "Direct link to Performance loss alert") Triggers when a solar installation is performing at less than 70% of its nominal capacity, based on weather forecast data. **Alert logic:** * Weather data is retrieved every 2 hours, considering the postal code of the residence. * Actual energy production is compared with estimated production calculated by the system’s data platform. * If a significant discrepancy is detected, an alert is generated, indicating that the solar panels may be dirty or that shading or obstructions could be affecting performance. --- # Users Users are the main entities in Clevergy. At users section you can manage your users, their data and their related information. ## User Management[​](#user-management "Direct link to User Management") * [Create a new user](https://docs.clever.gy/helpdesk/portal/my-data/users/create-a-user.md) * [Create a contract](https://docs.clever.gy/helpdesk/portal/my-data/users/create-a-contract.md) * [Create a house for a user](https://docs.clever.gy/helpdesk/portal/my-data/users/create-a-house.md) * [User list and filters](https://docs.clever.gy/helpdesk/portal/my-data/users/user-list.md) * [Send individual notifications](https://docs.clever.gy/helpdesk/portal/my-data/users/personalized-push-notifications.md) * [User communications](https://docs.clever.gy/helpdesk/portal/my-data/users/user-communications.md) ## [📄️Create a user](https://docs.clever.gy/helpdesk/portal/my-data/users/create-a-user.md) [You can easily create a user from the portal without external help.](https://docs.clever.gy/helpdesk/portal/my-data/users/create-a-user.md) ## [📄️Create a contract](https://docs.clever.gy/helpdesk/portal/my-data/users/create-a-contract.md) [From a user's page, you can view all the contracts associated with them and add a new one.](https://docs.clever.gy/helpdesk/portal/my-data/users/create-a-contract.md) ## [📄️Create a house](https://docs.clever.gy/helpdesk/portal/my-data/users/create-a-house.md) [A house is an entity from which a user can visualize and manage the energy consumption of a specific location.](https://docs.clever.gy/helpdesk/portal/my-data/users/create-a-house.md) ## [📄️User list](https://docs.clever.gy/helpdesk/portal/my-data/users/user-list.md) [In this section, you can view the complete list of users registered in the system, along with the main indicators and available filters.](https://docs.clever.gy/helpdesk/portal/my-data/users/user-list.md) ## [📄️Personalized push notifications](https://docs.clever.gy/helpdesk/portal/my-data/users/personalized-push-notifications.md) [Send a personalized notification to a user](https://docs.clever.gy/helpdesk/portal/my-data/users/personalized-push-notifications.md) ## [📄️User communications](https://docs.clever.gy/helpdesk/portal/my-data/users/user-communications.md) [The portal supports several automated and manual email communications to keep users informed and engaged. Each type can be enabled independently based on your workspace configuration.](https://docs.clever.gy/helpdesk/portal/my-data/users/user-communications.md) --- # Create a contract From a user's page, you can view all the contracts associated with them and add a new one. ## How to create a contract[​](#how-to-create-a-contract "Direct link to How to create a contract") 1. Go to the user's page. 2. In the **Contracts** section, click **Add contract**. 3. Select the contract type: **Electricity** or **Gas**. 4. Fill in the required fields. note If you set a contract to `ACTIVE` for a CUPS that already has an active contract, the previous one will be automatically deactivated. See **[Contract status](https://docs.clever.gy/developer/how-to-set-up/contracts.md#contract-status)** for details. ### Electricity contract fields[​](#electricity-contract-fields "Direct link to Electricity contract fields") | Field | Type | Required | Description | | ------------------- | ------ | -------- | ------------------------------------------------------------------- | | Contract number | string | No | Retailer's contract number | | CUPS | string | Yes | Supply point identifier | | Address | string | Yes | Address | | Start date | date | Yes | Contract start date | | End date | date | No | Contract end date | | Status | enum | Yes | Contract status: `ACTIVE`, `INACTIVE` | | Postal code | string | Yes | Postal code | | Tariff access | enum | Yes | Access tariff: `2.0TD`, `3.0TD`, `6.1TD` | | Tariff name | string | Yes | Commercial tariff name | | Retailer name | string | No | Retailer's commercial name | | Distributor name | string | Yes | Distributor's name | | Holder name | string | No | Contract holder | | Contracted power | number | No | Contracted power (P1-P6) | | Import tariff type | enum | Yes | Tariff type: `FIXED`, `PVPC`, `INDEXED`, `PERIOD`, `CUSTOM` | | Surplus tariff type | enum | No | Surplus tariff type: `FIXED`, `PVPC`, `INDEXED`, `PERIOD`, `CUSTOM` | | Energy prices | number | No | Energy prices (up to 6 periods) | | Surplus prices | number | No | Surplus prices (up to 6 periods) | | Power prices | number | No | Power prices (P1-P6) | | IBAN | string | No | Bank account | ### Gas contract fields[​](#gas-contract-fields "Direct link to Gas contract fields") | Field | Type | Required | Description | | ---------------- | ------ | -------- | ------------------------------------- | | Contract number | string | No | Retailer's contract number | | Start date | date | Yes | Contract start date | | End date | date | No | Contract end date | | CUPS | string | Yes | Supply point identifier | | Address | string | Yes | Address | | Postal code | string | No | Postal code | | Status | enum | Yes | Contract status: `ACTIVE`, `INACTIVE` | | Tariff access | enum | Yes | Access tariff: `RL01` to `RL11` | | Retailer name | string | No | Retailer's commercial name | | Distributor name | string | Yes | Distributor's name | | Pressure | number | No | Supply point pressure | | Tariff name | string | Yes | Commercial tariff name | | Fixed price | number | No | Fixed price (€/day) | | Energy price | number | No | Energy price (€/kWh) | | Holder name | string | No | Contract holder | | IBAN | string | No | Bank account | For the full technical reference on these fields, see **[Contracts](https://docs.clever.gy/developer/how-to-set-up/contracts.md)**. --- # Create a house A house is an entity from which a user can visualize and manage the energy consumption of a specific location. As the name itself says, this entity is usually a residential dwelling, but it can also be a town hall, a local, etc. It can be linked to different data sources, such as the electricity distributor, a photovoltaic (PV) installation, an energy community or a combination of these. You can easily create a user's house from the portal without external help. ## How to create a user's house from the portal[​](#how-to-create-a-users-house-from-the-portal "Direct link to How to create a user's house from the portal") Before starting with the process of creating a house, it is necessary that the user (holder of the supply point) exists beforehand. If the user does not exist yet and you have doubts about how to create it, take a look at the documentation on **[how to create a user](https://docs.clever.gy/helpdesk/portal/my-data/users/create-a-user.md)**. Once the user is created, this is how you can create a house associated to this user: 1. Go to the **[Users](https://portal.clever.gy/dashboard/$tenant$/users)** section of the portal. 2. **Find the user** you want to create a house for and click on it. 3. Check that the user does not already have the home you want to create associated to their profile. If not, click on the **"Add house"** button. 4. **Fill in the form** with: * Address (required) * Zip/Postal code (required) 5. Click on the **"Add house"** button. ## Further actions[​](#further-actions "Direct link to Further actions") Since your goal may not just be to create a house, but to have them receive consumption data, take a look at the possible cases that apply to this house. ### Add a PV installation[​](#add-a-pv-installation "Direct link to Add a PV installation") If the house you have created has a PV installation, you can add it by following the steps in the tutorial for **[linking an installation](https://docs.clever.gy/helpdesk/portal/my-data/installations/link-installation.md)**. ### Connect the house to Datadis[​](#connect-the-house-to-datadis "Direct link to Connect the house to Datadis") In order for the user to receive consumption data without being your current energy marketer customer, you can encourage them to connect to Datadis so that they can view their consumption data from your application. It is **strictly necessary that the user himself carries out this process from the application**. The user will find a description of the actions to be carried out to connect to Datadis on the "More" screen > "Connections" section > "Meters" module. --- # Create a user You can easily create a user from the portal without external help. ## How to create a user from the portal[​](#how-to-create-a-user-from-the-portal "Direct link to How to create a user from the portal") 1. Go to the **[Users](https://portal.clever.gy/dashboard/$tenant$/users)** section of the portal. 2. Click on the **"New user"** button. 3. Fill in the form with: * Name (required) * Surname * Email (required) * Mobile phone * DNI/NIE/CIF 4. Decide if you want to send him/her a [Welcome email](https://docs.clever.gy/helpdesk/portal/my-data/users/user-communications.md#welcome-email) and check or uncheck the checkbox accordingly. danger Be careful with sending this email, as this action cannot be undone. 5. Click on the **"Add user"** button. ## Further actions[​](#further-actions "Direct link to Further actions") Since your goal may not just be to create a user, but to have them receive consumption data, take a look at the possible cases that apply to your next cases. ### You are a retailer[​](#you-are-a-retailer "Direct link to You are a retailer") If the user you have created must receive data from the distributor via FTP, first **[create an active electricity contract](https://docs.clever.gy/helpdesk/portal/my-data/users/create-a-contract.md)** for the user with their CUPS. Only once that contract is active will the FTP synchronization pick up their data. Once the contract is in place, you can check that the FTPs of the distributor are synchronized in My integrations -> Distributors. If the FTPs are loaded, congrats! You have finished the process. ### You are a solar panel installer[​](#you-are-a-solar-panel-installer "Direct link to You are a solar panel installer") If you have just created a user, it is possible that your goal is to **make it possible for this user to view your PV installation from the application**. In this case, you can proceed to the next two steps: 1. [Create a user's home from the portal](https://docs.clever.gy/helpdesk/portal/my-data/users/create-a-house.md) 2. [Associate a PV system to the user's home from the portal](https://docs.clever.gy/helpdesk/portal/my-data/installations/link-installation.md) --- # Personalized push notifications ## Send a personalized notification to a user[​](#send-a-personalized-notification-to-a-user "Direct link to Send a personalized notification to a user") If you want to address a specific user and send them an individual notification, follow these steps: 1. Go to the **[Users](https://portal.clever.gy/dashboard/$tenant$/users)** section of the portal and select the user. 2. At the top, you will find the **Send notification** button. 3. Write your message. If you want to generate the content with AI, click on the **Generate with AI** button. Learn more about [AI generated notifications](https://docs.clever.gy/helpdesk/portal/workspaces/communications/.md#generate-the-content-with-ai). 4. Once it's ready, click **Send notification** and confirm. You can also send an individual notification from the **[Communications](https://docs.clever.gy/helpdesk/portal/workspaces/communications/.md#send-an-individual-notification)** workspace, searching for the user there. warning Be careful with the content of the notification, as it will be sent to the user you have selected. ## Send a notification to many users[​](#send-a-notification-to-many-users "Direct link to Send a notification to many users") Notifications to many users at once are sent as campaigns from the **[Communications](https://docs.clever.gy/helpdesk/portal/workspaces/communications/.md#send-a-notification-as-a-campaign)** workspace, choosing the users by their segmentations. --- # User communications The portal supports several automated and manual email communications to keep users informed and engaged. Each type can be enabled independently based on your workspace configuration. ## Welcome email[​](#welcome-email "Direct link to Welcome email") A welcome email encourages new users to explore the app, download it, and start accessing their home energy data. ### What it includes[​](#what-it-includes "Direct link to What it includes") * A personalized welcome message. * A direct link to download the app. * Step-by-step instructions to log in using the registered email. ### When it is sent[​](#when-it-is-sent "Direct link to When it is sent") The welcome email is sent in two scenarios: * **Manually**: from the user's screen in the portal (see below). * **Automatically**: when an existing user authorizes access to another user who does not yet have an account. In this case, the new user receives the welcome email automatically upon being registered. ### How to manually send a welcome email[​](#how-to-manually-send-a-welcome-email "Direct link to How to manually send a welcome email") 1. Go to the user's screen in the portal. 2. Click the **Welcome email** button, located within the actions section to the right of the user's full name (top-right corner). 3. The user will receive the email. If they don't receive it, ask them to check their spam folder. ### Requirements[​](#requirements "Direct link to Requirements") * A verified and configured email address with our email provider. * The **magic link login** option must be enabled. ## Monthly report email[​](#monthly-report-email "Direct link to Monthly report email") Automated monthly consumption reports are sent to users on the 5th of each month, including personalized insights and smart call-to-actions based on the user's installation type. **Standard email**: monthly consumption evolution vs. the previous month, annual comparison (if available), and an "Available in the app" CTA. **Solar email**: all standard content plus a "View my installation in real time" CTA for real-time installation monitoring. ### Requirements[​](#requirements-1 "Direct link to Requirements") * Minimum 20 days of consumption data from the previous month. * Active user with valid email and house data. * Verified email configuration in the portal. * Annual comparison only displays if previous year data exists. ### Use cases with examples[​](#use-cases-with-examples "Direct link to Use cases with examples") **Standard user engagement** * User receives monthly report showing 15% consumption increase vs May. * Annual comparison shows 8% decrease vs June 2023. * CTA encourages app download: "Available in the app". info To activate this feature, contact us and we will enable it for your workspace. ## Invoice notification[​](#invoice-notification "Direct link to Invoice notification") An automated email is sent to the client when a new invoice is available in the app. The message includes a button to open the app and view the invoice for the corresponding billing period. ### Requirements[​](#requirements-2 "Direct link to Requirements") 1. Feature enabled for your workspace. 2. The client receives a new invoice linked to their contract. Invoices can be generated automatically via integrations such as Audinfor, Enexpa, or the Connect API, or uploaded manually from the portal. info To activate this feature, contact us and we will enable it for your workspace. --- # User list In this section, you can view the complete list of users registered in the system, along with the main indicators and available filters. ## Visible KPIs[​](#visible-kpis "Direct link to Visible KPIs") * **Total users** * **Completed registrations** * **Users who have used the app** * **Active users (last 30 days)** These KPIs are displayed at the top of the screen and provide a quick overview of the user base status. ## Available filters[​](#available-filters "Direct link to Available filters") * **Search by email, DNI/NIE/CIF, or CUPS...**: Search field to locate specific users. * **Status**: dropdown filter to segment users by their registration status. * **Has used the app**: dropdown filter to show only users who have logged in from the app at any time. * **Activity (active)**: dropdown filter to segment by user activity. A user is considered "Active" if they have logged in from the app or from the Connect API (for example, for microfrontend validation or any other use) during the selected time period. ## Available actions[​](#available-actions "Direct link to Available actions") * **Add user**: button to create a new user. ## User table[​](#user-table "Direct link to User table") The table displays the following information for each user: * **Date** * **First name** * **Last name** * **Email** * **Identification document** * **Status** At the top right of the table, the total number of results is shown based on the filters. --- # Settings At settings section you can manage your account, integrations, and promotional campaigns. ## [📄️My tariffs](https://docs.clever.gy/helpdesk/portal/settings/tariffs/.md) [The tariffs section provides an interface to create and manage custom electricity tariffs and assign them to clients.](https://docs.clever.gy/helpdesk/portal/settings/tariffs/.md) ## [📄️Banners](https://docs.clever.gy/helpdesk/portal/settings/banners/.md) [Banners are configurable elements that are displayed on the home screen of the App. This functionality allows you to create promotional campaigns and generate sales opportunities in a targeted way to your users.](https://docs.clever.gy/helpdesk/portal/settings/banners/.md) ## [📄️Communication sending rules](https://docs.clever.gy/helpdesk/portal/settings/communications/.md) [Description](https://docs.clever.gy/helpdesk/portal/settings/communications/.md) ## [🗃Access control](https://docs.clever.gy/helpdesk/portal/settings/access-control/.md) [1 item](https://docs.clever.gy/helpdesk/portal/settings/access-control/.md) ## [📄️API key management](https://docs.clever.gy/helpdesk/portal/settings/api-key-management/.md) [The Connect API section provides access to your personal API Key, which is used to create integrations with the Clevergy platform.](https://docs.clever.gy/helpdesk/portal/settings/api-key-management/.md) --- # Access control The Access Control section lists every user with access to the Clevergy Portal and lets Admins manage them. To add a new user, click the **Add user** button, fill in their name, surname and email, and choose the **role** that matches what they need to do in the portal. Once created, the user appears in the list and can log in with that email address. The interface displays a list of all registered users, showing: * **Registration date**: when the user was added to the portal. * **Name and surname**: basic identification information. * **Email**: the address used for login. * **Role**: the access level granted to the user. See [Roles and permissions](https://docs.clever.gy/helpdesk/portal/settings/access-control/roles-and-permissions.md). * **Actions**: options to edit the user, including their role, or remove their access. ## Who can manage access[​](#who-can-manage-access "Direct link to Who can manage access") Only users with the **Admin** role can add users, change their role or remove their access. Managers and Users can open this section and see the list, but not modify it. note You can’t change your own role or delete your own account. Another Admin has to do it for you. ## [📄️Roles and permissions](https://docs.clever.gy/helpdesk/portal/settings/access-control/roles-and-permissions.md) [Every user with access to the Clevergy Portal has a role, which decides what they can do once they log in. There are three preset access levels, designed to fit the way most teams are organized, so you can decide who can do what.](https://docs.clever.gy/helpdesk/portal/settings/access-control/roles-and-permissions.md) --- # Roles and permissions Every user with access to the Clevergy Portal has a **role**, which decides what they can do once they log in. There are three preset access levels, designed to fit the way most teams are organized, so you can decide who can do what. All three roles can browse the same workspaces and see the same information about your users, installations and contracts. The difference is what each one is allowed to **change**. The only section that is not visible to everyone is the API key, reserved for Admins. ## User[​](#user "Direct link to User") Limited access, designed for the day-to-day work of support and customer teams. * Manage support tickets, sales opportunities and communications. * Review and resolve maintenance alerts. * See all the information about users, houses, contracts and installations, without being able to modify it. ## Manager[​](#manager "Direct link to Manager") A higher level of access, intended for the configuration and management work of an operations team. * Everything a User can do. * Create, edit and delete users, houses, contracts, invoices and installations. * Configure integrations, tariffs and energy communities. ## Admin[​](#admin "Direct link to Admin") Full access to every workspace, all data and all settings. Intended for whoever owns the project inside your organization. * Everything a Manager can do. * Manage who has access to the portal: add users, change their role and remove their access. * Reveal and regenerate the [API key](https://docs.clever.gy/helpdesk/portal/settings/api-key-management/.md). ## Permissions summary[​](#permissions-summary "Direct link to Permissions summary") **Manage** means being able to create, edit and delete. **View** means read-only access. | Area | User | Manager | Admin | | ---------------------- | ------ | ------- | ------ | | Support tickets | Manage | Manage | Manage | | Sales opportunities | Manage | Manage | Manage | | Alerts | Manage | Manage | Manage | | Communications | Manage | Manage | Manage | | Users and houses | View | Manage | Manage | | Contracts and invoices | View | Manage | Manage | | Installations | View | Manage | Manage | | Energy communities | View | Manage | Manage | | Tariffs | View | Manage | Manage | | Integrations | View | Manage | Manage | | Portal access | View | View | Manage | | API key | ➖ | ➖ | Manage | ## Assigning a role[​](#assigning-a-role "Direct link to Assigning a role") Roles are assigned when a user is added to the portal, and can be changed at any time afterwards from [Access control](https://docs.clever.gy/helpdesk/portal/settings/access-control/.md). If a user tries to open a page or use an action their role does not allow, the portal simply does not offer it: the affected buttons and sections are not displayed. note Nobody can change their own role or delete their own account, whatever their role is. Another Admin has to do it for them. Keep at least one Admin Only Admins can manage portal access. If no one in your organization holds the Admin role, roles can no longer be changed from the portal and you will need to contact Clevergy to restore access. --- # API key management The Connect API section provides access to your personal API Key, which is used to create integrations with the Clevergy platform. To reveal, copy, or regenerate your API Key, use the controls displayed in the interface. Regenerating the key will immediately invalidate the previous one, so make sure to update it in any existing integrations. The interface displays: * **API Key**: your unique authentication token for accessing the Cleverg y API. * **Visibility and copy controls**: options to show/hide the key and copy it to the clipboard. * **Regenerate button**: creates a new API Key and revokes the old one. --- # Banners Banners are configurable elements that are displayed on the home screen of the App. This functionality allows you to create promotional campaigns and generate sales opportunities in a targeted way to your users. ## Banner configuration[​](#banner-configuration "Direct link to Banner configuration") To create a banner, go to [App settings](https://portal.clever.gy/dashboard/$tenant$/app-settings) in the portal and configure the elements listed below. Note that the banners configured here always take priority over other in-app banners. ### User segmentation[​](#user-segmentation "Direct link to User segmentation") Choose who will see the banner: * **All users**: The banner is shown to all app users * **Battery candidates**: Only users who have more than 20% energy surplus and are potential candidates for installing a battery * **Aerothermal candidates**: Only users who are potential candidates for installing an aerothermal system ### Banner content[​](#banner-content "Direct link to Banner content") * **Icon**: Select a representative icon for your message (battery, aerothermal, etc.) * **Title**: Write an attractive and clear title * **Description**: Add descriptive text (maximum 148 characters). Markdown supported (e.g., bold, links). * **Button**: Including a call-to-action button is optional. If you choose to add it, you can configure the type of sales opportunity created when a user clicks it. Available only when the button is enabled. * **Type of sales opportunity**: Select the related product type: * Aerothermal * Battery * Electricity * Appliances * Other * PV (Photovoltaic) * Electric vehicle * **Button URL**: Optional link to a web page with more information When a user clicks on the banner button: 1. **A sales opportunity is automatically generated** in the portal with the selected type 2. **The user is marked as "Interested"** in the system 3. **You can track the opportunity** from the [Sales Opportunities](https://portal.clever.gy/dashboard/$tenant$/sales-opportunities) section, where you can manage the complete sales process (update its status, add notes and follow-up) 4. **If you have configured a URL**, the user will also be directed to the specified web page ## Best practices[​](#best-practices "Direct link to Best practices") ### For effective titles[​](#for-effective-titles "Direct link to For effective titles") * Use clear and direct titles * Include keywords like "Offer", "Discount", "Promotion" * Keep the title concise but attractive ### For descriptions[​](#for-descriptions "Direct link to For descriptions") * Clearly explain the offer or promotion * Include information about discounts or benefits * Use a tone that motivates action * Make efficient use of the 148 character limit ### For segmentation[​](#for-segmentation "Direct link to For segmentation") * Use segmentation to show relevant messages * Battery candidates respond better to energy storage offers * Aerothermal candidates are ideal for heating/cooling promotions --- # Communication sending rules ## Description[​](#description "Direct link to Description") Clevergy coordinates emails and notifications so users are informed without being overloaded. Our delivery engine spaces messages, merges events when possible, and respects per-channel limits. These rules apply by default. Contact us if you need adjustments for your workspace. ## Current limits[​](#current-limits "Direct link to Current limits") * Monthly report: max 1 per month * New invoice: max 1 every 10 days * Surplus generation notification: max 1 per week ## How it works[​](#how-it-works "Direct link to How it works") * Priority and spacing: when multiple events occur close together, messages are queued and spaced to avoid bursts. * Per-user deduplication: if a user already received a similar message recently, the system skips duplicates. * Channel awareness: we balance email and in-app notifications to keep total contact frequency within limits. * Safe retries: temporary failures are retried with backoff without exceeding user frequency caps. info Need different limits? Reach out and we can configure workspace-specific rules. --- # My tariffs The tariffs section provides an interface to create and manage custom electricity tariffs and assign them to clients. To add a new tariff, click the Add Tariff button and follow the configuration steps based on the selected tariff type. This tariff type defines the structure of the tariff (including time periods, pricing rules, and fixed charges), and determines which configuration fields are shown during setup. The interface displays a list of all defined tariffs, showing: * **Internal name**: for internal organization and versioning. * **Commercial name**: the name users will see in the app. * **Tariff type**: defines how the tariff behaves based on market models. --- # Workspaces Workspaces are specialized sections within the portal designed to help you efficiently manage your commercial and operational activities. Each workspace centralizes a specific type of workflow, providing dedicated tools and visibility to streamline daily operations. ## Available workspaces[​](#available-workspaces "Direct link to Available workspaces") ### Sales opportunities[​](#sales-opportunities "Direct link to Sales opportunities") Designed for **sales teams**, the sales opportunities workspace helps you track and manage potential sales leads (e.g. from app recommenders, banners, or Clevergy-detected opportunities). Through this workspace, you can: * View all sales **opportunities** in one place * Track the **status** of each lead * Access customer **information** * Monitor **conversion** rates * Manage **follow-ups** [Learn more about Sales Opportunities](https://docs.clever.gy/helpdesk/portal/workspaces/sales-opportunities/.md) ### Support tickets[​](#support-tickets "Direct link to Support tickets") Built for **support agents**, the support tickets workspace centralizes all customer inquiries and issues. From here you can: * View all support **tickets** * Track ticket **status** (New, In Progress, Pending Response, Resolved) * Access relevant customer **information** * Respond to customer **inquiries** * Monitor resolution **times** * Review support **history** [Learn more about Support Tickets](https://docs.clever.gy/helpdesk/portal/workspaces/support-tickets/.md) ### Energy communities[​](#energy-communities "Direct link to Energy communities") Intended for **community managers and energy operations teams**, the Energy communities workspace allows you to manage and monitor energy communities and their associated members. Key capabilities include: * View all energy **communities** * Access community **details** and configuration * Monitor member **participation** * Review energy **distribution** and related information * Track the operational **status** of each community [Learn more about Energy Communities](https://docs.clever.gy/helpdesk/portal/workspaces/energy-communities/.md) ### Maintenance[​](#maintenance "Direct link to Maintenance") Used by **operations teams**, the Maintenance workspace centralizes operational management tasks related to installations. From here, you can: * Monitor active **alerts** * Review installation-level **issues** * Access relevant technical **information** * Take operational **action** when needed [Learn more about Maintenance](https://docs.clever.gy/helpdesk/portal/workspaces/maintenance/.md) ### Communications[​](#communications "Direct link to Communications") For **marketing and customer teams**, the Communications workspace brings together every push notification and email your users receive. From here you can: * Send push notifications to one **user** or as a **campaign** to the users of one or more segmentations * Review each **campaign** and its open, click and failure rates * Browse the **history** of every communication sent * See the **detail** and a preview of each communication [Learn more about Communications](https://docs.clever.gy/helpdesk/portal/workspaces/communications/.md) --- # Communications The Communications workspace brings together everything your users receive from you, push notifications and emails, and lets you send push notifications from one place: to a single user or as a campaign. Open it from the **[Communications](https://portal.clever.gy/dashboard/$tenant$/communications)** workspace in the left menu. At the top you will find two buttons, **Send individual notification** and **Send notification as a campaign**, and two tabs: * **Communication campaigns**: the notifications sent to many users at once. * **Communications history**: every communication sent to your users, one by one. ## Communication campaigns[​](#communication-campaigns "Direct link to Communication campaigns") A campaign is a notification sent to a group of users at once. The list shows the most recent campaigns first, with: * **Subject** * **Channel** * **Language**: the language the campaign was written in. Campaigns sent to all languages show **—**. * **Sent by**: the portal user who sent it. * **Sent**: how many communications it sent. * **Open rate**, **click rate** and **failure rate** * **Sent date** Click a campaign to open its detail, with: * **Information**: subject, channel, **language** (or **All languages**), sent date, who sent it and the **segmentations** it was sent to. With more than one segmentation, it also shows whether users had to be in any or in all of them. Campaigns sent before segmentations existed show the segmentations as **Unknown**. * **Summary**: communications sent, open rate, click rate and failure rate. * **Communications**: every communication of the campaign, with its recipient and status. Click one to see its [detail](#communication-detail). ### How to read the rates[​](#how-to-read-the-rates "Direct link to How to read the rates") Rates are percentages of the communications the campaign sent. * **Open rate**: for push notifications, the user tapped the notification or received it with the app open. A communication that was clicked also counts as opened. * **Click rate**: only applies to emails. Push notifications show **N/A**. * **Failure rate**: the communication could not be delivered. For push notifications, it only counts as failed when it failed on every device of the user. ## Communications history[​](#communications-history "Direct link to Communications history") This tab lists every communication sent to your users, push notifications and emails, the most recent first. For each one you can see: * **Status** * **Recipient** * **Subject** * **Channel**: push notification or email. * **Language**: the language it was sent in. Communications sent before the language was recorded show **—**. * **Send method**: how it was sent. * **Manual campaign send**: sent from the portal as a campaign. * **Manual direct send**: sent from the portal to one user. * **Transactional**: triggered by something the user or your team did, such as a new invoice or a support ticket update. * **Automatic rule**: sent by Clevergy's rules, such as consumption alerts or the monthly report. * **Type**: what it was about. * **Sent date** and **last updated**: you can sort the list by either of them. ### Communication detail[​](#communication-detail "Direct link to Communication detail") Click a communication to see its information (status, channel, language, send method, type, recipient, dates and, for push notifications, the screen of the app it opens) and a preview of what the user received. If it belongs to a campaign, **View campaign** takes you to it. note A notification you have just sent may take a few seconds to appear in the history. ## Send an individual notification[​](#send-an-individual-notification "Direct link to Send an individual notification") To send a push notification to one specific user: 1. Click **Send individual notification**. 2. Write the **title** and the **description**. If you want help with the content, click **Generate with AI**. Learn more about [AI generated notifications](#generate-the-content-with-ai). 3. Check the **preview** and, if you want, choose the **target path in the app**: the screen the user lands on when they tap the notification. By default it is the home screen. 4. In **Recipient**, search for the user by name, surname, email or identity document. Only users with a device registered for notifications are listed. Once you pick one, the portal tells you the language they prefer to receive communications in, so you can write in it. 5. Click **Send notification** and confirm. You can also send an individual notification from the user's page, in the **[Users](https://portal.clever.gy/dashboard/$tenant$/users)** section. Learn more about [personalized push notifications](https://docs.clever.gy/helpdesk/portal/my-data/users/personalized-push-notifications.md). ## Send a notification as a campaign[​](#send-a-notification-as-a-campaign "Direct link to Send a notification as a campaign") To send the same push notification to a group of users: 1. Click **Send notification as a campaign**. 2. Write the **title** and the **description**, or click **Generate with AI**. 3. Check the **preview** and, if you want, choose the **target path in the app**. 4. In **Recipients**, choose the **language** the campaign is written in. By default it is **All**, which sends it to every user regardless of their language. If you choose one, it goes to the users who prefer that language and to those who haven't chosen any. 5. Choose the **segmentations** the campaign goes to. With more than one, choose whether to send it to the users who match **Any** of them or **All** of them. If you don't choose any segmentation, it goes to all your users. 6. The send button shows how many users will receive it: **Send notification to X users**. Click it and confirm. Only users with a device registered for notifications receive the campaign, so the number of recipients may be lower than the number of users in the segmentations. danger Check the content, the language and the segmentations carefully before sending: the notification reaches every recipient at once and the send cannot be undone. ## Generate the content with AI[​](#generate-the-content-with-ai "Direct link to Generate the content with AI") When writing a notification, click **Generate with AI** and choose: * The **category**: Self-consumption, Energy saving, Cross-sale, Tariff change or Energy community. * The **type**: Activation, Recurrence, Cross-sale, Warning or Fun fact. * **Additional instructions**, if you want to guide the result. Click **Generate with AI** and the title and the description will appear in the form in a few seconds. You can edit them before sending. ## Closing without sending[​](#closing-without-sending "Direct link to Closing without sending") If you close the send window after writing something or choosing recipients, the portal asks you to confirm before discarding your changes. ## Permissions[​](#permissions "Direct link to Permissions") Viewing and sending communications depends on the **Communications** permission of your role. Searching for the recipient of an individual notification also requires viewing users. Learn more about [roles and permissions](https://docs.clever.gy/helpdesk/portal/settings/access-control/roles-and-permissions.md). --- # Energy Communities In the Energy Communities section, you will have access to an overview of all your energy communities presented in a clear and organized manner. Upon entering, the first thing you will see is a summary of the most relevant data: the total power currently being generated by all your communities, the total number of energy communities you have created, and the total number of participating members. Additionally, in the main dashboard, you will find a button to add a [new energy community](https://portal.clever.gy/dashboard/$tenant$/energy-communities). Below this overview, you will find a list of all your energy communities (ECs). Each entry in this list will display the community's name, address, number of members, power being generated, and its current status. By clicking on a specific community within the dropdown menu, you can access more detailed information about it. Initially, you will see the percentage this community represents relative to the total of your communities, offering a clear perspective of its relevance and size within the group. Within the selected community, the total number of associated households is displayed. Additionally, a detailed list of these households is provided, including their address, postal code, and distribution coefficient in relation to the community. From this view, you can also link a new household to the energy community. When linking, you can choose to apply the same distribution coefficient to all installations (this is the default option), or assign a custom coefficient to each installation individually. These coefficients determine how the energy produced by the community is distributed among the connected homes. The interface also displays real-time power generation from the community and the average energy consumption of each household over the last 30 days, allowing users to compare current generation with recent consumption patterns to better understand how much of their energy needs are being covered by the community’s production. --- # Maintenance The Maintenance workspace centralizes operational management tasks related to all installations. It provides a structured environment to monitor issues, review relevant information, and take action when needed. This workspace is designed to help operations teams stay organized and maintain visibility across their portfolio. Availability Feature availability may vary depending on the contracted plan. ## [📄️Alerts](https://docs.clever.gy/helpdesk/portal/workspaces/maintenance/alerts.md) [The Alerts tab allows the review and management of active operational alerts from a single centralized view.](https://docs.clever.gy/helpdesk/portal/workspaces/maintenance/alerts.md) ## [📄️Prevention](https://docs.clever.gy/helpdesk/portal/workspaces/maintenance/prevention.md) [The Prevention tab provides a performance overview of all installations, helping operations teams detect underperformance before it becomes a critical issue.](https://docs.clever.gy/helpdesk/portal/workspaces/maintenance/prevention.md) --- # Alerts The Alerts tab allows the review and management of active operational alerts from a single centralized view. It helps to: * Identify **alerts** that require attention. * Understand their relative **importance** through a unified priority system. * Access detailed **information** for each alert. * Mark alerts as **resolved**. ## How alerts are generated[​](#how-alerts-are-generated "Direct link to How alerts are generated") Alerts originate from monitored installations and are processed through Clevergy’s unified alert model. They are normalized under a unified severity model to ensure consistent prioritization. Alerts can come from: * **Manufacturer alerts**: Raw alerts sent directly by inverter manufacturers. * **Clevergy smart alerts**: Alerts generated based on internal rules and anomaly detection logic. Learn more about smart alerts [here](https://docs.clever.gy/helpdesk/portal/my-data/installations/smart-alerts.md) ## Priority levels[​](#priority-levels "Direct link to Priority levels") Each alert is assigned a priority level to help quickly understand its operational relevance. This allows the distinction between noise, signals, and real operational problems. * **High**: Critical or persistent issue * **Medium**: Signal or recurring issue * **Low**: Informational or short-lived event * **Null**: Resolved alert Note that only **High** and **Medium** alerts appear in the Alerts tab. Low and Null priority alerts remain available in the installation-level alert history. ## Alert validity[​](#alert-validity "Direct link to Alert validity") Each alert remains valid for 7 days from its last occurrence. * If the alert reoccurs within 7 days, it is considered the same one. * If it reoccurs after more than 7 days: * The previous alert remains closed (priority Null if it was resolved). * A new alert is created. This logic ensures that recurring issues are tracked properly without generating duplicate alerts. ## How to use the alerts tab[​](#how-to-use-the-alerts-tab "Direct link to How to use the alerts tab") * Review the list regularly. * Start with **High** priority alerts. * Open an alert to view detailed **information**, including severity, dates, and the full description. * From the alert detail page, access the related **installation** to review its alert history or additional installation details. * Mark the alert as **resolved** when appropriate. --- # Prevention The Prevention tab provides a performance overview of all installations, helping operations teams detect underperformance before it becomes a critical issue. It helps to: * Identify installations with **low performance** that may require attention. * Compare **estimated** vs. **actual production** over a rolling 30-day window. * Track **performance trends** through variation indicators. ## How performance is calculated[​](#how-performance-is-calculated "Direct link to How performance is calculated") Performance shows how much energy an installation is producing compared with how much it should be producing. It is calculated over a rolling 30-day period: > **Performance (%) = Actual production / Estimated production x 100** * **Actual production** is the energy the installation has really produced, as reported by the inverter. * **Estimated production** is the energy the installation is expected to produce on a normal day, given its size and its location. ### How the estimated production is obtained[​](#how-the-estimated-production-is-obtained "Direct link to How the estimated production is obtained") The estimate is based on PVGIS, the European Commission's solar tool, which uses several years of historical weather data. For each installation, Clevergy uses: * The **installed capacity** (kWp). * The **location** of the installation. * The **tilt**, **orientation** and **system losses**. Unless configured otherwise, standard values are used: 30 degrees tilt, facing south and 14% losses. With this, Clevergy obtains the average production expected for every day of the year. This value is calculated once and updated only if the installation data changes (for example, its capacity or its address). ## How to use the prevention tab[​](#how-to-use-the-prevention-tab "Direct link to How to use the prevention tab") * Review the list **regularly**, ideally on a weekly basis. * Start with installations in the **less than 70%** category, as they are the most likely to have an actionable issue. * Compare **estimated vs. actual production** to understand the magnitude of the underperformance. * Check the **variation** column to identify whether performance is declining, stable, or recovering. * Use the **plant code** to cross-reference the installation in the manufacturer's monitoring platform for further diagnostics. * For newly installed systems, consider that a short production history may result in less reliable performance values. --- # Sales opportunities In the sales opportunities section, you can manage and convert sales leads, as it centralizes information to help qualify, follow up, and move each potential lead toward conversion. ## How sales opportunities are generated[​](#how-sales-opportunities-are-generated "Direct link to How sales opportunities are generated") Sales opportunities can come from two main sources: * **User initiated opportunities** are created when users interact with product recommenders in the app, such as solar PV, batteries, aerothermal, or tariff switch, and show interest. They may also originate from **[configurable banners](https://docs.clever.gy/helpdesk/portal/settings/banners/.md)** or special campaigns shown in the app. These opportunities are automatically classified as **Interested** in the portal. Information about the available recommenders can be found **[here](https://docs.clever.gy/helpdesk/app/optimize/.md)**. ### Banners as opportunity generators[​](#banners-as-opportunity-generators "Direct link to Banners as opportunity generators") **[Configurable banners](https://docs.clever.gy/helpdesk/portal/settings/banners/.md)** are a powerful tool for generating sales opportunities. When you create a banner in the portal settings, you can: * **Target specific user segments**: Show banners to all users, battery candidates (with >20% energy surplus), or aerothermal candidates * **Configure opportunity types**: Link banners to specific product types (battery, aerothermal, PV, etc.) * **Include call-to-action buttons**: When users click the button, an opportunity is automatically created * **Add external links**: Direct users to promotional pages with more information Banner-generated opportunities are automatically classified as **Interested** and include the specific product type you configured. * **Opportunities proposed by Clevergy** are automatically detected based on energy consumption data and user behavior, allowing you to proactively reach out to potential customers. These are identified as **Potential** opportunities. note Currently, potential opportunities apply only to battery opportunities, which are generated when the user does not yet have a battery, has a solar PV system, and shows some level of energy export. ### Product types[​](#product-types "Direct link to Product types") Sales opportunities can belong to different categories based on the type of product the user is interested in: * **Aerothermal**: installing an aerothermal system. * **Battery**: installing an energy storage battery. * **Solar PV**: installing photovoltaic solar panels. * **[Electricity contract](https://docs.clever.gy/helpdesk/microfrontends-catalog/account-setup-integrations/create-contract-opportunity.md)**: signing a new electricity contract. ## How to update the status of a sales opportunity[​](#how-to-update-the-status-of-a-sales-opportunity "Direct link to How to update the status of a sales opportunity") Effectively managing sales opportunities requires keeping their statuses updated. This centralizes lead tracking and helps you identify the next best action for each case. You can update the status from within the opportunity details by clicking on the current status and selecting the appropriate option from the dropdown menu. The available statuses are: * **Potential**: opportunity automatically suggested by Clevergy based on energy data and user behaviour analysis. These are proactive leads you can reach out to. * **Interested**: opportunity initiated by the user after expressing interest in a specific product. * **Formalized**: the user has accepted a contract or proposal. * **Converted**: the payment has been received, and the product or service is being delivered. * **Rejected**: the opportunity was lost, either because the user declined or stopped responding. Most status updates are done manually. However, in certain cases, statuses may update automatically. For example, when a user completes a new electricity contract through the app, the opportunity will automatically move to Formalized. To help you efficiently prioritize leads, the default view sorts opportunities by their creation date, showing the most recently created ones first. ## How to make the most of all the information in a sales opportunity[​](#how-to-make-the-most-of-all-the-information-in-a-sales-opportunity "Direct link to How to make the most of all the information in a sales opportunity") To make informed decisions and manage each lead effectively, click on an opportunity to access detailed information, including: * **Lead's personal and supply data**: access essential information to identify the opportunity. * **Interaction history and notes**: keep track of all communications and interactions by adding notes, for example, "Call unanswered" or "Proposal sent." This ensures you stay organized and can follow up effectively. * **Relevant energy data and usage patterns based on the product type**: this will help you understand their needs and tailor your proposals accordingly. For example: * **For solar PV installations**: view the annual consumption and the PVGIS production estimates to assess the potential solar energy generation, providing a realistic outlook for the lead. * **For batteries**: analyze consumption and production patterns to suggest the best solutions for maximizing energy efficiency. Keeping this information updated allows you to track progress, personalize your follow-ups, and increase conversion rates. --- # Support tickets At the support section you will find a list of support tickets. At a glance, you can see how many tickets are still pending resolution. These are grouped into one of the following five categories: * **New**: all newly received tickets. * **In progress**: the support team has replied to the client. * **Pending response**: the client has replied to the ticket thread and it needs to be reviewed by the support team. * **Resolved**: the ticket has been resolved by the support team. * **Closed**: after resolution, the issue has been confirmed as solved by the user, and no further action is required. ## Ticket reference[​](#ticket-reference "Direct link to Ticket reference") Each ticket has a unique **reference** that identifies it. It is the same reference the client sees in the ticket detail of the **[Help](https://docs.clever.gy/helpdesk/app/help/.md)** module in the app, so you can use it to locate a ticket when a client contacts you about it. The reference is visible in the tickets list and in the ticket detail. To find a ticket, type its reference in the search box of the support tickets list. ## Attachments and notes[​](#attachments-and-notes "Direct link to Attachments and notes") Tickets may include file attachments, allowing both users and operators to share additional context such as screenshots or supporting documents. You can also use the interaction history and notes to keep track of all communications and actions related to a ticket. Add notes such as *Issue escalated to the distributor. Reference: INC-20483.* or *Invoice copy sent* to stay organized and ensure effective follow-up. note If you are interested in sending an automatic message to users when a support ticket is opened, please contact our support team. --- # WhatsApp We have developed a new feature that allows users to access all their energy provider and account data directly through **WhatsApp**. Whatever users can view in the mobile app can now be consulted conversationally via chat. The only prerequisite is that the **user's phone number is correctly associated with their account**. Key Requirement To query data via WhatsApp, the user's phone number must be associated with their account in the client's ERP or CRM, which is synchronized into **Clevergy**. *** ## How it works[​](#how-it-works "Direct link to How it works") Clevergy is already integrated with the client's ERP/CRM, keeping all customer contracts, phone numbers, and energy data continuously synchronized in **Clevergy**. 1. **Phone Number Matching:** When a user sends a query on WhatsApp, the service identifies the user by matching their phone number. 2. **Data Query:** Data (consumption, invoices, supply points, tickets) is fetched directly from Clevergy. 3. **Instant Answer:** The requested information is formatted and delivered back to the user via WhatsApp. ### Workflow[​](#workflow "Direct link to Workflow") *** ## What you can do via WhatsApp[​](#what-you-can-do-via-whatsapp "Direct link to What you can do via WhatsApp") Through WhatsApp, users can: * **Check energy consumption:** Retrieve consumption data and get explanations on how it evolved over a specific period. * **View home information:** Access details about registered properties, such as address or CUPS (supply point ID). * **Understand invoices:** View invoice amounts, dates, and detailed cost breakdowns. * **Open and check support tickets:** Create new support tickets or track the status of existing ones. * **Analyze electricity or gas bills:** Send a photo or PDF bill to automatically extract key details explained simply. *** ## What is not available via WhatsApp[​](#what-is-not-available-via-whatsapp "Direct link to What is not available via WhatsApp") Currently, WhatsApp **does not allow**: * **Analyzing non-bill documents:** Processing documents other than electricity or gas bills. * **Performing account management:** Modifying personal data, changing contracts, managing service activations/cancellations, or processing payments. * **Financial or legal advice:** Offering financial or legal consultations. * **Device control:** Controlling smart devices or making physical changes to electrical installations. * **Unrelated queries:** Answering questions outside energy, properties, invoices, or support. *** ## Mobile App Redirection[​](#mobile-app-redirection "Direct link to Mobile App Redirection") When a user requests a action that is **not available on WhatsApp** but is supported in the mobile app (such as modifying personal details or making payments), WhatsApp automatically provides download links to the client's mobile application. App Links The links below are default examples (Ecogrid). In each client implementation, they are configured with the client's own branded app download links: * **iOS (App Store):** * **Android (Google Play):** ---