Skip to main content
POST
/
calculations
/
serviceability
/
quote
Create a Quote
curl --request POST \
  --url https://api.example.com/calculations/serviceability/quote \
  --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"
        }
      }
    }
  },
  "contactDetails": {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phoneNumber": "<string>"
  },
  "quickliScenarioQuote": "<string>",
  "quoteDescription": "<string>"
}
'
{
  "quoteUid": "<string>",
  "quoteUrl": "<string>",
  "expiresAt": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

application/json
inputs
object
required
contactDetails
object
required
quickliScenarioQuote
string
required
quoteDescription
string

Response

200 - application/json

OK

quoteUid
string
required
quoteUrl
string
required
expiresAt
string
required