Fields

accessibleAccounts : EntityAccessConnectionTypeConnection

Accounts this partner can access, with the roles granting that access.
Arguments
after : String
before : String
first : Int
last : Int
offset : Int
scope : AccessScope default: ALL

Whether to return only directly assigned accounts (DIRECT) or all accessible accounts including inherited access (ALL, default).
accessibleBusinesses : EntityAccessConnectionTypeConnection

Businesses this partner can access, with the roles granting that access.
Arguments
after : String
before : String
first : Int
last : Int
offset : Int
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! required

The primary contact email for the organisation.
defaultAccountType : AccountTypeChoices

Default Account Type.
id : ID! required

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! required

The name of the affiliate organisation.
number : String! required

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.
Deprecation
The 'salesChannel' field is deprecated.

Please use salesChannelCode instead.

- Marked as deprecated on 2025-07-17.
- Scheduled for removal on or after 2025-10-17.
salesChannelCode : String

Sales Channel Code.
skipMeterPointAddressValidation : Boolean

Allow this partner to skip validation that ensures all meter points belong to the same address.
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

{ "accessibleAccounts": EntityAccessConnectionTypeConnection, "accessibleBusinesses": EntityAccessConnectionTypeConnection, "allowAlternativePaymentMethods": true, "canRegisterBusinessMeterPoints": true, "canRegisterCustomersWithoutEmailAddress": true, "canRegisterPortfolioAccounts": true, "canRenewTariffs": true, "canUseIvrSupportApi": true, "contactEmail": "less-somebody-head-see-loss", "defaultAccountType": "BUSINESS", "id": "55169809", "isFieldSalesOnlyProduct": true, "name": "home-sound-low-certain-challenge", "number": "yet-sport-happy-camera-skill", "references": [OrganisationReferenceType], "salesChannelCode": "wear-include-voice-expert-inside", "skipMeterPointAddressValidation": true }