productEnrolments

Get all of the enrolments for an account.

Arguments

accountNumber : String!


            required

The account to find all the enrolments for.

Returns

[ProductEnrolmentType]

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can access customer queries
OR Can manage product enrolment

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 ProductEnrolments($accountNumber: String!) {
  productEnrolments(accountNumber: $accountNumber) {
    account {
      ...AccountTypeFragment
    }
    electricityMeterPoint {
      ...ElectricityMeterPointTypeFragment
    }
    gasMeterPoint {
      ...GasMeterPointTypeFragment
    }
    id
    product {
      ...EnergyProductTypeFragment
    }
    stages {
      ...ProductEnrolmentStageTypeFragment
    }
    status
  }
}

{
  "accountNumber": "A-1D6254E3"
}

{
  "data": {
    "productEnrolments": [
      {
        "account": AccountType,
        "electricityMeterPoint": ElectricityMeterPointType,
        "gasMeterPoint": GasMeterPointType,
        "id": "82217178",
        "product": EnergyProductType,
        "stages": [ProductEnrolmentStageType],
        "status": "NOT_STARTED"
      }
    ]
  }
}