The 'costOfUsage' field is deprecated.

Please measurements statistics node instead.

- Marked as deprecated on 2024-09-02.
- Scheduled for removal on or after 2024-12-01.

Arguments

accountNumber : String

Account number.

fuelType : FuelType

The energy type, i.e. ELECTRICITY or GAS.

grouping : ConsumptionGroupings!


            required

Aggregate cost according to this grouping.

meterId : String

The electricity or gas meter ID.

startAt : DateTime

Datetime the data should be queried from.

timezone : String

Timezone to use for grouping.

Returns

CostOfUsageType

Possible Errors

KT-CT-1113: Disabled GraphQL field requested.
KT-CT-7899: An internal error occurred.
KT-GB-3810: Unable to get cost of usage.
KT-GB-4011: No SMETS consumption found.
KT-GB-6312: Unable to query unit rates.

Allowed Viewers

Customer

Partner User

Third party

Query Complexity

Examples

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.

Query

query CostOfUsage(
  $accountNumber: String,
  $fuelType: FuelType,
  $grouping: ConsumptionGroupings!,
  $meterId: String,
  $startAt: DateTime,
  $timezone: String
) {
  costOfUsage(
    accountNumber: $accountNumber,
    fuelType: $fuelType,
    grouping: $grouping,
    meterId: $meterId,
    startAt: $startAt,
    timezone: $timezone
  ) {
    costEnabled
    details {
      ...CostOfUsageConnectionTypeConnectionFragment
    }
    direction
  }
}

Variables

{
  "accountNumber": "A-66C97C71",
  "fuelType": "ELECTRICITY",
  "grouping": "QUARTER_HOUR",
  "meterId": "88401986",
  "startAt": "1997-03-23T16:51:12.200486+00:00",
  "timezone": "can-spring-model-next-such"
}

Response

{
  "data": {
    "costOfUsage": {
      "costEnabled": true,
      "details": CostOfUsageConnectionTypeConnection,
      "direction": "ok-mind-air-woman-yard"
    }
  }
}