agreement

Get an agreement by its ID.

Arguments

id : ID!


            required

Agreement identifier.

Returns

CommonAgreementType

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) {
    account {
      ...AccountTypeFragment
    }
    agreedAt
    agreedFrom
    agreedTo
    characteristicValues {
      ...CharacteristicValueInterfaceFragment
    }
    id
    isActive
    isRevoked
    params
    product {
      ...SupplyProductTypeFragment
    }
    ratesAgreedAt
    rescissionDeadlineAt
    supplyPoint {
      ...SupplyPointTypeFragment
    }
    terminatedAt
    validFrom
    validTo
  }
}

{
  "id": "40374225"
}

{
  "data": {
    "agreement": {
      "account": AccountType,
      "agreedAt": "1983-04-25T07:05:16.647185+00:00",
      "agreedFrom": "1998-02-24T09:24:16.047683+00:00",
      "agreedTo": "1997-09-07T04:24:11.348519+00:00",
      "characteristicValues": CharacteristicValueInterface,
      "id": "97427101",
      "isActive": true,
      "isRevoked": true,
      "params": {"key": "value"},
      "product": SupplyProductType,
      "ratesAgreedAt": "1975-02-01T00:46:24.721752+00:00",
      "rescissionDeadlineAt": "2000-03-08T23:19:55.816942+00:00",
      "supplyPoint": SupplyPointType,
      "terminatedAt": "2001-12-29T08:27:17.672026+00:00",
      "validFrom": "1978-02-01T18:18:51.264634+00:00",
      "validTo": "1990-06-03T16:17:38.692784+00:00"
    }
  }
}