The expected date when the agreement rollover will be executed.If not provided, will calculate it taking into account the valid to date of the agreement.

params : GenericScalar

A JSON object containing additional parameters for the agreement rollover. Ensure it's properly encoded.

renewProductCode : String!


            required

The product code for the new agreement.

rolloverDate : Date

If the agreement is open-ended, will terminate the agreement on this date.

suppressComms : Boolean

Suppress Agreement Rollover communications.

tags : [String]

List of comma-separated tags to be added to the rollover.

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

{
  "accountNumber": "A-2882EDCB",
  "currentAgreementId": "53667154",
  "expectedSendDate": "2004-08-20",
  "params": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
  "renewProductCode": "I-example-church-tax-specific",
  "rolloverDate": "2001-11-16",
  "suppressComms": true,
  "tags": "career-investment-entire-benefit-here"
}