agreement

Get an agreement by its ID.

Arguments

id : ID!


            required

Agreement identifier.

Returns

AgreementType

Any kind of rate which can be charged or credited to a customer.

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) {
    activeProductRates {
      ...RatesTypeFragment
    }
    agreedAt
    autoTopUpAmountSelectedByUser
    earlyTerminationFee
    earlyTerminationFeeExpiration
    efls {
      ...EflTypeFragment
    }
    id
    isEligibleForRenewal
    isExportingGenerationReadings
    outageInformation {
      ...OutageMapOutputTypeFragment
    }
    product {
      ...ProductTypeFragment
    }
    quoteRequest {
      ...GetQuoteOutputTypeFragment
    }
    ratesAgreedAt
    seasonalRates {
      ...SeasonRatesTypeFragment
    }
    terminatedAt
    totalApplicableDayRate
    totalApplicableNightRate
    totalApplicableRate
    validFrom
    validTo
  }
}

{
  "id": "74477987"
}

{
  "data": {
    "agreement": {
      "activeProductRates": RatesType,
      "agreedAt": "1988-02-01T21:23:37.323763+00:00",
      "autoTopUpAmountSelectedByUser": 50,
      "earlyTerminationFee": "1.0",
      "earlyTerminationFeeExpiration": "2017-12-27",
      "efls": [EflType],
      "id": "48549405",
      "isEligibleForRenewal": true,
      "isExportingGenerationReadings": true,
      "outageInformation": OutageMapOutputType,
      "product": ProductType,
      "quoteRequest": GetQuoteOutputType,
      "ratesAgreedAt": "2022-01-01T06:07:13.690835+00:00",
      "seasonalRates": [SeasonRatesType],
      "terminatedAt": "1992-08-19T21:13:12.543422+00:00",
      "totalApplicableDayRate": "1.0",
      "totalApplicableNightRate": "1.0",
      "totalApplicableRate": "1.0",
      "validFrom": "2019-10-22T00:23:09.677722+00:00",
      "validTo": "2012-12-06T03:06:05.153956+00:00"
    }
  }
}