agreementsForRollover
Get agreements eligible for the rollover process.
Arguments
Returns
[CommonAgreementType]
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
}
}
Variables
{
"daysBeforeExpiration": 87,
"windowSize": 71
}
Response
{
"data": {
"agreementsForRollover": [
{
"account": AccountType,
"agreedAt": "2017-08-15T13:23:46.852847+00:00",
"agreedFrom": "2012-04-07T18:13:26.879969+00:00",
"agreedTo": "2009-01-22T23:30:23.707485+00:00",
"characteristicValues": CharacteristicValueInterface,
"id": "33911541",
"isActive": true,
"isRevoked": true,
"params": {"key": "value"},
"product": SupplyProductType,
"ratesAgreedAt": "1986-12-07T11:08:02.464856+00:00",
"rescissionDeadlineAt": "2000-06-12T03:15:01.543579+00:00",
"supplyPoint": SupplyPointType,
"terminatedAt": "1972-10-01T15:05:55.089174+00:00",
"validFrom": "2018-10-31T21:31:36.811883+00:00",
"validTo": "1984-01-04T07:19:53.627122+00:00"
}
]
}
}