curl --request POST \
--url https://api.example.com/calculations/serviceability \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"inputs": {
"householdInfo": {
"isJointApplication": true,
"dependents": [
123
],
"suburbUids": [
"<string>"
]
},
"proposedHomeLoans": {
"intendedUse": "<string>",
"desiredPurchasePrice": 123,
"isFirstHomeBuyer": true,
"isAusCitizenPermanentResident": true,
"firstMortgage": {
"lvr": 123,
"loanDuration": 123,
"interestRate": 123,
"bufferRate": 123,
"repaymentType": "<string>",
"interestOnlyDurationYears": 123,
"interestOnlyInterestRate": 123
},
"capitaliseLdp": true,
"noDepositBoostLoanRequired": true,
"savingsContribution": 123,
"ownHomeLvr": 123
},
"financials": {
"primaryIncome": {
"basicIncome": {
"amount": 123,
"period": "Week"
},
"bonusOrCommissionIncome": {
"amount": 123,
"period": "Week"
},
"rentalIncome": {
"amount": 123,
"period": "Week"
},
"otherIncome": {
"amount": 123,
"period": "Week"
}
},
"expenses": {
"clothingAndPersonalCare": {
"amount": 123,
"period": "Week"
},
"generalInsurance": {
"amount": 123,
"period": "Week"
},
"groceries": {
"amount": 123,
"period": "Week"
},
"medicalAndHealth": {
"amount": 123,
"period": "Week"
},
"primaryResidenceCosts": {
"amount": 123,
"period": "Week"
},
"publicOrGovtEducation": {
"amount": 123,
"period": "Week"
},
"recreationAndEntertainment": {
"amount": 123,
"period": "Week"
},
"phoneInternetTVStreamingSubscriptions": {
"amount": 123,
"period": "Week"
},
"transport": {
"amount": 123,
"period": "Week"
},
"childcare": {
"amount": 123,
"period": "Week"
},
"investmentPropertyCosts": {
"amount": 123,
"period": "Week"
},
"privateOrNonGovtEducation": {
"amount": 123,
"period": "Week"
},
"personalInsurance": {
"amount": 123,
"period": "Week"
},
"otherRegularAndRecurringExpenses": {
"amount": 123,
"period": "Week"
}
},
"liabilities": {
"hasPrimaryHecs": true,
"hasSecondaryHecs": true,
"totalCreditCardLimit": 123,
"personalLoan": {
"amount": 123,
"period": "Week"
},
"carLoan": {
"amount": 123,
"period": "Week"
},
"existingMortgage": {
"amount": 123,
"period": "Week"
},
"bnplAccountsLimit": 123
},
"secondaryIncome": {
"basicIncome": {
"amount": 123,
"period": "Week"
},
"bonusOrCommissionIncome": {
"amount": 123,
"period": "Week"
},
"rentalIncome": {
"amount": 123,
"period": "Week"
},
"otherIncome": {
"amount": 123,
"period": "Week"
}
}
}
}
}
'{
"servInputs": {
"monthlyBnplImpact": 123,
"monthlyCreditCardImpact": 123,
"monthlyLoanRepayments": 123,
"annualGrossRentalIncome": 123,
"annualAssessableRentalIncome": 123,
"monthlyMortgageImpact": 123,
"annualTotalGrossIncomeExRental": 123,
"monthlyNonHemExpenses": 123,
"monthlyDeclaredHemExpenses": 123,
"monthlyCalculatedHemExpenses": 123,
"monthlyAssessedHemExpenses": 123,
"annualPrimaryGrossEmploymentIncome": 123,
"annualPrimaryGrossPostTaxEmploymentIncome": 123,
"annualPrimaryNetEmploymentIncome": 123,
"annualTotalPrimaryNetEmploymentIncome": 123,
"annualPrimaryGrossBonusIncome": 123,
"annualPrimaryAssessableBonusIncome": 123,
"annualPrimaryGrossOtherIncome": 123,
"annualPrimaryAssessableOtherIncome": 123,
"annualSecondaryGrossEmploymentIncome": 123,
"annualSecondaryGrossPostTaxEmploymentIncome": 123,
"annualSecondaryNetEmploymentIncome": 123,
"annualTotalSecondaryNetEmploymentIncome": 123,
"annualSecondaryGrossBonusIncome": 123,
"annualSecondaryAssessableBonusIncome": 123,
"annualSecondaryGrossOtherIncome": 123,
"annualSecondaryAssessableOtherIncome": 123,
"totalMonthlyAssessableIncome": 123,
"totalMonthlyExpensesLiabilities": 123,
"totalMonthlyUncommittedIncome": 123
},
"servResponse": {
"maximumResult": {
"loanBreakdown": {
"firstMortgageAmount": 123,
"firstMortgageLvr": 123,
"ownHomeMortgageAmount": 123,
"ownHomeMortgageLvr": 123,
"customerContributionPercentage": 123,
"customerContributionAmount": 123,
"combinedFinanceAmount": 123,
"purchasePrice": 123
},
"repayments": {
"firstMortgageInterestRate": 123,
"firstMortgageDuration": 123,
"firstMortgageMonthlyRepaymentAmount": 123,
"ownHomeMortgageInterestRate": 123,
"ownHomeMortgageDuration": 123,
"ownHomeMortgageMonthlyRepaymentAmount": 123,
"totalMonthlyRepaymentAmount": 123,
"blendedInterestRate": 123
},
"upfrontCosts": {
"type": "OwnHomeDepositBoostLoan",
"totalLvr": 123,
"depositAmount": 123,
"ldpFullPrice": 123,
"lmiCost": 123,
"stampDuty": 123,
"foreignOwnershipFees": 123,
"mortgageTransferFee": 123,
"conveyancerCost": 123,
"buildingPestStrataReportCost": 123,
"totalUpfrontCost": 123
},
"savingsContribution": 123,
"qualificationResult": {
"suburbClassification": "MetroPlus",
"isWithinMaxPurchaseAmount": true
},
"savingsGap": 123
},
"desiredResult": {
"loanBreakdown": {
"firstMortgageAmount": 123,
"firstMortgageLvr": 123,
"ownHomeMortgageAmount": 123,
"ownHomeMortgageLvr": 123,
"customerContributionPercentage": 123,
"customerContributionAmount": 123,
"combinedFinanceAmount": 123,
"purchasePrice": 123
},
"repayments": {
"firstMortgageInterestRate": 123,
"firstMortgageDuration": 123,
"firstMortgageMonthlyRepaymentAmount": 123,
"ownHomeMortgageInterestRate": 123,
"ownHomeMortgageDuration": 123,
"ownHomeMortgageMonthlyRepaymentAmount": 123,
"totalMonthlyRepaymentAmount": 123,
"blendedInterestRate": 123
},
"upfrontCosts": {
"type": "OwnHomeDepositBoostLoan",
"totalLvr": 123,
"depositAmount": 123,
"ldpFullPrice": 123,
"lmiCost": 123,
"stampDuty": 123,
"foreignOwnershipFees": 123,
"mortgageTransferFee": 123,
"conveyancerCost": 123,
"buildingPestStrataReportCost": 123,
"totalUpfrontCost": 123
},
"savingsContribution": 123,
"qualificationResult": {
"suburbClassification": "MetroPlus",
"isWithinMaxPurchaseAmount": true
},
"savingsGap": 123
}
}
}curl --request POST \
--url https://api.example.com/calculations/serviceability \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"inputs": {
"householdInfo": {
"isJointApplication": true,
"dependents": [
123
],
"suburbUids": [
"<string>"
]
},
"proposedHomeLoans": {
"intendedUse": "<string>",
"desiredPurchasePrice": 123,
"isFirstHomeBuyer": true,
"isAusCitizenPermanentResident": true,
"firstMortgage": {
"lvr": 123,
"loanDuration": 123,
"interestRate": 123,
"bufferRate": 123,
"repaymentType": "<string>",
"interestOnlyDurationYears": 123,
"interestOnlyInterestRate": 123
},
"capitaliseLdp": true,
"noDepositBoostLoanRequired": true,
"savingsContribution": 123,
"ownHomeLvr": 123
},
"financials": {
"primaryIncome": {
"basicIncome": {
"amount": 123,
"period": "Week"
},
"bonusOrCommissionIncome": {
"amount": 123,
"period": "Week"
},
"rentalIncome": {
"amount": 123,
"period": "Week"
},
"otherIncome": {
"amount": 123,
"period": "Week"
}
},
"expenses": {
"clothingAndPersonalCare": {
"amount": 123,
"period": "Week"
},
"generalInsurance": {
"amount": 123,
"period": "Week"
},
"groceries": {
"amount": 123,
"period": "Week"
},
"medicalAndHealth": {
"amount": 123,
"period": "Week"
},
"primaryResidenceCosts": {
"amount": 123,
"period": "Week"
},
"publicOrGovtEducation": {
"amount": 123,
"period": "Week"
},
"recreationAndEntertainment": {
"amount": 123,
"period": "Week"
},
"phoneInternetTVStreamingSubscriptions": {
"amount": 123,
"period": "Week"
},
"transport": {
"amount": 123,
"period": "Week"
},
"childcare": {
"amount": 123,
"period": "Week"
},
"investmentPropertyCosts": {
"amount": 123,
"period": "Week"
},
"privateOrNonGovtEducation": {
"amount": 123,
"period": "Week"
},
"personalInsurance": {
"amount": 123,
"period": "Week"
},
"otherRegularAndRecurringExpenses": {
"amount": 123,
"period": "Week"
}
},
"liabilities": {
"hasPrimaryHecs": true,
"hasSecondaryHecs": true,
"totalCreditCardLimit": 123,
"personalLoan": {
"amount": 123,
"period": "Week"
},
"carLoan": {
"amount": 123,
"period": "Week"
},
"existingMortgage": {
"amount": 123,
"period": "Week"
},
"bnplAccountsLimit": 123
},
"secondaryIncome": {
"basicIncome": {
"amount": 123,
"period": "Week"
},
"bonusOrCommissionIncome": {
"amount": 123,
"period": "Week"
},
"rentalIncome": {
"amount": 123,
"period": "Week"
},
"otherIncome": {
"amount": 123,
"period": "Week"
}
}
}
}
}
'{
"servInputs": {
"monthlyBnplImpact": 123,
"monthlyCreditCardImpact": 123,
"monthlyLoanRepayments": 123,
"annualGrossRentalIncome": 123,
"annualAssessableRentalIncome": 123,
"monthlyMortgageImpact": 123,
"annualTotalGrossIncomeExRental": 123,
"monthlyNonHemExpenses": 123,
"monthlyDeclaredHemExpenses": 123,
"monthlyCalculatedHemExpenses": 123,
"monthlyAssessedHemExpenses": 123,
"annualPrimaryGrossEmploymentIncome": 123,
"annualPrimaryGrossPostTaxEmploymentIncome": 123,
"annualPrimaryNetEmploymentIncome": 123,
"annualTotalPrimaryNetEmploymentIncome": 123,
"annualPrimaryGrossBonusIncome": 123,
"annualPrimaryAssessableBonusIncome": 123,
"annualPrimaryGrossOtherIncome": 123,
"annualPrimaryAssessableOtherIncome": 123,
"annualSecondaryGrossEmploymentIncome": 123,
"annualSecondaryGrossPostTaxEmploymentIncome": 123,
"annualSecondaryNetEmploymentIncome": 123,
"annualTotalSecondaryNetEmploymentIncome": 123,
"annualSecondaryGrossBonusIncome": 123,
"annualSecondaryAssessableBonusIncome": 123,
"annualSecondaryGrossOtherIncome": 123,
"annualSecondaryAssessableOtherIncome": 123,
"totalMonthlyAssessableIncome": 123,
"totalMonthlyExpensesLiabilities": 123,
"totalMonthlyUncommittedIncome": 123
},
"servResponse": {
"maximumResult": {
"loanBreakdown": {
"firstMortgageAmount": 123,
"firstMortgageLvr": 123,
"ownHomeMortgageAmount": 123,
"ownHomeMortgageLvr": 123,
"customerContributionPercentage": 123,
"customerContributionAmount": 123,
"combinedFinanceAmount": 123,
"purchasePrice": 123
},
"repayments": {
"firstMortgageInterestRate": 123,
"firstMortgageDuration": 123,
"firstMortgageMonthlyRepaymentAmount": 123,
"ownHomeMortgageInterestRate": 123,
"ownHomeMortgageDuration": 123,
"ownHomeMortgageMonthlyRepaymentAmount": 123,
"totalMonthlyRepaymentAmount": 123,
"blendedInterestRate": 123
},
"upfrontCosts": {
"type": "OwnHomeDepositBoostLoan",
"totalLvr": 123,
"depositAmount": 123,
"ldpFullPrice": 123,
"lmiCost": 123,
"stampDuty": 123,
"foreignOwnershipFees": 123,
"mortgageTransferFee": 123,
"conveyancerCost": 123,
"buildingPestStrataReportCost": 123,
"totalUpfrontCost": 123
},
"savingsContribution": 123,
"qualificationResult": {
"suburbClassification": "MetroPlus",
"isWithinMaxPurchaseAmount": true
},
"savingsGap": 123
},
"desiredResult": {
"loanBreakdown": {
"firstMortgageAmount": 123,
"firstMortgageLvr": 123,
"ownHomeMortgageAmount": 123,
"ownHomeMortgageLvr": 123,
"customerContributionPercentage": 123,
"customerContributionAmount": 123,
"combinedFinanceAmount": 123,
"purchasePrice": 123
},
"repayments": {
"firstMortgageInterestRate": 123,
"firstMortgageDuration": 123,
"firstMortgageMonthlyRepaymentAmount": 123,
"ownHomeMortgageInterestRate": 123,
"ownHomeMortgageDuration": 123,
"ownHomeMortgageMonthlyRepaymentAmount": 123,
"totalMonthlyRepaymentAmount": 123,
"blendedInterestRate": 123
},
"upfrontCosts": {
"type": "OwnHomeDepositBoostLoan",
"totalLvr": 123,
"depositAmount": 123,
"ldpFullPrice": 123,
"lmiCost": 123,
"stampDuty": 123,
"foreignOwnershipFees": 123,
"mortgageTransferFee": 123,
"conveyancerCost": 123,
"buildingPestStrataReportCost": 123,
"totalUpfrontCost": 123
},
"savingsContribution": 123,
"qualificationResult": {
"suburbClassification": "MetroPlus",
"isWithinMaxPurchaseAmount": true
},
"savingsGap": 123
}
}
}