Fields

accountId : Int

The account identifier.
accountNumber : String

The account number of the customer.
achievedCarbonIndex : AchievedCarbonIndexChoices

The corresponding index (very-low, low, moderate, high, very-high).
achievedCarbonRank : String

Where the customer ranks for carbon intensity within their region. (1=Greenest, 100=Dirtiest).
achievedCarbonRate : Float

Achieved unit rate over that week period.
apiGspGroupName : String

The name given to the GSP as per NG API.
carbonGrams : Float

The corresponding total grams of C02 over that week period.
consumptionKwh : String

The total consumption over that week period.
gspGroupId : String

The GSP.
hasFullReadings : String

Whether or not the customer has full readings within the week period.
isLatestWeek : String

If the week is the latest week i.e if the date is 2024-03-06 (Wed) then the latest full week should be 2024-02-26 (Mon).
meterPointId : Int

The meter point identifier.
mpan : String

Corresponding MPAN.
numberPeriods : String

The number of smart meter readings we have within the week period (should be 336).
periodEnd : DateTime

The last meter reading we have for this customer within week period.
periodStart : DateTime

The first meter reading we have for this customer within week period.
propertyId : Int

The property identifier.
weekStart : DateTime

The Monday of the week in question.
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

{ "accountId": 93612653, "accountNumber": "A-043B33C6", "achievedCarbonIndex": "VERY_LOW", "achievedCarbonRank": "meeting-her-get-day-purpose", "achievedCarbonRate": 443.75, "apiGspGroupName": "create-bit-program-fast-matter", "carbonGrams": 333.78, "consumptionKwh": "the-tonight-adult-cut-foreign", "gspGroupId": "85610286", "hasFullReadings": "situation-fund-defense-purpose-study", "isLatestWeek": "usually-gas-think-reach-machine", "meterPointId": 81473680, "mpan": "doctor-rise-be-college-treat", "numberPeriods": "defense-service-outside-subject-happy", "periodEnd": "1989-04-03T12:25:17.355757+00:00", "periodStart": "1986-06-24T09:52:46.656284+00:00", "propertyId": 91065162, "weekStart": "2014-02-09T09:20:46.978557+00:00" }