CommonAgreementType
Fields
The account associated with the agreement.
The datetime the agreement was entered.
The datetime the agreement was terminated.
The characteristic values associated with the agreement.
Arguments
The datetime to check the characteristic value at.
Whether the agreement is currently active.
Whether the agreement is revoked.
General parameters providing additional information about the agreement.
The product associated with the agreement.
The deadline until which the customer is allowed to rescind this agreement. If it is null, rescission is not permitted.
The agreement's supply point.
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.
Example
{
"account": AccountType,
"agreedAt": "1992-06-19T22:48:45.958999+00:00",
"agreedFrom": "1998-05-06T17:40:48.212912+00:00",
"agreedTo": "2020-04-24T06:45:53.198286+00:00",
"characteristicValues": CharacteristicValueInterface,
"id": "84740053",
"isActive": true,
"isRevoked": true,
"params": {"key": "value"},
"product": SupplyProductType,
"ratesAgreedAt": "1982-10-18T08:55:22.681366+00:00",
"rescissionDeadlineAt": "1993-01-21T09:57:56.371169+00:00",
"supplyPoint": SupplyPointType,
"terminatedAt": "1995-05-07T21:48:23.693544+00:00",
"validFrom": "2010-07-29T04:34:08.790559+00:00",
"validTo": "1991-12-17T16:59:40.167265+00:00"
}