affiliateOrganisation

Return the details of a given affiliate organization, if any exists. A partner user viewer may only query the organisation they belong to.

Arguments

id : Int

The affiliate organisation ID.

number : String

The affiliate organisation number.

Returns

AffiliateOrganisationType

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can query affiliate organisations

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 AffiliateOrganisation(
  $id: Int,
  $number: String
) {
  affiliateOrganisation(
    id: $id,
    number: $number
  ) {
    accessibleAccounts {
      ...EntityAccessConnectionTypeConnectionFragment
    }
    accessibleBusinesses {
      ...EntityAccessConnectionTypeConnectionFragment
    }
    allowAlternativePaymentMethods
    canRegisterBusinessMeterPoints
    canRegisterCustomersWithoutEmailAddress
    canRegisterPortfolioAccounts
    canRenewTariffs
    canUseIvrSupportApi
    contactEmail
    defaultAccountType
    id
    isFieldSalesOnlyProduct
    name
    number
    references {
      ...OrganisationReferenceTypeFragment
    }
    salesChannelCode
    skipMeterPointAddressValidation
  }
}

{
  "id": 70337867,
  "number": "go-much-fund-room-number"
}

{
  "data": {
    "affiliateOrganisation": {
      "accessibleAccounts": EntityAccessConnectionTypeConnection,
      "accessibleBusinesses": EntityAccessConnectionTypeConnection,
      "allowAlternativePaymentMethods": true,
      "canRegisterBusinessMeterPoints": true,
      "canRegisterCustomersWithoutEmailAddress": true,
      "canRegisterPortfolioAccounts": true,
      "canRenewTariffs": true,
      "canUseIvrSupportApi": true,
      "contactEmail": "both-truth-him-news-yes",
      "defaultAccountType": "BUSINESS",
      "id": "95299789",
      "isFieldSalesOnlyProduct": true,
      "name": "our-think-stop-memory-would",
      "number": "left-strong-important-seat-would",
      "references": [OrganisationReferenceType],
      "salesChannelCode": "figure-color-per-most-grow",
      "skipMeterPointAddressValidation": true
    }
  }
}