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.
There are two types of contracts supported:
- Electricity contracts
- Gas contracts
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.
Costs calculation (€) is only available for tariff access 2.0TD.
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
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
The information displayed in the app comes directly from the contract endpoint.
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.
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.