properties

Properties linked to the account now and in the future.

Arguments

accountNumber : String!


            required

activeFrom : DateTime

Returns properties that have an effective period that ends at or after the given activeFrom datetime.

Returns

[PropertyType]

Represents a property. Conceptually, it collects supply points under an address.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can access customer queries

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 Properties(
  $accountNumber: String!,
  $activeFrom: DateTime
) {
  properties(
    accountNumber: $accountNumber,
    activeFrom: $activeFrom
  ) {
    address
    addressLine1
    addressLine2
    addressLine3
    addressLine4
    addressLine5
    ancestors {
      ...PropertyConnectionFragment
    }
    coordinates {
      ...CoordinatesTypeFragment
    }
    descendants {
      ...PropertyConnectionFragment
    }
    embeddedNetwork {
      ...EmbeddedNetworkTypeFragment
    }
    id
    label
    measurements {
      ...MeasurementConnectionFragment
    }
    meterPoints {
      ...ElectricityMeterPointTypeFragment
    }
    occupancyPeriods {
      ...OccupancyPeriodTypeFragment
    }
    parent {
      ...PropertyInterfaceFragment
    }
    postcode
    richAddress {
      ...PropertyRichAddressTypeFragment
    }
    splitAddress
  }
}

{
  "accountNumber": "A-4FE0BDE9",
  "activeFrom": "2014-06-30T06:05:18.699144+00:00"
}

{
  "data": {
    "properties": [
      {
        "address": "arm-second-him-radio-opportunity",
        "addressLine1": "can-Mrs-avoid-drop-high",
        "addressLine2": "experience-product-would-ground-stuff",
        "addressLine3": "different-remember-girl-movement-become",
        "addressLine4": "still-decade-less-face-special",
        "addressLine5": "or-past-senior-effort-around",
        "ancestors": PropertyConnection,
        "coordinates": CoordinatesType,
        "descendants": PropertyConnection,
        "embeddedNetwork": EmbeddedNetworkType,
        "id": "52359806",
        "label": "civil-car-type-state-both",
        "measurements": MeasurementConnection,
        "meterPoints": [ElectricityMeterPointType],
        "occupancyPeriods": [OccupancyPeriodType],
        "parent": PropertyInterface,
        "postcode": "itself-only-seat-mean-however",
        "richAddress": PropertyRichAddressType,
        "splitAddress": "treatment-worry-defense-water-produce"
      }
    ]
  }
}