Arguments

accountNumber : String! required

Account number to calculate costs for.
consumption : Decimal

Provide costs for the first 'X' amount of consumption, measured in kWh.
deviceId : ID

Flex device ID to filter costs for.
periods : [DateTimeRangeInput]! required

Periods to calculate costs for.
supplyPointId : ID

Filter results to a specific supply point.

Returns

CostOfUsageResponse

This output type represents the costs/consumption for multiple time periods.

Allowed Viewers

Customer Partner User Third party

Rate Limits

Key Steps
ip ['10/m']

Query Complexity

1

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 GbrCostOfUsage( $accountNumber: String!, $consumption: Decimal, $deviceId: ID, $periods: [DateTimeRangeInput]!, $supplyPointId: ID ) { gbrCostOfUsage( accountNumber: $accountNumber, consumption: $consumption, deviceId: $deviceId, periods: $periods, supplyPointId: $supplyPointId ) { periods { ...CostOfUsagePeriodFragment } } }

Variables

{ "accountNumber": "A-EAD39E94", "consumption": "1.0", "deviceId": "19271060", "periods": DateTimeRangeInput, "supplyPointId": "97834934" }

Response

{ "data": { "gbrCostOfUsage": { "periods": [CostOfUsagePeriod] } } }