updateAgreementPeriod
Update the period of an agreement.
Arguments
Input for updating the agreement period.
Possible Errors
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1501: Agreement not found.
- KT-CT-1503: Agreement valid_to date must be later than valid_from date.
- KT-CT-1504: Account does not match with the agreement.
- KT-CT-1505: Unable to edit agreement.
- KT-CT-1506: Agreement period is not within the supply and property period.
- KT-CT-4178: No account found with given account number.
- KT-CT-7899: An internal error occurred.
Allowed Viewers
Required Permissions
Can update agreeementsQuery 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.
mutation UpdateAgreementPeriod($input: UpdateAgreementPeriodInput!) {
updateAgreementPeriod(input: $input) {
account {
...AccountTypeFragment
}
}
}
Variables
{
"input": UpdateAgreementPeriodInput
}
Response
{
"data": {
"updateAgreementPeriod": {
"account": AccountType
}
}
}