Skip to main content

Fields

account : AccountType! required

The account associated with the agreement.

agreedAt : DateTime
agreedFrom : DateTime

The datetime the agreement was entered.

agreedTo : DateTime

The datetime the agreement was terminated.

characteristicValues : [CharacteristicValueInterface]

The characteristic values associated with the agreement.

Arguments
at : DateTime

The datetime to check the characteristic value at.

id : ID! required
isActive : Boolean

Whether the agreement is currently active.

isRevoked : Boolean

Whether the agreement is revoked.

params : JSONString

General parameters providing additional information about the agreement.

product : SupplyProductType

The product associated with the agreement.

ratesAgreedAt : DateTime! required
rescissionDeadlineAt : DateTime

The deadline until which the customer is allowed to rescind this agreement. If it is null, rescission is not permitted.

supplyPoint : SupplyPointType! required

The agreement's supply point.

terminatedAt : DateTime
validFrom : DateTime! required
validTo : DateTime
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, "agreedAt": "1984-02-23T19:06:56.136674+00:00", "agreedFrom": "1988-05-31T03:59:12.398767+00:00", "agreedTo": "1987-01-29T23:07:58.649215+00:00", "characteristicValues": CharacteristicValueInterface, "id": "61571310", "isActive": true, "isRevoked": true, "params": {"key": "value"}, "product": SupplyProductType, "ratesAgreedAt": "1973-04-17T00:22:35.966919+00:00", "rescissionDeadlineAt": "1984-10-08T02:23:35.773432+00:00", "supplyPoint": SupplyPointType, "terminatedAt": "2011-08-08T10:48:43.019070+00:00", "validFrom": "1984-09-23T11:40:53.539464+00:00", "validTo": "1991-07-07T01:12:19.274031+00:00" }