API reference
Collections
Dates. Reasons. Next steps. Open the product
GET/v1/hardship-clockOpen ↗
Put a hardship matter on the statutory clock. Any of the query fields below; `notice` is the one without which there is no clock.
| Query | |
|---|---|
ref | File reference |
contract | The contract is a — one of credit_contract, consumer_lease |
notice | Hardship notice received — a day, YYYY-MM-DD |
noticeTo | …or by this day, if only the week is known — a day, YYYY-MM-DD |
channel | The notice arrived — one of phone, in_person, online_form, email, letter, sms, other |
represented | Acting for the borrower — one of financial_counsellor, other_representative, none |
reason | The borrower said the hardship was — one of overcommitment, reduced_income, unemployment, medical, separation, bereavement, business_downturn, parental_leave, abuse, natural_disaster, other |
identified | Recognised as a hardship notice on — a day, YYYY-MM-DD |
requested | Information asked for on — a day, YYYY-MM-DD |
stated | …the date stated in that notice — a day, YYYY-MM-DD |
received | Information received on — a day, YYYY-MM-DD |
decided | Decision notice given on — a day, YYYY-MM-DD |
outcome | …and it said — one of agreed, not_agreed |
declineReason | …and the reason recorded for not agreeing |
agreed | Agreement reached on — a day, YYYY-MM-DD |
deferral | …deferring obligations for, in days — a number |
assistance | …and the assistance given was — one of deferral, payment_arrangement, interest_only, term_extension, capitalisation_of_arrears, arrears_payment_arrangement, serviceability_period, interest_rate_reduction, supported_sale, other |
changed | Particulars of the change given on — a day, YYYY-MM-DD |
withdrawn | Notice withdrawn on — a day, YYYY-MM-DD |
complaint | Complaint received on — a day, YYYY-MM-DD |
answered | …answered in writing on — a day, YYYY-MM-DD |
defaulted | Default notice given on — a day, YYYY-MM-DD |
remedyBy | …the day it states for remedying the default — a day, YYYY-MM-DD |
postponed | Postponement request received on — a day, YYYY-MM-DD |
postponedAnswered | …answered in writing on — a day, YYYY-MM-DD |
earlier | Earlier hardship notices — days, YYYY-MM-DD, separated by commas |
amend | Amendments to a due date |
balance | Balance owing — a number |
rate | Contract rate — a number |
repayment | Contractual repayment — a number |
plan | The arrangement is a — one of deferral, reduced_payment |
months | For — a number |
pay | …paying, each month — a number |
asAt | Read the clock as at — a day, YYYY-MM-DD |
GET/v1/hardship-clock/provisionsOpen ↗
Every period this engine knows, with the provision it comes from, for a credit contract and for a consumer lease.