agreement
Get an agreement by its ID.
Arguments
Agreement identifier.
Returns
CommonAgreementTypePossible Errors
Allowed Viewers
Required Permissions
Can query agreementsQuery Complexity
1Examples
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
}
}
Variables
{
"id": "21006965"
}
Response
{
"data": {
"agreement": {
"account": AccountType,
"agreedAt": "1995-03-08T19:45:36.362333+00:00",
"agreedFrom": "2022-04-20T05:49:21.793540+00:00",
"agreedTo": "2024-12-14T11:56:31.655792+00:00",
"characteristicValues": CharacteristicValueInterface,
"id": "61318592",
"isActive": true,
"isRevoked": true,
"params": {"key": "value"},
"product": SupplyProductType,
"ratesAgreedAt": "2023-03-10T11:40:06.692617+00:00",
"rescissionDeadlineAt": "2021-02-12T16:28:37.517364+00:00",
"supplyPoint": SupplyPointType,
"terminatedAt": "1992-06-23T13:48:17.287643+00:00",
"validFrom": "2021-06-30T06:56:37.650307+00:00",
"validTo": "1994-10-16T14:36:32.757376+00:00"
}
}
}