agreementsForRollover

Get agreements eligible for the rollover process.

Arguments

daysBeforeExpiration : Int!


            required

Days before the agreement expiration.

windowSize : Int!


            required

Window size in days.

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 AgreementsForRollover(
  $daysBeforeExpiration: Int!,
  $windowSize: Int!
) {
  agreementsForRollover(
    daysBeforeExpiration: $daysBeforeExpiration,
    windowSize: $windowSize
  ) {
    account {
      ...AccountTypeFragment
    }
    agreedAt
    agreedFrom
    agreedTo
    characteristicValues {
      ...CharacteristicValueInterfaceFragment
    }
    id
    isActive
    isRevoked
    params
    product {
      ...SupplyProductTypeFragment
    }
    ratesAgreedAt
    rescissionDeadlineAt
    supplyPoint {
      ...SupplyPointTypeFragment
    }
    terminatedAt
    validFrom
    validTo
  }
}

{
  "daysBeforeExpiration": 56,
  "windowSize": 77
}

{
  "data": {
    "agreementsForRollover": [
      {
        "account": AccountType,
        "agreedAt": "2000-03-21T02:09:43.095641+00:00",
        "agreedFrom": "2021-06-14T01:18:59.076000+00:00",
        "agreedTo": "2007-05-17T11:42:45.146606+00:00",
        "characteristicValues": CharacteristicValueInterface,
        "id": "47268563",
        "isActive": true,
        "isRevoked": true,
        "params": {"key": "value"},
        "product": SupplyProductType,
        "ratesAgreedAt": "1984-01-17T18:54:20.669431+00:00",
        "rescissionDeadlineAt": "2012-05-31T04:50:49.853371+00:00",
        "supplyPoint": SupplyPointType,
        "terminatedAt": "1970-03-24T20:26:07.661728+00:00",
        "validFrom": "1980-09-28T07:40:49.002142+00:00",
        "validTo": "1994-10-29T22:42:37.418781+00:00"
      }
    ]
  }
}