Skip to main content

Fields

accountType : WhdAccountType

Type of account receiving the discount. Either credit the account or payment via prepay cards.

credit : Int

Amount in pence that was credited to the account as a result of the discount.

qualifyingComponent : QualifyingComponentOptions

Which component criteria was chosen for the Warm Home Discount.

qualifyingCriteria : QualifyingCriteriaOptions

Which criteria was chosen for the Warm Home Discount.

taxYear : String

The tax year for which the credit was given.

yearEnding : Int! required
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

{ "accountType": "SMART_PREPAY", "credit": 23, "qualifyingComponent": "PERSONAL_INDEPENDENCE_PAYMENTS", "qualifyingCriteria": "SAVINGS_ELEMENT_OF_PENSION_CREDIT", "taxYear": "send-certain-join-my-point", "yearEnding": 90 }