MaxLoanCalculatorRequest

Inputs for the Max Loan Calculator — a stateless serviceability calculation that estimates how much each major NZ bank (ANZ, ASB, BNZ, Kiwibank, Westpac) could lend, based on the applicants' income, existing liabilities and living expenses. Not tied to any client or application; nothing is stored. All amounts are sent as strings (NZD).

Required: applicants, dependants, app1AnnualGrossIncome and proposedLoanTerm. app2AnnualGrossIncome is also required when applicants = "2". All other fields are optional.

Living expenses: by default (useBankBenchmark = "Y") the bank's own benchmark living-expense figure is used and the individual expense fields below (rentBoard … clothingPersonalCare) are ignored. Set useBankBenchmark = "N" to have the calculator use the declared expense fields instead. Income, liability and loan-term fields are always used.

  • app1AnnualGrossIncome
    Type: string
    required

    Required. Applicant 1's gross (before-tax) income per year, in NZD.

  • applicants
    Type: string
    required

    Required. Number of loan applicants. Allowed values: '1' or '2'.

  • dependants
    Type: string
    required

    Required. Number of financial dependants (e.g. children). Allowed values: '0' to '5'.

  • proposedLoanTerm
    Type: string
    required

    Required. Proposed loan term in whole years, 1–30 (affects repayments and therefore max lending). Defaults to '30'.

  • app1StudentLoan
    Type: string

    Does Applicant 1 have an NZ student loan (adds a repayment obligation)? 'Y' or 'N'.

  • app2AnnualGrossIncome
    Type: string

    Applicant 2's gross (before-tax) income per year, in NZD. Required when applicants = '2'; leave empty for a single applicant.

  • app2StudentLoan
    Type: string

    Does Applicant 2 have an NZ student loan? 'Y' or 'N'.

  • boarderIncomeGrossWeekly
    Type: string

    Gross weekly income received from boarders/flatmates (NZD/week).

  • bodyCorpGroundRent
    Type: string

    Body corporate fees and ground rent. Only used when useBankBenchmark = 'N'.

  • childcareSchooling
    Type: string

    Childcare and schooling costs. Only used when useBankBenchmark = 'N'.

  • childSupport
    Type: string

    Child support / maintenance payments. Only used when useBankBenchmark = 'N'.

  • clothingPersonalCare
    Type: string

    Clothing and personal care. Only used when useBankBenchmark = 'N'.

  • creditCardLimit
    Type: string

    Total approved credit-card limit across all cards (NZD). The limit, not the balance owing.

  • existingMortgages
    Type: string

    Total outstanding balance of existing mortgages that will remain after this loan (NZD).

  • groceriesFood
    Type: string

    Groceries and food. Only used when useBankBenchmark = 'N'.

  • hirePurchaseOtherLoanMonthlyPayment
    Type: string

    Total monthly payment on hire purchase and any other loans (NZD/month).

  • homeContentCarInsurance
    Type: string

    Home, contents and vehicle insurance premiums. Only used when useBankBenchmark = 'N'.

  • kiwisaverContribution
    Type: string

    KiwiSaver contributions. Only used when useBankBenchmark = 'N'.

  • lifeHealthInsurance
    Type: string

    Life and health insurance premiums. Only used when useBankBenchmark = 'N'.

  • otherExpenses
    Type: string

    Any other regular living expenses not covered above. Only used when useBankBenchmark = 'N'.

  • otherIncomeNetWeekly
    Type: string

    Any other net (after-tax) income per week, e.g. benefits or dividends (NZD/week).

  • overdraftLimit
    Type: string

    Total approved overdraft facility limit across accounts (NZD). The limit, not the drawn amount.

  • personalLoanMonthlyRepayment
    Type: string

    Total monthly repayment on personal loans (NZD/month).

  • phoneInternet
    Type: string

    Phone and internet costs. Only used when useBankBenchmark = 'N'.

  • ratesWater
    Type: string

    Council rates and water charges. Only used when useBankBenchmark = 'N'.

  • rentalIncomeGrossWeekly
    Type: string

    Gross weekly rental income from investment property, before expenses (NZD/week).

  • rentBoard
    Type: string

    Rent or board paid by the applicants. Only used when useBankBenchmark = 'N'.

  • transportVehicle
    Type: string

    Transport and vehicle running costs (fuel, servicing, public transport). Only used when useBankBenchmark = 'N'.

  • useBankBenchmark
    Type: string

    Which living-expense figure the calculation uses. 'Y' (default) = use each bank's benchmark living-expense estimate and IGNORE the individual expense fields below. 'N' = use the declared expense fields below instead. 'Y' or 'N'.

  • utilities
    Type: string

    Utilities such as power and gas. Only used when useBankBenchmark = 'N'.