Installation Profile Management

Migration of profile endpoints to tariff-definition & budget-definition endpoints

The POST /profile endpoint was used to set both tariff and budget values. This endpoint is deprecated and should no longer be used. The POST /billing/tariff-definition and POST /billing/budget-definitionshould be used instead for setting tariff values and budget values respectively.

The GET /profile endpoint was used to retrieve both tariff and budget values. This endpoint is deprecated and should no longer be used. The GET /billing/tariff-definition and GET /billing/budget-definitionshould be used instead for retrieving tariff values and budget values respectively.

Migration of POST /profile endpoint to POST /billing/tariff-definition endpoint for setting tariff values

In the following table you can find the association between the parameters in POST /profile endpoint and the parameters in POST /billing/tariff-definition endpoint:

Migration of POST /profile endpoint to POST /billing/budget-definition endpoint for setting budget values

In the following table you can find the association between the parameters in POST /profile endpoint and the parameters in POST /billing/budget-definition endpoint:

The following parameters have been deprecated and no longer provided for the budget calculation:

The following parameters should be provided for the budget calculation instead:

Deprecated Calculation

The amount that will be allocated to be spent for the electricity electricity_monthly_budget and for gas gas_monthly_budget every month used to be calculated based on the user's gas consumption in the last year (g_last_jar), the user's electricity consumption in the last year (e_last_jar) and the amount of budget the user has per month both for gas and electricity (budget_bill) based on the following calculation. Instead of calculating these values (electricity_monthly_budget and gas_monthly_budget) they should be provided by the end user.

1. The g_factor is calculated first, which represents that gas percentage of the total energy used in the last year:
   1. If both e_last_jar and g_last_jar provided are zero or not provided at all then the g_factor defaults to labelpartner's g_factor and if it is not specified it defaults to 0.67 value
   2. If g_last_jar provided is zero then g_factor is 0
   3. If e_last_jar provided is zero then g_factor is 1
   4. If e_last_jar and g_last_jar provided are positive numbers then the g_factor is calculated as the gas energy used last year divided by the sum of gas energy used last year and electricity energy used last year (g_last_jar * g_last_jar) / (g_last_jar * g_last_jar) + (e_last_jar * e_last_jar)
2. Then the amount of budget the user has for the year, without the fixed costs, is calculated
3. The amount that will be allocated to be spent for the electricity (electricity_monthly_budget) is calculated as the amount of budget the user has for the year without the fixed costs multiplied by the (1 - g_factor), then the fixed costs for electricity are added and the result is divided by 12 (number of months)
4. The amount that will be allocated to be spent for the gas (gas_monthly_budget) is calculated as the amount of budget the user has for the year without the fixed costs multiplied by the g_factor, and then the fixed costs for gas are added and the result is divided by 12 (number of months)

Migration of GET /profile endpoint to GET /billing/tariff-definition endpoint for retrieving tariff values

In the following table you can find the association between the parameters in GET /profile endpoint and the parameters in GET /billing/tariff-definition endpoint:

Migration of GET /profile endpoint to GET /billing/budget-definition endpoint for retrieving budget values

In the following table you can find the association between the parameters in GET /profile endpoint and the parameters in GET /billing/budget-definition endpoint:

The following parameters have been deprecated and no longer returned:

The following parameters are returned for the budget calculation instead:

Even if the deprecated POST /profile endpoint has been used for setting the budget values the GET /billing/budget-definition can return the values electricity_monthly_budget and gas_monthly_budget, as they are calculated based on the deprecated calculation described above.