Fields

account : AccountType! required
agreedFrom : DateTime

The datetime the agreement was entered.
agreedTo : DateTime

The datetime the agreement was terminated.
bespokeRates : [ElectricityBespokeRate]

Bespoke rates that apply to this agreement.
bespokeStandingCharges : [ElectricityBespokeStandingCharge]

Bespoke standing charges that apply to this agreement.
characteristicValues : [CharacteristicValueInterface]

The characteristic values associated with the agreement.
Arguments
at : DateTime

The datetime to check the characteristic value at.
id : Int

The ID of the agreement.
isRevoked : Boolean

Whether the agreement is revoked.
lineItems : LineItemConnection

A collection of charges and associated consumption data.
Arguments
after : String
before : String
first : Int
grouping : LineItemGroupingOptions! required

Aggregate line items according to this grouping. Note that this doesn't guarantee that the returned items will cover a particular length of time, as it will depend on how the items have been stored, whether the period had daylight savings time changes (and therefore potentially 25 hours) etc.
itemType : LineItemTypeOptions! required
last : Int
startAt : DateTime! required
timezone : String! required

Timezone used for grouping.
meterPoint : ElectricityMeterPointType! required
ratesAgreedAt : DateTime

The datetime the rates were agreed.
rescissionDeadlineAt : DateTime

The deadline datetime for rescinding the agreement.
standingChargeUplifts : [ElectricityContractStandingChargeUplift]

List of contracted standing charge uplifts applicable during this agreement's duration. This is only applicable to business accounts where we may pay commission to a third-party intermediary.
timeOfUseScheme : TimeOfUseSchemeType

The time-of-use scheme for this agreement's product, if applicable.
unitRateUplifts : [ElectricityContractUnitRateUplift]

List of contracted unit rate uplifts applicable during this agreement's duration. This is only applicable to business accounts where we may pay commission to a third-party intermediary.
validFrom : DateTime

The start datetime of the agreement.
validTo : DateTime

The end datetime of the agreement.
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

{ "account": AccountType, "agreedFrom": "2008-06-15T20:34:12.524457+00:00", "agreedTo": "1985-06-26T00:52:34.051002+00:00", "bespokeRates": [ElectricityBespokeRate], "bespokeStandingCharges": [ElectricityBespokeStandingCharge], "characteristicValues": CharacteristicValueInterface, "id": 79154075, "isRevoked": true, "lineItems": LineItemConnection, "meterPoint": ElectricityMeterPointType, "ratesAgreedAt": "2020-04-03T19:26:04.598467+00:00", "rescissionDeadlineAt": "2024-04-05T03:44:15.330198+00:00", "standingChargeUplifts": [ElectricityContractStandingChargeUplift], "tariff": DayNightTariff, "timeOfUseScheme": TimeOfUseSchemeType, "unitRateUplifts": [ElectricityContractUnitRateUplift], "validFrom": "1976-05-08T00:42:58.169850+00:00", "validTo": "2022-03-31T00:48:06.636070+00:00" }