Objects

goodsPurchase (GoodsPurchase)

Goods purchase created.

offer (OfferType)

Accepted quoting offer.

acceptedVersion (String)

Version of terms and conditions that were accepted.

edgeCount (Int!)

Number of nodes in the edge.

edges ([AccountApplicationConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (AccountApplicationType)

The item at the end of the edge

coolingOffEndDate (Date)

Last day of the cooling off period. Barring changes or objections, the account will be gained on the next business day after this date. This value will only be returned for current applications.

dateOfSale (Date)

Date at which this account decided to switch to us.

isMigrated (Boolean)

Whether this account application represents a migration into the current system or a regular gain.

migrationSource (String)

The source system for a migrated account. This could be the previous supplier or the previous account management system.

preferredSsd (Date)

Preferred supply start date. If null, it means ASAP.

salesChannel (String!)

salesSubchannel (String)

The sales subchannel used when signing up. This could for example be a price comparison site.

status (AccountApplicationStatus!)

accountCharge (AccountChargeType)

Debit details.

accountCredit (AccountCreditType)

Credit details.

id (ID)

Balance transfer ID.

reason (String)

The reason for the balance transfer.

edgeCount (Int!)

Number of nodes in the edge.

edges ([AccountCampaignConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (AccountCampaignType)

The item at the end of the edge

campaignExpiryDate (Date)

The date on which the associated campaign itself concludes.

expiryDate (Date)

The date on which the account's participation in the campaign ends.

name (String)

The name of the campaign.

slug (String)

The slug of the campaign.

startDate (Date)

The date that the account's link to the campaign started.

data (JSONString)

A JSON object containing unstructured data about the account charge.

updatedAt (DateTime)

The date and time the metadata was last updated.

cclAmount (BigInt)

The climate change levy amount of the charge.

displayNote (String)

The display note for the charge.

grossAmount (BigInt)

The gross amount of the charge.

id (ID)

The ID of the account charge.

metadata (AccountChargeMetadataType)

JSON metadata containing unstructured data about the account charge.

netAmount (BigInt)

The net amount of the charge.

note (String)

The note for the charge.

reason (String)

The reason for the charge.

salesTaxAmount (BigInt)

The sales tax amount of the charge.

edgeCount (Int!)

Number of nodes in the edge.

edges ([AccountConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (AccountType)

The item at the end of the edge

data (JSONString!)

updatedAt (DateTime!)

grossAmount (BigInt!)

id (ID!)

metadata (AccountCreditMetadataType)

netAmount (BigInt!)

note (String!)

reason (String!)

salesTaxAmount (BigInt!)

accountNumber (String!)

The account number.

ledgerDebtPositions ([LedgerDebtPositionType]!)

The delinquent debt position for each eligible ledger on the account.

edgeCount (Int!)

Number of nodes in the edge.

edges ([AccountEventConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (AccountEvent)

The item at the end of the edge

category (String!)

fetchUrl (String)

filename (String!)

id (ID!)

The ID of the object

isReady (Boolean)

Is the file ready for use / downloadable?

isUploaded (Boolean)

Is the file uploaded to S3?

sizeInBytes (Int)

edgeCount (Int!)

Number of nodes in the edge.

edges ([AccountFileAttachmentConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (AccountFileAttachment)

The item at the end of the edge

isEligibleForIo (Boolean)

Whether account is eligible to register devices with Intelligent Octopus or not.

loyaltyPoints (Int)

The number of loyalty points the account (or user with the given id) has.

totalMonetaryAmount (Int)

The net monetary value of the loyalty points in the currency's sub-units.

body (String!)

createdAt (DateTime!)

id (ID!)

isPinned (Boolean!)

unpinAt (DateTime)

edgeCount (Int!)

Number of nodes in the edge.

edges ([AccountPaymentConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (AccountPaymentType)

The item at the end of the edge

amount (BigInt!)

Amount of payment in the currency's minor unit

id (ID)

The ID of the payment.

paymentDate (Date!)

The date this payment is scheduled to be debited

paymentInstruction (PaymentInstructionType)

The payment instruction that was used to make this payment.

reference (String!)

status (AccountPaymentStatusOptions)

The current status of the payment.

surchargeAmount (Int)

Surcharge amount generated by this payment.

transactionType (AccountPaymentTransactionTypeChoices)

The transaction type of the payment.

uuid (UUID!)

account (AccountType!)

createdAt (DateTime!)

namespace (String!)

updatedAt (DateTime!)

value (String!)

content (String)

Reminder content.

dueAt (DateTime)

When the reminder is due.

reminderType (AccountReminderTypes)

The reminder type.

edgeCount (Int!)

Number of nodes in the edge.

edges ([AccountReminderConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (Reminder)

The item at the end of the edge

edgeCount (Int!)

Number of nodes in the edge.

edges ([AccountRepaymentConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (AccountRepaymentType)

The item at the end of the edge

amount (BigInt!)

Amount of payment in the currency's minor unit

id (ID!)

paymentDate (Date!)

The date this payment is scheduled to be debited

paymentUuid (UUID)

The UUID of the payment being refunded.

reason (RepaymentReason)

The reason for the repayment.

status (AccountRepaymentStatusOptions)

The current status of the repayment.

account (AccountType)

The account found.

score (Decimal)

How well the account matched the search terms.

accountType (AccountTypeChoices)

The type of account.

activeHardshipAgreements ([HardshipAgreementType])

List of active hardship agreements for the user when is_in_hardship is True.

activeReferralSchemes (ReferralSchemeTypes)

The referral schemes currently active for this account.

address (RichAddressType)

The billing address of this account, stored in the new libaddressinput-based format.

Note that name and organization are very unlikely to be supplied here; the billing_name field on the account itself is generally used for that purpose instead.

annualStatements (AnnualStatementConnectionTypeConnection)

Fetch annual statements for the account.

applications (AccountApplicationConnectionTypeConnection)

Applications by this account to become our customer. More recent applications will be listed first.

assistanceAgreements ([AssistanceAgreementType])

Assistance agreements for account.

balance (Int!)

The current account balance.

bill (BillInterface)

Fetch a specific issued bill (invoice/statement) for the account.

billingAddress (String)

The billing address of the account.

billingAddressLine1 (String)

billingAddressLine2 (String)

billingAddressLine3 (String)

billingAddressLine4 (String)

billingAddressLine5 (String)

billingAddressPostcode (String)

billingCountryCode (String)

billingDeliveryPointIdentifier (String)

billingEmail (String)

The billing email of the account.

billingName (String)

The billing name of the account.

billingOptions (BillingOptionsType)

Information about the account's billing cycle.

billingPostcode (String)

The postcode of the billing address.

billingSubName (String)

The billing sub name of the account.

billingTriggerConfiguration (BillingTriggerConfiguration)

The active billing trigger configuration for the account.

bills (BillConnectionTypeConnection)

Fetch issued bills (invoices/statements) for the account.

brand (String)

The brand of the account.

business (BusinessType)

Business info related to a business account.

businessType (BusinessTypeOptions)

The company type of a business account.

campaigns ([AccountCampaignType])

The campaigns associated with an account.

canBeWithdrawn (Boolean)

Whether an account can be withdrawn.

canChangePayments (Boolean)

Whether an account can change their payment schedule.

canInputMeterReadingsViaIvr (Boolean)

Whether on not the meter readings can be input via IVR.

canModifyPayments (CanModifyPaymentsType)

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

canRenewTariff (Boolean)

Whether the account is eligible for tariff renewal.

canRequestRefund (Boolean)

Whether the account can request a credit refund.

commsDeliveryPreference (CommsDeliveryPreference)

The method the account has specified they prefer we contact them.

communicationDeliveryPreference (String)

complaints (ComplaintConnectionTypeConnection)

The complaints associated with an account.

consents ([ConsentType!]!)

Consents linked to this account.

contributionAgreements ([ContributionAgreementType])

Contribution agreements for account.

cotReadingWindowDays (Int)

The number of days around a move out a final meter reading can be given for.

createdAt (DateTime)

The datetime that the account was originally created.

currentEstimatedSsd (Date)

The current estimated supply start day on an account.

customerAssets ([CustomerAssetType])

Get customer assets for an account.

debtCollectionProceedings ([DebtCollectionProceedingType])

Debt collection proceedings for account.

directDebitInstructions (DirectDebitInstructionConnectionTypeConnection)

The direct debit instructions of the account

documentAccessibility (DocumentAccessibilityChoices)

The document accessibility preference of the account.

earliestPossibleSsd (Date)

The earliest possible supply start day on an account.

electricityAgreements ([ElectricityAgreementType])

The electricity agreements belonging to the account.

eligibilityForWarmHomeDiscount (WarmHomeDiscountEligibility)

Whether the account is eligible to apply for Warm Home Discount as part of the Scottish Broader Group.

events (AccountEventConnectionTypeConnection)

The account events that were recorded for the account.

fileAttachments ([AccountFileAttachment])

Files attached to this account.

gasAgreements ([GasAgreementType])

The gas agreements belonging to the account.

greenAccomplishments (GreenAccomplishmentsType)

The green benefits achieved over the lifetime of an account.

hasActiveCollectionsProceedings (Boolean)

Whether or not the account has active collections proceedings.

hasActiveDunningProcess (Boolean)

Whether or not the account has an active Dunning process.

id (ID!)

isEligibleForElectricityReadingIncentive (Boolean)

Whether or not an account is eligible for an electricity reading incentive.

isEligibleForGasReadingIncentive (Boolean)

Whether or not an account is eligible for a gas reading incentive.

isInBlockingMigration (Boolean)

Whether or not the account is a part of a migration for which we want to switch supplier without customer actions.

isInHardship (Boolean)

True if there is an active Hardship Agreement for this account. False otherwise.

latestPossibleSsd (Date)

The latest possible supply start day on an account.

ledgers ([LedgerType])

Ledgers provide the foundation of bookkeeping functionality. Similar to a bank account, they allow us to keep track of financial activity on a particular customer account.

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'.

maximumRefund (MaximumRefundType)

The maximum amount a customer is allowed to request as a refund and the reason why that's the maximum amount.

metadata ([Metadata])

Metadata associated with the account.

notes ([AccountNoteType])

Notes for the account.

number (String)

A code that uniquely identifies the account.

operationsTeam (OperationsTeamType)

The operations team that the account belongs to.

overdueBalance (Int)

The current account overdue balance.

paginatedFileAttachments (AccountFileAttachmentConnectionTypeConnection)

Files attached to this account.

paginatedPaymentForecast (PaymentForecastConnectionTypeConnection)

Paginated payment forecasts for an account. Starts from today's date (inclusive). The interface supports last but does not guarantee 'lastness'.

paymentAdequacy (PaymentAdequacyType)

Results of the latest review of the account's payments.

paymentForecast ([PaymentForecastType])

A list displaying the payment forecast for an account. The list starts from today's date (inclusive).

paymentMethods (PaymentInstructionConnectionTypeConnection)

The payment instructions of the account.

paymentPlans (PaymentPlanConnectionTypeConnection)

The payment plans that have been created for this account.

payments (AccountPaymentConnectionTypeConnection)

The payments made into an account from a payment instruction.

paymentSchedules (PaymentScheduleConnectionTypeConnection)

The schedules that describe how we would expect to take payments for an account on a given month.

portfolio (PortfolioType)

The portfolio this account is linked to.

preferredLanguageForComms (String)

The language that the account preferred for communications.

projectedBalance (Int)

Expected balance in a year's time.

properties ([PropertyType])

Properties linked to the account now and in the future.

provisionalTransactions (ProvisionalTransactionConnectionTypeConnection)

recommendedBalanceAdjustment (Int)

Top up payment amount in pence that we recommend for an account.

references ([AccountReferenceType])

Account references linked to this account.

referrals (ReferralConnectionTypeConnection)

The referrals created by this account.

referralsCreated (Int)

Number of referrals created by this account.

refundApproval (RefundApprovalType)

Refund approval data from the Bulk Refund Allocation Query (BRAQ) API. Provides maximum refund amount and any issues. Raises errors if functionality is not configured or data unavailable.

reminders (AccountReminderConnectionTypeConnection)

The reminders associated with an account.

repayments (AccountRepaymentConnectionTypeConnection)

The repayments that have been requested for this account.

requestRefundEligibility (RequestRefundEligibilityType)

Details about the eligibility status for requesting a refund.

rewards ([RewardType])

The rewards applied to this account.

shouldReviewPayments (Boolean)

Whether the account's payment should be adjusted.

smets2Interest (SmartMeterInterestChoices)

The interest of an account in procuring smart meters.

smets2RefusalReason (SMETS2InterestReason)

The reason why the account holder is not interested in having a smart meter installed.

splitBillingAddress ([String])

List of billing address lines.

status (AccountStatus)

The current status of the account.

trackerTariffDailyPricing (TrackerTariffDailyPricing)

Only relevant for Kraken instances that support daily tracker tariffs. Returns null if not applicable.

transactions (TransactionConnectionTypeConnection)

Fetch transactions that have taken place on the account.

urn (String)

Unique reference number from a 3rd party enrolment.

users ([AccountUserType!]!)

warmHomeDiscount (WarmHomeDiscount)

Get details about warm home discount applications and records.

emailFormat (EmailFormats)

What format the user would like to receive their emails in.

fontSizeMultiplier (Float)

This setting allows the user to adjust the default font size of the communications sent to them.

isOptedInMeterReadingConfirmations (Boolean)

Whether the user has opted in to receive meter reading confirmation emails.

isOptedInToClientMessages (Boolean)

Whether a user has opted in to receive messages from the client or client group. For example, for Octopus Energy this describes whether a user is opted in to offers from Octopus Investments.

isOptedInToLifeSupportCall (Boolean)

Whether the user is opted in to life support call.

isOptedInToOfferMessages (Boolean)

Whether a user has opted in to receive messages offering discounts or other services not directly related to the services the client provides.

isOptedInToRecommendedMessages (Boolean)

Whether a user has opted in to receive messages we recommend they read, but are not vital to the utilities the client provides. For example, these could be reminders that the client will take a payment.

isOptedInToSmsMessages (Boolean)

Whether the user has opted in to receive SMS messages.

isOptedInToThirdPartyMessages (Boolean)

Whether a user has opted in to receive messages from the client's preferred third parties.

isOptedInToUpdateMessages (Boolean)

Whether a user has opted in to receive messages updating them on client activities.

isUsingInvertedEmailColours (Boolean)

Whether a user has opted to have inverted colours in their emails. This is currently only relevant to the Octopus Energy brand, whose emails have a dark background by default.

preferredHoldMusic (Songs)

Song which will be used as hold music for the user.

smsOptInLastChangeDate (DateTime)

The date the SMS opt-in was last changed.

edgeCount (Int!)

Number of nodes in the edge.

edges ([AccountUserConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (AccountUserType)

The item at the end of the edge

consents ([ConsentType!]!)

Consents linked to this user.

isSensitive (Boolean)

Whether the value is sensitive and encrypted.

namespace (String)

The namespace for the property.

value (String)

The property value.

permission (String)

The short name of the permission.

account (AccountType!)

id (ID!)

role (RoleString)

The account role.

user (AccountUserType!)

accounts ([AccountInterface])

List of accounts that the user is linked to either via portfolio role or account role.

accountUserRoles ([AccountUserRoleType])

List of roles a user has for each account they're linked to.

address (RichAddressType)

This user's address.

alternativePhoneNumbers ([String])

List of alternative phone numbers for the account user.

businesses (BusinessConnectionTypeConnection)

List of businesses that the user has access to through their granted roles.

consents ([ConsentType!]!)

Consents linked to this user.

createdAt (DateTime!)

dateOfBirth (Date)

AccountUser's date of birth.

details ([AccountUserDetailType])

List of details linked to this user.

displayName (String)

We recommend you use fullName instead of this field.

email (String!)

familyName (String!)

firstName (String)

We recommend you use preferredName or fullName instead of this field.

fullName (String)

The user's full name.

givenName (String!)

hasFamilyIssues (Boolean)

Whether there are family issues.

holdMusicChoices ([TrackOptionType])

List of hold music options.

id (ID!)

isActive (Boolean)

Whether this user is active.

isDeceased (Boolean!)

Designates whether this user is deceased.

isInHardship (Boolean)

True if user is linked to an account with an active hardship agreement.

isOptedInToWof (Boolean)

label (String)

A free text field to help identifying the customer (e.g. for a job title).

landline (String!)

landlinePhoneNumber (String)

The user's landline phone number.

lastName (String)

We recommend you use preferredName or fullName instead of this field.

liveSecretKey (String)

The user's secret key to access the Developer API.

mobile (String!)

number (String)

A code that uniquely identifies the account user.

paymentMethods (PaymentInstructionConnectionTypeConnection)

List payment instructions linked to this user.

permissions ([AccountUserPermission])

Holds information about the permissions of the current viewer.

portfolioId (ID)

We recommend you use portfolioIds instead of this field.

portfolioIds ([ID])

List of portfolio ids that the user is linked to via their portfolio roles.

portfolios (PortfolioConnectionTypeConnection)

List of portfolios that the user is linked to via their portfolio roles.

portfolioUserRoles ([PortfolioUserRoleType])

List of roles a user has for each portfolio they're linked to.

preferences (AccountUserCommsPreferences)

preferredName (String)

The user's preferred name.

pronouns (String)

The user's pronouns e.g. 'she/her', 'he/him', 'they/them'.

specialCircumstances (SpecialCircumstancesType)

title (String)

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'.

number (String!)

properties ([PropertyType])

Properties linked to the account now and in the future.

status (AccountStatus)

The current status of the account.

agent (SiteworksAppointmentAgent)

The agent carrying out the appointment.

agentReference (String)

The agent reference of the appointment.

appointmentDate (Date)

The date of the appointment.

cancellationCategory (CancellationCategory)

The reason the appointment was cancelled (category).

cancellationSubCategory (String)

The reason the appointment was cancelled (sub-category).

createdAt (DateTime!)

When the appointment was created.

date (Date)

The date of the appointment.

id (UUID!)

The unique identifier of the appointment.

requestId (String)

The request ID of the Request that the appointment is associated with.

status (AppointmentStatus)

The current status of the Siteworks application.

timeSlotEnd (Time)

The end time of the appointment time slot.

timeSlotStart (Time)

The start time of the appointment time slot.

workCategory (WorkCategory)

The category of work the appointment has been booked for.

addressLine1 (String)

Address line 1 of the associated property of the COS loss process.

addressLine2 (String)

Address line 2 of the associated property of the COS loss process.

addressLine3 (String)

Address line 3 of the associated property of the COS loss process.

cosLossProcessFuelType (CosLossProcessFuelType)

The fuel type of the meter associated with the COS loss process.

cosLossProcessId (Int)

The id of the 'Change Of Supplier Loss' process.

hasOpenErroneousTransfer (Boolean)

A flag for whether or not the meter point has an open ET associated with it.

postcode (String)

Postcode of the associated property of the COS loss process.

supplyEndDate (Date)

The date the supply ends.

timestamp (DateTime)

The time the data was reported.

value (HeatPumpActivity)

The latest reported activity of the heat pump.

username (String)

Username of the Actor.

contract (Contract)

The contract actualized.

code (String)

Code name of the sensor.

displayName (String)

User determined name for a sensor.

enabled (Boolean)

Whether or not a sensor is enabled.

type (SensorType)

Sensor type (NTC).

businessSegmentPeriod (BusinessSegmentPeriodType)

The business segment period that was created.

campaignAdded (Boolean)

Whether the campaign was successfully added.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

child (PropertyType)

The child property that was added to the parent.

amount (Int!)

Top-up amount in pence to add to smart meter.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

token (Token)

riskIdentifiers ([RiskListItemType])

List of successfully added risk identifiers.

note (InkNote)

The ink conversation note.

parent (PropertyType)

The parent property that was added to the child.

partnerUser (PartnerUserType)

The partner user that was added to the team.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

property (PropertyType)

The property that was added to the account.

property (PropertyType)

The property that was added to the hierarchy.

mpan (String)

profileClass (String)

mprn (String)

edgeCount (Int!)

Number of nodes in the edge.

edges ([AddressConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (AddressType)

The item at the end of the edge

default (String)

Pre-filled seed value shown before any user interaction. Null if not set.

errors ([String!]!)

Validation error messages for this field. Empty when the field is valid or no validation has been run.

fieldType (AddressFieldTypeEnum!)

Input widget type to render for this field.

label (String!)

Country-specific human-readable label, e.g. 'Suburb' or 'Postcode'.

name (String!)

Machine identifier for the field, e.g. 'locality' or 'postal_code'.

options ([AddressFieldOptionType!])

Available options for SELECT fields. Null for all other field types.

userEditable (Boolean!)

Whether the user can interact with this field. False for hidden fields.

validation (AddressFieldValidationRuleType!)

Client-side validation constraints for this field.

value (String)

Submitted or pre-loaded form value. Null if not set.

fieldGroups ([AddressFieldGroupType!]!)

Ordered list of field groups making up the address form.

fields ([AddressFieldConfigType!]!)

Ordered list of fields in this group.

label (String)

Optional UI section heading. Null for unlabelled groups.

name (String!)

Machine identifier for the group, e.g. 'address_fields' or 'country_selection'.

label (String!)

Human-readable text shown in the dropdown, e.g. 'New South Wales'.

value (String!)

The raw value submitted with the form, e.g. 'NSW'.

maxLength (Int)

Maximum number of characters allowed. Null if no limit.

regex (String)

Regular expression the submitted value must match. Null if unrestricted.

required (Boolean!)

Whether the field must be filled before submitting.

electricityMeterPoints ([ElectricMeterTechnicalDetails])

List of energised electricity meter points associated with the address.

electricityNetworkRates ([ElectricityNetworkRates])

List of network rates information for each electricity meter-point.

gasMeterPoints ([GasMeterTechnicalDetails])

List of gas meter points associated with the address.

countryCode (String)

Country code of billing address.

line1 (String)

Line 1 of address.

line2 (String)

Line 2 of address.

line3 (String)

Line 3 of address.

line4 (String)

Line 4 of address.

line5 (String)

Line 5 of address.

postcode (String)

Postcode of billing address.

addressKey (String!)

A unique ID per address using part of the address with spaces removed.

addressType (AddressTypeEnum)

The type of address (domestic, business or unknown).

display (String!)

The complete and human-legible address in a single string.

electricityMeterPoints ([AddressAPIElectricityMeterPointType])

gasMeterPoints ([AddressAPIGasMeterPointType])

gspGroupId (String!)

The ID of the Grid Supply Point Group that the address belongs to.

hasPrepaidMeters (Boolean!)

houseNumber (String)

The identifier for a property. The house number consists of the part of line 1 of the address that is not the street name. This includes sub-building names, building names, deliver point aliases and building numbers. For example, the house number for the property 'Flat 12 100 Example St' would be 'Flat 12 100'.

line1 (String!)

Line 1 of the address. This is generally the house number and street name.

line2 (String!)

Line 2 of the address. This is generally the area or village.

line3 (String!)

Line 3 of the address. This is generally the area or village.

line4 (String!)

Line 4 of the address. This is generally the city.

line5 (String!)

Line 5 of the address. This is generally the county.

postcode (String!)

streetName (String)

The street name for a property. The street name consists of the part of line 1 of the address that is not the house number. For example, the house number for the property 'Flat 12 100 Example St' would be 'Example St'.

edgeCount (Int!)

Number of nodes in the edge.

edges ([AddressUPRNTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (UniqueRELAddressType)

The item at the end of the edge

accountReferral (ReferralType)

The created account referral instance.

storyline (InkStoryline)

The storyline that was added to the conversation.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

bucket (String!)

The S3 bucket.

fields (JSONString!)

The fields to be included in the pre-signed post.

key (String!)

The S3 bucket key.

preSignedUrl (String!)

The pre-signed S3 URL.

contactEmail (String!)

contactName (String!)

id (ID!)

isBusiness (Boolean!)

landingUrl (String!)

organisation (AffiliateOrganisationType)

Affiliate Organisation.

subdomain (String!)

trainingStatus (LinkTrainingStatus!)

allowAlternativePaymentMethods (Boolean)

Is this partner allowed to specify payment methods other than Direct Debit in the import csv or API.

canRegisterBusinessMeterPoints (Boolean)

Are meter point registrations limited for profile classes 1 and 2 for registrations from csv or API.

canRegisterCustomersWithoutEmailAddress (Boolean)

Allow registration requests with customers without an email address.

canRegisterPortfolioAccounts (Boolean)

Allow registration requests with exiting account user emails to add to the portfolio belonging to the account user.

canRenewTariffs (Boolean)

Allow performing tariff renewals via API.

canUseIvrSupportApi (Boolean)

Allow this partner access to the IVR support API (modify their own IVR handling through third party 'IVR Flow Editor').

contactEmail (String!)

The primary contact email for the organisation.

defaultAccountType (AccountTypeChoices)

Default Account Type.

id (ID!)

The ID of the affiliate organisation.

isFieldSalesOnlyProduct (Boolean)

Restrict to field-sales-only products? This is only allowed for the 'field-sales' and 'events' sales channels.

name (String!)

The name of the affiliate organisation.

number (String!)

Unique identifier for the organisation in the format O-XXXXXXXX.

references ([OrganisationReferenceType])

External references attached to the organisation, keyed by namespace.

salesChannel (SalesChannelChoices)

Sales Channel.

salesChannelCode (String)

Sales Channel Code.

skipMeterPointAddressValidation (Boolean)

Allow this partner to skip validation that ensures all meter points belong to the same address.

id (ID!)

ipAddress (String)

link (AffiliateLinkType)

Affiliate Link.

queryParams (JSONString!)

userAgent (String!)

id (ID)

The ID of the agent auxiliary status.

status (String)

The current auxiliary status of the agent.

updatedAt (DateTime)

The timestamp when the status was last updated.

id (ID)

The ID of the agent call center status.

mostRecentCallId (Int)

The ID of the most recent call handled by the agent. If the agent status is BUSY then this will be the ID of the current call.

status (String)

The current status of the agent in the call center.

updatedAt (DateTime)

The timestamp when the status was last updated.

gspCoefficient (Float)

The price multiplier/coefficient used to calculate the unit rate.

peakOffset (Float)

The peak offset for the unit rate.

priceCap (Float)

The maximum value/cap for the unit rate.

id (ID!)

edgeCount (Int!)

Number of nodes in the edge.

edges ([AgreementEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.