icpAgreement

Get an agreement by ICP.

Arguments

asAtDate : Date

Agreement active on Date.

icpNumber : String!


            required

The ICP number to get the agreement.

Returns

Agreement

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can query meter point

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 IcpAgreement(
  $asAtDate: Date,
  $icpNumber: String!
) {
  icpAgreement(
    asAtDate: $asAtDate,
    icpNumber: $icpNumber
  ) {
    account {
      ...AccountTypeFragment
    }
    description
    displayName
    id
    isActive
    isRevoked
    isTerminated
    meterPoint {
      ...MeterPointFragment
    }
    product {
      ...SupplyProductTypeFragment
    }
    rates {
      ...RateFragment
    }
    ruralPartner
    ruralPartnerMemberId
    timeOfUseScheme {
      ...TimeOfUseBucketFragment
    }
    timeOfUseSchemes {
      ...TimeOfUseSchemeTypeFragment
    }
    validFrom
    validTo
  }
}

{
  "asAtDate": "1985-05-09",
  "icpNumber": "worker-training-pressure-soon-standard"
}

{
  "data": {
    "icpAgreement": {
      "account": AccountType,
      "description": "early-space-dream-none-group",
      "displayName": "city-since-trouble-finish-they",
      "id": "56473706",
      "isActive": true,
      "isRevoked": true,
      "isTerminated": true,
      "meterPoint": MeterPoint,
      "product": SupplyProductType,
      "rates": [Rate],
      "ruralPartner": "FARMLANDS",
      "ruralPartnerMemberId": "44022960",
      "timeOfUseScheme": [TimeOfUseBucket],
      "timeOfUseSchemes": [TimeOfUseSchemeType],
      "validFrom": "2007-04-07",
      "validTo": "2026-06-07"
    }
  }
}