Fields

billingAddress : String

Account billing address.
billingAddressLine1 : String! required
billingAddressLine2 : String! required
billingAddressLine3 : String! required
billingAddressLine4 : String! required
billingAddressLine5 : String! required
billingCountryCode : String! required
billingName : String! required

Name for this account. If one exists, the billing name of the portfolio will prepend this.
billingPostcode : String! required
canModifyPayments : CanModifyPaymentsType

Data about whether or not an account can modify their payments.
id : ID! required
ledgers : [LedgerWithPaymentsInstructions]

Retrieve different supplementary ledgers used in Spain market.
Arguments
ledgerId : ID

The id of the ledger to return.
Deprecation
The 'ledgerId' field is deprecated.

Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'

- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.
ledgerNumber : String

The number of the ledger to return.
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.
splitBillingAddress : [String]

List of billing address lines.
status : String! 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

{ "billingAddress": "still-decade-less-face-special", "billingAddressLine1": "or-past-senior-effort-around", "billingAddressLine2": "stock-firm-speech-what-pick", "billingAddressLine3": "billion-take-plant-early-debate", "billingAddressLine4": "medical-business-town-remain-standard", "billingAddressLine5": "himself-type-care-respond-effort", "billingCountryCode": "about-building-cut-shake-her", "billingName": "lot-party-environment-point-public", "billingPostcode": "TV-me-talk-whose-shoulder", "canModifyPayments": CanModifyPaymentsType, "id": "66531411", "ledgers": [LedgerWithPaymentsInstructions], "marketSupplyAgreements": AgreementConnection, "number": "huge-management-protect-street-cost", "properties": [PropertyType], "splitBillingAddress": "administration-send-major-hour-role", "status": "state-from-during-baby-second" }