account

Get details about an account.

Arguments

accountNumber : String!


            required

Returns

Account

The account object can be one of several attached to a Portfolio (which usually has an AccountUser which is used to authenticate access to the Portfolio's accounts). Typically a person has a single account attached to a portfolio and properties on the same account will appear on the same bill. Where separate bills are desired, multiple accounts are created and added to the same portfolio of accounts.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can access customer queries
OR Can query accounts with account number
OR Can view detailed usage

Query Complexity

Examples

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.

query Account($accountNumber: String!) {
  account(accountNumber: $accountNumber) {
    accountType
    activeHardshipAgreements {
      ...HardshipAgreementTypeFragment
    }
    activeReferralSchemes {
      ...ReferralSchemeTypesFragment
    }
    address {
      ...RichAddressTypeFragment
    }
    annualStatements {
      ...AnnualStatementConnectionTypeConnectionFragment
    }
    applications {
      ...AccountApplicationConnectionTypeConnectionFragment
    }
    assistanceAgreements {
      ...AssistanceAgreementTypeFragment
    }
    availableDemandResponseCampaignsForRegistration
    balance
    bill {
      ...BillInterfaceFragment
    }
    billingAddress
    billingAddressLine1
    billingAddressLine2
    billingAddressLine3
    billingAddressLine4
    billingAddressLine5
    billingAddressPostcode
    billingCountryCode
    billingDeliveryPointIdentifier
    billingEmail
    billingName
    billingOptions {
      ...BillingOptionsTypeFragment
    }
    billingSubName
    billingTriggerConfiguration {
      ...BillingTriggerConfigurationFragment
    }
    bills {
      ...BillConnectionTypeConnectionFragment
    }
    brand
    business {
      ...BusinessTypeFragment
    }
    campaigns {
      ...AccountCampaignTypeFragment
    }
    canBeWithdrawn
    canModifyPayments {
      ...CanModifyPaymentsTypeFragment
    }
    canRequestRefund
    commsDeliveryPreference
    complaints {
      ...ComplaintConnectionTypeConnectionFragment
    }
    consentData
    consents {
      ...ConsentTypeFragment
    }
    contributionAgreements {
      ...ContributionAgreementTypeFragment
    }
    createdAt
    customerAssets {
      ...CustomerAssetTypeFragment
    }
    debtCollectionProceedings {
      ...DebtCollectionProceedingTypeFragment
    }
    demandResponseCampaignParticipants {
      ...DemandResponseCampaignParticipantTypeFragment
    }
    directDebitInstructions {
      ...DirectDebitInstructionConnectionTypeConnectionFragment
    }
    documentAccessibility
    events {
      ...AccountEventConnectionTypeConnectionFragment
    }
    fileAttachments {
      ...AccountFileAttachmentFragment
    }
    hasActiveAgreement
    hasFutureAgreement
    id
    isInHardship
    ledgers {
      ...LedgerTypeFragment
    }
    lifelineAgencyApplication {
      ...LifelineAgencyApplicationFragment
    }
    marketSupplyAgreements {
      ...AgreementConnectionFragment
    }
    maximumRefund {
      ...MaximumRefundTypeFragment
    }
    metadata {
      ...MetadataFragment
    }
    notes {
      ...AccountNoteTypeFragment
    }
    number
    overdueBalance
    paginatedFileAttachments {
      ...AccountFileAttachmentConnectionTypeConnectionFragment
    }
    paginatedPaymentForecast {
      ...PaymentForecastConnectionTypeConnectionFragment
    }
    paymentInstructions {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    paymentPlans {
      ...PaymentPlanConnectionTypeConnectionFragment
    }
    paymentPreferences {
      ...PaymentPreferenceConnectionTypeConnectionFragment
    }
    payments {
      ...AccountPaymentConnectionTypeConnectionFragment
    }
    paymentSchedule {
      ...PaymentScheduleTypeFragment
    }
    paymentSchedules {
      ...PaymentScheduleConnectionTypeConnectionFragment
    }
    portfolio {
      ...PortfolioTypeFragment
    }
    preferredLanguageForComms
    properties {
      ...PropertyFragment
    }
    provisionalTransactions {
      ...ProvisionalTransactionConnectionTypeConnectionFragment
    }
    references {
      ...AccountReferenceTypeFragment
    }
    referrals {
      ...ReferralConnectionTypeConnectionFragment
    }
    referralsCreated
    reminders {
      ...AccountReminderConnectionTypeConnectionFragment
    }
    repayments {
      ...AccountRepaymentConnectionTypeConnectionFragment
    }
    requestRefundEligibility {
      ...RequestRefundEligibilityTypeFragment
    }
    rewards {
      ...RewardTypeFragment
    }
    splitBillingAddress
    status
    transactions {
      ...TransactionConnectionTypeConnectionFragment
    }
    urn
    users {
      ...AccountUserFragment
    }
  }
}

{
  "accountNumber": "A-B08B4FCE"
}

{
  "data": {
    "account": {
      "accountType": "BUSINESS",
      "activeHardshipAgreements": [HardshipAgreementType],
      "activeReferralSchemes": ReferralSchemeTypes,
      "address": RichAddressType,
      "annualStatements": AnnualStatementConnectionTypeConnection,
      "applications": AccountApplicationConnectionTypeConnection,
      "assistanceAgreements": [AssistanceAgreementType],
      "availableDemandResponseCampaignsForRegistration": "nearly-PM-old-machine-plant",
      "balance": 70,
      "bill": BillInterface,
      "billingAddress": "land-matter-special-about-claim",
      "billingAddressLine1": "foot-degree-to-challenge-blue",
      "billingAddressLine2": "fish-meet-start-yet-system",
      "billingAddressLine3": "participant-also-as-piece-star",
      "billingAddressLine4": "enter-wide-nearly-off-peace",
      "billingAddressLine5": "avoid-color-view-environment-bar",
      "billingAddressPostcode": "executive-risk-enjoy-decision-everyone",
      "billingCountryCode": "lose-scene-feeling-them-wish",
      "billingDeliveryPointIdentifier": "82969658",
      "billingEmail": "avoid-firm-understand-teacher-card",
      "billingName": "kind-hair-section-agreement-firm",
      "billingOptions": BillingOptionsType,
      "billingSubName": "seek-thought-American-open-professional",
      "billingTriggerConfiguration": BillingTriggerConfiguration,
      "bills": BillConnectionTypeConnection,
      "brand": "their-interesting-win-culture-boy",
      "business": BusinessType,
      "campaigns": [AccountCampaignType],
      "canBeWithdrawn": true,
      "canModifyPayments": CanModifyPaymentsType,
      "canRequestRefund": true,
      "commsDeliveryPreference": "EMAIL",
      "complaints": ComplaintConnectionTypeConnection,
      "consentData": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
      "consents": [ConsentType],
      "contributionAgreements": [ContributionAgreementType],
      "createdAt": "1977-05-12T00:48:49.566848+00:00",
      "customerAssets": [CustomerAssetType],
      "debtCollectionProceedings": [DebtCollectionProceedingType],
      "demandResponseCampaignParticipants": [DemandResponseCampaignParticipantType],
      "directDebitInstructions": DirectDebitInstructionConnectionTypeConnection,
      "documentAccessibility": "LARGE_PRINT",
      "events": AccountEventConnectionTypeConnection,
      "fileAttachments": [AccountFileAttachment],
      "hasActiveAgreement": true,
      "hasFutureAgreement": true,
      "id": "88748732",
      "isInHardship": true,
      "ledgers": [LedgerType],
      "lifelineAgencyApplication": LifelineAgencyApplication,
      "marketSupplyAgreements": AgreementConnection,
      "maximumRefund": MaximumRefundType,
      "metadata": [Metadata],
      "notes": [AccountNoteType],
      "number": "media-return-learn-sit-guess",
      "overdueBalance": 59,
      "paginatedFileAttachments": AccountFileAttachmentConnectionTypeConnection,
      "paginatedPaymentForecast": PaymentForecastConnectionTypeConnection,
      "paymentInstructions": PaymentInstructionConnectionTypeConnection,
      "paymentMethods": PaymentInstructionConnectionTypeConnection,
      "paymentPlans": PaymentPlanConnectionTypeConnection,
      "paymentPreferences": PaymentPreferenceConnectionTypeConnection,
      "payments": AccountPaymentConnectionTypeConnection,
      "paymentSchedule": PaymentScheduleType,
      "paymentSchedules": PaymentScheduleConnectionTypeConnection,
      "portfolio": PortfolioType,
      "preferredLanguageForComms": "friend-who-rich-detail-usually",
      "properties": [Property],
      "provisionalTransactions": ProvisionalTransactionConnectionTypeConnection,
      "references": [AccountReferenceType],
      "referrals": ReferralConnectionTypeConnection,
      "referralsCreated": 2,
      "reminders": AccountReminderConnectionTypeConnection,
      "repayments": AccountRepaymentConnectionTypeConnection,
      "requestRefundEligibility": RequestRefundEligibilityType,
      "rewards": [RewardType],
      "splitBillingAddress": "add-major-clearly-together-always",
      "status": "PENDING",
      "transactions": TransactionConnectionTypeConnection,
      "urn": "discover-thought-modern-community-watch",
      "users": [AccountUser]
    }
  }
}