agreement

Get an agreement by id.

Arguments

id : ID!


            required

The agreement id.

Returns

Agreement

An agreement for a supply point.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can query agreements

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 Agreement($id: ID!) {
  agreement(id: $id) {
    agreedAt
    agreedFrom
    agreedTo
    electricitySupplyPoint {
      ...ElectricitySupplyPointTypeFragment
    }
    id
    isActive
    isRevoked
    isRollover
    market
    product {
      ...ProductInterfaceFragment
    }
    ratesAgreedAt
    rescissionDeadlineAt
    supplyPoint {
      ... on ElectricitySupplyPointType {
        ...ElectricitySupplyPointTypeFragment
      }
      ... on GasSupplyPointType {
        ...GasSupplyPointTypeFragment
      }
    }
    terminatedAt
    validFrom
    validTo
  }
}

{
  "id": "39118961"
}

{
  "data": {
    "agreement": {
      "agreedAt": "1989-03-11T07:00:46.190692+00:00",
      "agreedFrom": "1995-09-10T14:55:38.084973+00:00",
      "agreedTo": "2026-03-24T05:42:18.308044+00:00",
      "electricitySupplyPoint": ElectricitySupplyPointType,
      "id": 61171971,
      "isActive": true,
      "isRevoked": true,
      "isRollover": true,
      "market": "ELECTRICITY",
      "product": ProductInterface,
      "ratesAgreedAt": "1986-11-17T20:21:02.543631+00:00",
      "rescissionDeadlineAt": "2022-03-18T09:16:25.669402+00:00",
      "supplyPoint": ElectricitySupplyPointType,
      "terminatedAt": "2026-05-09T22:57:25.635134+00:00",
      "validFrom": "1999-06-14T07:45:55.104443+00:00",
      "validTo": "2012-11-19T14:19:08.758743+00:00"
    }
  }
}