Skip to main content
GET
Consumption totalled by period, with what it was expected to be beside it.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
supply_point_id
string
supply_point_code
string
supply_point_name
string
site_id
string
asset_id
string
commodity_id
string
commodity_name
string
unit_code
string
granularity
string
period_start
string
period_end
string
total_consumption
string
reading_count
string
estimated_count
string
total_cost
string
total_cost_currency_id
string
co2e_kg
string
heating_degree_days
string
cooling_degree_days
string
degree_day_days
string
computed_at
string
expected_consumption
string
peer_consumption
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

asset_id
string<uuid>

Note: This is a Foreign Key to asset_contracts.asset_id.

co2e_kg
number<numeric>
commodity_id
string<uuid>

Note: This is a Foreign Key to commodities.id.

commodity_name
string<character varying>
Maximum string length: 120
computed_at
string<timestamp with time zone>
cooling_degree_days
number<numeric>
degree_day_days
integer<integer>
estimated_count
integer<integer>
expected_consumption
number<numeric>
granularity
string<character varying>
Maximum string length: 10
heating_degree_days
number<numeric>
id
string<uuid>

Note: This is a Primary Key.

peer_consumption
number<numeric>
period_end
string<date>
period_start
string<date>
reading_count
integer<integer>
site_id
string<uuid>

Note: This is a Foreign Key to entry_currencies.for_site_id.

supply_point_code
string<character varying>
Maximum string length: 60
supply_point_id
string<uuid>

Note: This is a Foreign Key to supply_points.id.

supply_point_name
string<character varying>
Maximum string length: 150
total_consumption
number<numeric>
total_cost
number<numeric>
total_cost_currency_id
string<uuid>

Note: This is a Foreign Key to asset_cost_to_keep.currency_id.

unit_code
string<character varying>
Maximum string length: 30