Fields

account : AccountType! required

The Account.
description : String

Description for the agreement.
displayName : String! required

Display name for the agreement.
id : ID
isActive : Boolean

Whether the agreement is active.
isRevoked : Boolean

Whether the agreement is revoked.
isTerminated : Boolean

Whether the agreement is terminated.
meterPoint : MeterPoint! required

Meter point for the agreement.
product : SupplyProductType

The product associated with the agreement.
rates : [Rate!]! required

List of rates that apply to the agreement.
ruralPartner : RuralPartnerName

The rural partner associated with this agreement, if any.
ruralPartnerMemberId : String

The rural partner member ID associated with this agreement, if any.
timeOfUseScheme : [TimeOfUseBucket!]

List of TOU bands that apply to the agreement.
timeOfUseSchemes : [TimeOfUseSchemeType!]

List of TOU schemes that apply to the agreement.
validFrom : Date! required

Date the agreement is valid from.
validTo : Date

Date the agreement is valid to. Note: a null validTo indicates the agreement is active.
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, "description": "agreement-director-concern-once-technology", "displayName": "sometimes-someone-staff-effort-success", "id": "19456105", "isActive": true, "isRevoked": true, "isTerminated": true, "meterPoint": MeterPoint, "product": SupplyProductType, "rates": [Rate], "ruralPartner": "FARMLANDS", "ruralPartnerMemberId": "21171496", "timeOfUseScheme": [TimeOfUseBucket], "timeOfUseSchemes": [TimeOfUseSchemeType], "validFrom": "2019-03-13", "validTo": "1995-09-03" }