Skip to main content

Input fields

accountNumber : String! required

Account number of customer.

amountInPence : Int! required

Amount of additional support credit to add to the meter, in pence.

debtEffectiveDate : Date

The date on which the corresponding debt adjustment takes effect. If omitted, the default is used. Must be today or later, and no further in the future than the supplier allows; the validation error gives the limit.

deviceId : String! required

Electricity or gas meter device ID.

reason : String

Reason for adding additional support credit. Must not be blank; a validation error is returned if it is too long.

weeklyDebtRecoveryRateInPence : Int

The rate, in pence per week, at which this credit should be repaid. If omitted, a default will be used.

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-638F5CA1", "amountInPence": 18, "debtEffectiveDate": "1995-02-16", "deviceId": "16048753", "reason": "west-note-wide-community-make", "weeklyDebtRecoveryRateInPence": 2 }