createShellAccount
Create a shell account (a billable account with no property/energy supply).
Arguments
Input fields for creating a shell account.
Returns
CreateShellAccountPayloadCreate a shell account (a billable account with no property/energy supply).
Possible Errors
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-4120: Invalid urn.
- KT-CT-4125: Unauthorized.
- KT-CT-4131: Invalid brand.
- KT-CT-4132: Period length must be MONTHLY, QUARTERLY or not set.
- KT-CT-4133: Period day must be set if period is MONTHLY.
- KT-CT-4134: Period day must be set if period is QUARTERLY.
- KT-CT-4135: Period month must be set if period is QUARTERLY.
- KT-CT-4138: Period day must be set if period multiplier > 1.
- KT-CT-4139: Period month must be set if period multiplier > 1.
- KT-CT-4141: Quarterly billing periods can't have period multiplier > 1.
- KT-CT-4142: Missing business details info.
- KT-CT-4143: Invalid companyName.
- KT-CT-4144: Invalid companyNumber.
- KT-CT-4177: Unauthorized.
- KT-CT-7899: An internal error occurred.
- KT-CT-9403: Received an invalid portfolioId.
- KT-CT-9405: User not associated to portfolio.
- KT-CT-9406: Multiple users are associated with the portfolio.
- KT-CT-9411: Brand does not match the portfolio's brand.
Allowed Viewers
Customer
Partner User
Third party
Required Permissions
Can create shell accountsQuery Complexity
6Examples
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.
mutation CreateShellAccount($input: CreateShellAccountInput!) {
createShellAccount(input: $input) {
account {
...AccountInterfaceFragment
}
billingAddressLine1
billingAddressLine2
billingAddressLine3
billingAddressLine4
billingAddressLine5
billingName
billingPeriodDay
billingPeriodLength
billingPeriodMonth
billingPeriodMultiplier
billingPostcode
billingRichAddress
brand
businessType
clientMutationId
companyName
companyNumber
dateOfBirth
email
errors {
...ErrorTypeFragment
}
familyName
givenName
isBusinessAccount
landline
mobile
password
passwordUpdateToken
portfolioNumber
taxNumber
urn
}
}
Variables
{
"input": CreateShellAccountInput
}
Response
{
"data": {
"createShellAccount": {
"account": AccountInterface,
"billingAddressLine1": "learn-help-maybe-spring-truth",
"billingAddressLine2": "child-modern-black-effort-less",
"billingAddressLine3": "specific-relate-society-direction-receive",
"billingAddressLine4": "yard-name-economic-institution-city",
"billingAddressLine5": "condition-production-away-movie-newspaper",
"billingName": "claim-heart-again-describe-dog",
"billingPeriodDay": 6,
"billingPeriodLength": "very-right-record-real-president",
"billingPeriodMonth": 69,
"billingPeriodMultiplier": 10,
"billingPostcode": "easy-single-budget-popular-hit",
"billingRichAddress": "nice-political-look-within-dream",
"brand": "activity-western-find-everything-indeed",
"businessType": "organization-worry-remain-five-movement",
"clientMutationId": "70221547",
"companyName": "yeah-sort-network-recognize-recognize",
"companyNumber": "space-many-everything-up-else",
"dateOfBirth": "1985-10-26",
"email": "compare-return-base-guess-up",
"errors": [ErrorType],
"familyName": "Green",
"givenName": "Johnny",
"isBusinessAccount": true,
"landline": "his-not-add-west-where",
"mobile": "difficult-audience-often-peace-myself",
"password": "respond-dream-cause-leave-represent",
"passwordUpdateToken": "bar-various-check-project-air",
"portfolioNumber": "P-70219E93",
"taxNumber": "if-individual-case-others-pull",
"urn": "national-until-sure-cause-dark"
}
}
}