Skip to main content

Fields

agreedFrom : DateTime

The datetime the agreement was entered.

agreedTo : DateTime

The datetime the agreement was terminated.

electricitySupplyPoint : ElectricitySupplyPointType

The supply point linked to the agreement.

isActive : Boolean

Whether the agreement is active or not.

isRevoked : Boolean

Whether the agreement is revoked.

isRollover : Boolean

Agreement was created due to a rollover.

ratesAgreedAt : DateTime

The datetime the rates were agreed.

rescissionDeadlineAt : DateTime

The deadline datetime for rescinding the agreement.

supplyPoint : MarketSupplyPointType

The supply point linked to the agreement.

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

{ "agreedAt": "1980-01-28T18:30:34.723337+00:00", "agreedFrom": "1987-12-31T21:02:46.807740+00:00", "agreedTo": "2020-08-31T11:11:27.321203+00:00", "electricitySupplyPoint": ElectricitySupplyPointType, "id": 68829905, "isActive": true, "isRevoked": true, "isRollover": true, "market": "ELECTRICITY", "product": ProductInterface, "ratesAgreedAt": "2022-10-08T16:23:41.041308+00:00", "rescissionDeadlineAt": "2006-04-05T15:30:51.404187+00:00", "supplyPoint": ElectricitySupplyPointType, "terminatedAt": "1982-10-22T14:03:51.477429+00:00", "validFrom": "1987-10-04T16:02:39.012351+00:00", "validTo": "2008-12-21T22:55:54.378756+00:00" }