Skip to main content

Fields

activePaymentMethod : String

The active payment method for the account.

balance : Int

The current balance 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 : [PropertyType]

Properties linked to the account now and in the future.

Arguments
activeFrom : DateTime

Returns properties that have an effective period that ends at or after the given activeFrom datetime.

status : AccountStatus

The current status of the account.

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

{ "activePaymentMethod": "subject-me-day-type-meeting", "balance": 51, "canModifyPayments": CanModifyPaymentsType, "marketSupplyAgreements": AgreementConnection, "number": "what-once-bit-present-large", "properties": [PropertyType], "status": "PENDING" }