account
Get details about an account.
Arguments
Returns
AccountType
Can access customer queries
Can query accounts with account number
Can view detailed usage
Can query accounts with account number
Can view detailed usage
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
accountUserAccessors {
...AccountUserAccessorAccessConnectionTypeConnectionFragment
}
activeHardshipAgreements {
...HardshipAgreementTypeFragment
}
activeReferralSchemes {
...ReferralSchemeTypesFragment
}
address {
...RichAddressTypeFragment
}
agreements {
...AgreementFragment
}
annualStatements {
...AnnualStatementConnectionTypeConnectionFragment
}
applications {
...AccountApplicationConnectionTypeConnectionFragment
}
assistanceAgreements {
...AssistanceAgreementTypeFragment
}
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
}
canModifyPayments {
...CanModifyPaymentsTypeFragment
}
canRequestRefund
commsDeliveryPreference
complaints {
...ComplaintConnectionTypeConnectionFragment
}
consents {
...ConsentTypeFragment
}
contributionAgreements {
...ContributionAgreementTypeFragment
}
createdAt
customerAssets {
...CustomerAssetTypeFragment
}
debtCollectionProceedings {
...DebtCollectionProceedingTypeFragment
}
directDebitInstructions {
...DirectDebitInstructionConnectionTypeConnectionFragment
}
documentAccessibility
events {
...AccountEventConnectionTypeConnectionFragment
}
fileAttachments {
...AccountFileAttachmentFragment
}
id
isInHardship
ledgers {
...LedgerTypeFragment
}
marketSupplyAgreements {
...AgreementConnectionFragment
}
maximumRefund {
...MaximumRefundTypeFragment
}
medicalDependencyDetails {
...MedicalDependencyDetailsTypeFragment
}
metadata {
...MetadataFragment
}
notes {
...AccountNoteTypeFragment
}
number
overdueBalance
paginatedFileAttachments {
...AccountFileAttachmentConnectionTypeConnectionFragment
}
paginatedPaymentForecast {
...PaymentForecastConnectionTypeConnectionFragment
}
partnerAccessors {
...PartnerAccessorAccessConnectionTypeConnectionFragment
}
paymentMethods {
...PaymentInstructionConnectionTypeConnectionFragment
}
paymentPlans {
...PaymentPlanConnectionTypeConnectionFragment
}
payments {
...AccountPaymentConnectionTypeConnectionFragment
}
paymentSchedules {
...PaymentScheduleConnectionTypeConnectionFragment
}
portfolio {
...PortfolioTypeFragment
}
preferredLanguageForComms
properties {
...PropertyTypeFragment
}
property {
...PropertyTypeFragment
}
provisionalTransactions {
...ProvisionalTransactionConnectionTypeConnectionFragment
}
references {
...AccountReferenceTypeFragment
}
referrals {
...ReferralConnectionTypeConnectionFragment
}
referralsCreated
reminders {
...AccountReminderConnectionTypeConnectionFragment
}
repayments {
...AccountRepaymentConnectionTypeConnectionFragment
}
requestRefundEligibility {
...RequestRefundEligibilityTypeFragment
}
rewards {
...RewardTypeFragment
}
splitBillingAddress
status
transactions {
...TransactionConnectionTypeConnectionFragment
}
urls {
...AccountUrlTypeFragment
}
urn
users {
...AccountUserTypeFragment
}
}
}
Variables
{
"accountNumber": "A-75C46140"
}
Response
{
"data": {
"account": {
"accountType": "BUSINESS",
"accountUserAccessors": AccountUserAccessorAccessConnectionTypeConnection,
"activeHardshipAgreements": [HardshipAgreementType],
"activeReferralSchemes": ReferralSchemeTypes,
"address": RichAddressType,
"agreements": [Agreement],
"annualStatements": AnnualStatementConnectionTypeConnection,
"applications": AccountApplicationConnectionTypeConnection,
"assistanceAgreements": [AssistanceAgreementType],
"balance": 92,
"bill": BillInterface,
"billingAddress": "may-whose-medical-travel-couple",
"billingAddressLine1": "exist-wind-material-wait-hotel",
"billingAddressLine2": "table-lose-season-identify-professor",
"billingAddressLine3": "happen-third-simply-scene-beat",
"billingAddressLine4": "professional-blue-clear-style-have",
"billingAddressLine5": "run-light-final-summer-pass",
"billingAddressPostcode": "official-positive-collection-dinner-activity",
"billingCountryCode": "current-turn-nature-identify-gas",
"billingDeliveryPointIdentifier": "87550306",
"billingEmail": "government-travel-process-participant-role",
"billingName": "himself-tax-west-voice-mention",
"billingOptions": BillingOptionsType,
"billingSubName": "can-since-day-wear-loss",
"billingTriggerConfiguration": BillingTriggerConfiguration,
"bills": BillConnectionTypeConnection,
"brand": "half-never-wait-including-spend",
"business": BusinessType,
"campaigns": [AccountCampaignType],
"canModifyPayments": CanModifyPaymentsType,
"canRequestRefund": true,
"commsDeliveryPreference": "EMAIL",
"complaints": ComplaintConnectionTypeConnection,
"consents": [ConsentType],
"contributionAgreements": [ContributionAgreementType],
"createdAt": "1993-06-27T02:30:07.696543+00:00",
"customerAssets": [CustomerAssetType],
"debtCollectionProceedings": [DebtCollectionProceedingType],
"directDebitInstructions": DirectDebitInstructionConnectionTypeConnection,
"documentAccessibility": "LARGE_PRINT",
"events": AccountEventConnectionTypeConnection,
"fileAttachments": [AccountFileAttachment],
"id": "10212701",
"isInHardship": true,
"ledgers": [LedgerType],
"marketSupplyAgreements": AgreementConnection,
"maximumRefund": MaximumRefundType,
"medicalDependencyDetails": MedicalDependencyDetailsType,
"metadata": [Metadata],
"notes": [AccountNoteType],
"number": "Mrs-perhaps-partner-leader-agreement",
"overdueBalance": 30,
"paginatedFileAttachments": AccountFileAttachmentConnectionTypeConnection,
"paginatedPaymentForecast": PaymentForecastConnectionTypeConnection,
"partnerAccessors": PartnerAccessorAccessConnectionTypeConnection,
"paymentMethods": PaymentInstructionConnectionTypeConnection,
"paymentPlans": PaymentPlanConnectionTypeConnection,
"payments": AccountPaymentConnectionTypeConnection,
"paymentSchedules": PaymentScheduleConnectionTypeConnection,
"portfolio": PortfolioType,
"preferredLanguageForComms": "play-nearly-Congress-before-necessary",
"properties": [PropertyType],
"property": PropertyType,
"provisionalTransactions": ProvisionalTransactionConnectionTypeConnection,
"references": [AccountReferenceType],
"referrals": ReferralConnectionTypeConnection,
"referralsCreated": 33,
"reminders": AccountReminderConnectionTypeConnection,
"repayments": AccountRepaymentConnectionTypeConnection,
"requestRefundEligibility": RequestRefundEligibilityType,
"rewards": [RewardType],
"splitBillingAddress": "allow-want-audience-test-laugh",
"status": "PENDING",
"transactions": TransactionConnectionTypeConnection,
"urls": AccountUrlType,
"urn": "senior-example-environmental-something-continue",
"users": [AccountUserType]
}
}
}