POST api/customers/{customerId}/contracts/{contractNo}/meters/{meterId}/costs
GET the costs for a given meter as a time series.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
customerId |
Customer ID |
integer |
Required |
contractNo |
Customer's contract number |
integer |
Required |
meterId |
Contract's meter ID |
string |
Required |
Body Parameters
Required: FromTime (f.o.m.) as dateTime in UTC, ToTime (t.o.m.) as dateTime in UTC, Resolution [None=0, Hour=7, Day=20, Month=40, Year=50]. Optional: IncludeLastYear/LastPeriod??? as boolean (default is false), IncludeWeather as boolean (default is false).
ConsumptionRequestName | Description | Type | Additional information |
---|---|---|---|
ContractNo | integer |
None. |
|
CustomerId | integer |
None. |
|
FromTime | date |
None. |
|
ToTime | date |
None. |
|
IncludeLastYear | boolean |
None. |
|
IncludeWeather | boolean |
None. |
|
Resolution | ConsumptionSeriesResolution |
None. |
|
HasWattMeter | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "ContractNo": 1, "CustomerId": 2, "FromTime": "2025-05-19T19:24:27.7486294+00:00", "ToTime": "2025-05-19T19:24:27.7486294+00:00", "IncludeLastYear": true, "IncludeWeather": true, "Resolution": 0, "HasWattMeter": true }
text/html
Sample:
{"ContractNo":1,"CustomerId":2,"FromTime":"2025-05-19T19:24:27.7486294+00:00","ToTime":"2025-05-19T19:24:27.7486294+00:00","IncludeLastYear":true,"IncludeWeather":true,"Resolution":0,"HasWattMeter":true}
Response Information
Resource Description
Time series with cost and max effect. Name=WeatherStationName, ConsumptionTimeseriesResolution=as Resolution in request, ConsumptionType=750-PowerCost or 750-NetCost.
Collection of ConsumptionTimeSeriesModelName | Description | Type | Additional information |
---|---|---|---|
Name | string |
None. |
|
Values | Collection of ConsumptionTimeSerieValue |
None. |
|
ConsumptionTimeseriesResolution | ConsumptionSeriesResolution |
None. |
|
ConsumptionType | ConsumptionType |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Name": "sample string 1", "Values": [ { "$id": "1", "MaxEffectValueTime": "2025-05-19T19:24:27.7642548+00:00", "ValueTime": "2025-05-19T19:24:27.7642548+00:00", "MaxEffect": 1.1, "Value": 1.1, "TimeSeriesType": 0 }, { "$ref": "1" } ], "ConsumptionTimeseriesResolution": 0, "ConsumptionType": 0 }, { "Name": "sample string 1", "Values": [ { "$ref": "1" }, { "$ref": "1" } ], "ConsumptionTimeseriesResolution": 0, "ConsumptionType": 0 } ]
text/html
Sample:
[{"Name":"sample string 1","Values":[{"$id":"1","MaxEffectValueTime":"2025-05-19T19:24:27.7642548+00:00","ValueTime":"2025-05-19T19:24:27.7642548+00:00","MaxEffect":1.1,"Value":1.1,"TimeSeriesType":0},{"$ref":"1"}],"ConsumptionTimeseriesResolution":0,"ConsumptionType":0},{"Name":"sample string 1","Values":[{"$ref":"1"},{"$ref":"1"}],"ConsumptionTimeseriesResolution":0,"ConsumptionType":0}]