Skip to main content

Fields

accountType : String! required
activeCampaigns : [SiteworksCampaignType]

Active campaigns for the account.

billingName : String! required

Name for this account. If one exists, the billing name of the portfolio will prepend this.

brand : String! required

The brand of the account.

canModifyPayments : CanModifyPaymentsType

Data about whether or not an account can modify their payments.

marketSupplyAgreements : AgreementConnection

Retrieve all market supply agreements under this account. Note that when active is set to false it actually means 'return both active and inactive agreements'.

Arguments
active : Boolean

Whether to return active agreements only.

after : String
before : String
first : Int
id : ID

Filter the list to the agreement with this id.

last : Int
supplyPointExternalIdentifier : String

Filter the list to agreements for the supply point with this external identifier.

number : String! required

Properties linked to the account now and in the future.

siteworksRequests : [SiteworksRequestType]

Siteworks requests associated to an account.

smets2Interest : SmartMeterInterestChoices

The interest of an account in procuring smart meters.

status : AccountStatus

The current status of the account.

users : [AccountUserType!]! required
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

{ "accountType": "school-oil-later-change-mean", "activeCampaigns": [SiteworksCampaignType], "billingName": "more-career-seven-writer-defense", "brand": "performance-lose-brother-thought-recognize", "canModifyPayments": CanModifyPaymentsType, "marketSupplyAgreements": AgreementConnection, "number": "different-play-stock-anyone-common", "properties": [SiteworksBookingPropertyType], "siteworksRequests": [SiteworksRequestType], "smets2Interest": "PRIORITY", "status": "PENDING", "users": [AccountUserType] }