Skip to main content

Fields

agreedAt : DateTime

The datetime when the agreement was agreed.

earliestCancellationDate : Date

The earliest date that can legally be set as the last day of supply for this agreement, based on minimum term and notice period.

estimatedAnnualConsumption : Int

The annual consumption given by the customer in kWh.

estimatedMonthlyBillInEuros : Decimal

The estimated monthly bill in €.

id : Int
isActive : Boolean

Whether the agreement is active.

isAffectedByPriceBrake : Boolean

Whether the agreement is affected by the price brakes.

isRevoked : Boolean

Whether the agreement is revoked.

isTerminated : Boolean

Whether the agreement is terminated.

monthlyStandingCharge : Decimal

The monthly standing charge in €.

Deprecation
The 'monthlyStandingCharge' field is deprecated.

Use standing_charge_gross_rate_information instead.

- Marked as deprecated on 2023-08-14.
- Scheduled for removal on or after 2024-01-01.
netMonthlyStandingCharge : Decimal

The net monthly standing charge in €.

product : Product
ratesAgreedAt : DateTime

The datetime when the rates were agreed.

standingChargeGrossRateInformation : [GrossRateInformation]

A list of gross rate information which is relevant to the standing charge (€/month).

unitRateForecast : [UnitRateForecastType!]

Quarter hourly unit rate forecast for today and tomorrow.

Note that this is only available for dynamic electricity agreements.

The possible errors that can be raised are:

  • KT-CT-3956: Temporary error occurred.
  • KT-CT-1113: Disabled GraphQL field requested.
unitRateGrossRateInformation : [GrossRateInformation]

A list of the gross rate information which is relevant to the unit rate (ct/kWh).

Deprecation
The 'unitRateGrossRateInformation' field is deprecated.

Use unit_rate_information instead

- Marked as deprecated on 2023-08-14.
- Scheduled for removal on or after 2024-01-01.
unitRateInformation : UnitRateInformation! required

The unit rate information.

unitRatePerKwh : Decimal

The unit rate per kWh in €.

Deprecation
The 'unitRatePerKwh' field is deprecated.

Use unit_rate_information instead.

- Marked as deprecated on 2023-08-14.
- Scheduled for removal on or after 2024-01-01.
validFrom : DateTime

The datetime when the agreement is valid from.

validTo : DateTime

The datetime when the agreement is valid to.

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

{ "agreedAt": "1983-12-10T13:03:19.756318+00:00", "earliestCancellationDate": "1975-09-22", "estimatedAnnualConsumption": 79, "estimatedMonthlyBillInEuros": "1.0", "id": 87710109, "isActive": true, "isAffectedByPriceBrake": true, "isRevoked": true, "isTerminated": true, "netMonthlyStandingCharge": "1.0", "product": Product, "ratesAgreedAt": "2015-10-16T19:45:08.253260+00:00", "standingChargeGrossRateInformation": [GrossRateInformation], "unitRateForecast": [UnitRateForecastType], "unitRateInformation": SimpleProductUnitRateInformation, "validFrom": "1975-03-22T05:46:26.965310+00:00", "validTo": "1982-06-26T10:40:50.720631+00:00" }