Skip to main content

Fields

currentBalance : Int

How much balance we expect the account to have at this time of year.

estimatedConsumption : [ConsumptionBreakdown]

Breakdown of customer's usage per source and per month.

recommendedPayment : PaymentBreakdown

The suggested monthly payment amount in pence following the payment adequacy review.

reviewedOn : Date

The date that we used to calculate the review of the account.

targetBalance : Int

How much balance we expect the account to have at this time of year.

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

{ "currentBalance": 100, "estimatedConsumption": [ConsumptionBreakdown], "recommendedPayment": PaymentBreakdown, "reviewedOn": "2001-10-06", "targetBalance": 55 }