Skip to main content

Fields

actualConsumption : Float

The actual gas consumption in kWh during this period.

actualSavingsRatio : Float

The actual gas savings ratio during this period.

expectedConsumption : Float! required

The expected gas consumption in kWh during this period.

hasSubmittedMeterReading : Boolean! required

Specifies whether there was at least one meter reading submitted during this period.

periodEnd : Date! required

The last day (inclusive) of the period to which this summary data applies.

periodStart : Date! required

The first day of the period to which this summary data applies.

targetSavingsRatio : Float! required

The planned gas savings ratio during this period.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "actualConsumption": 996.99, "actualSavingsRatio": 365.55, "expectedConsumption": 6.62, "hasSubmittedMeterReading": true, "periodEnd": "1974-09-11", "periodStart": "2025-08-21", "targetSavingsRatio": 403.45 }