agreement

Get an agreement by id.

Arguments

id : ID!


            required

The agreement id.

Returns

Agreement

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can access customer queries
OR 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) {
    account {
      ...AccountTypeFragment
    }
    description
    displayName
    id
    isActive
    isRevoked
    isTerminated
    meterPoint {
      ...MeterPointFragment
    }
    product {
      ...SupplyProductTypeFragment
    }
    rates {
      ...RateFragment
    }
    ruralPartner
    ruralPartnerMemberId
    timeOfUseScheme {
      ...TimeOfUseBucketFragment
    }
    timeOfUseSchemes {
      ...TimeOfUseSchemeTypeFragment
    }
    validFrom
    validTo
  }
}

{
  "id": "33020634"
}

{
  "data": {
    "agreement": {
      "account": AccountType,
      "description": "still-thank-sister-performance-also",
      "displayName": "customer-between-of-to-option",
      "id": "76082199",
      "isActive": true,
      "isRevoked": true,
      "isTerminated": true,
      "meterPoint": MeterPoint,
      "product": SupplyProductType,
      "rates": [Rate],
      "ruralPartner": "FARMLANDS",
      "ruralPartnerMemberId": "24015581",
      "timeOfUseScheme": [TimeOfUseBucket],
      "timeOfUseSchemes": [TimeOfUseSchemeType],
      "validFrom": "2023-02-26",
      "validTo": "1992-02-08"
    }
  }
}