Skip to main content

Input fields

agreedFromDate : Date

The date the agreement was agreed from (inclusive, if different to valid_from).

bespokePpsTariffRates : [BespokePPSTariffRatesInput]

Bespoke rates overriding those of the associated tariff, with payment method.

bespokeTariffRates : BespokeTariffRatesInput

Bespoke rates overriding those of the associated tariff.

commission : CommissionInput

Information on the commission that's associated with this agreement.

mpxn : String! required

MPxN to renew the agreement for.

tariffCode : String! required

Tariff code for the new agreement.

validFromDate : Date! required

The start date of the new agreement (inclusive).

validToDate : Date

The end date of the new agreement (exclusive).

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

{ "agreedFromDate": "1998-01-05", "bespokePpsTariffRates": BespokePPSTariffRatesInput, "bespokeTariffRates": BespokeTariffRatesInput, "commission": CommissionInput, "mpxn": "long-different-include-night-trade", "tariffCode": "truth-every-position-answer-author", "validFromDate": "1998-12-14", "validToDate": "2019-08-25" }