Report
As a result of a calculation request to the MRE, it produces a report which contains all the information for each lender, over several loan amount cases.
Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Report Schema",
"type": "object",
"description": "Report details and results",
"properties": {
"Id": {
"type": "string",
"description": "Unique identifier for the report"
},
"Cases": {
"type": "array",
"description": "Array of case results",
"items": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"description": "Numerical identifier for the case"
},
"LoanAmount": {
"type": "number",
"description": "The total loan amount for this case"
},
"LenderResult": {
"type": "array",
"description": "Results from each lender",
"items": {
"type": "object",
"properties": {
"Lender": {
"type": "object",
"description": "Information about the lender",
"properties": {
"Id": {
"type": "integer",
"description": "Numerical identifier for the lender"
},
"Key": {
"type": "string",
"description": "Unique key code for the lender",
"enum": [
"aia",
"anz",
"asb",
"bnz",
"co-op",
"kiwibank",
"liberty",
"sbs",
"tsb",
"westpac"
]
},
"Name": {
"type": "string",
"description": "Display name of the lender"
},
"Logo": {
"type": "string",
"description": "URL to the lender's logo image"
}
},
"required": ["Id", "Key", "Name"]
},
"Result": {
"type": "object",
"description": "Detailed calculation results from the lender",
"properties": {
"AssessedIncome": {
"type": "array",
"description": "Income assessment details",
"items": {
"type": "object",
"properties": {
"Group": {
"type": "string",
"description": "Group of the income, usually how the income is grouped in spreadsheet i.e. \"Applicant Income\""
},
"Label": {
"type": "string",
"description": "Label of the income, usually how the income is referenced/named in spreadsheet i.e. \"Applicant Income {{Applicant1.Name}}\""
},
"Entered": {
"type": "object",
"description": "Values that are entered into the lender spreadsheet for this specific income",
"properties": {
"Amount": {
"type": ["number", "null"],
"description": "Amount"
},
"Frequency": {
"type": ["string", "null"],
"description": "What is the frequency of this income, usually `Monthly`"
}
}
},
"Assessed": {
"type": "object",
"description": "Values that are assessed by the lender spreadsheet (including \"shading\" that lenders apply to the entered values)",
"properties": {
"Amount": {
"type": "number",
"description": "Amount"
},
"Frequency": {
"type": "string",
"description": "What is the assessed frequency of this income, likely in all cases `Monthly`"
}
},
"required": ["Amount", "Frequency"]
}
},
"required": ["Group", "Label", "Assessed"]
}
},
"AssessedExpense": {
"type": "array",
"description": "Expense assessment details",
"items": {
"type": "object",
"properties": {
"Group": {
"type": "string",
"description": "Group of the expense, defined statically by us for display of results in UI i.e. \"Lending\", \"Other Liabilities\", \"Fixed Commitments\",..."
},
"Label": {
"type": "string",
"description": "Label of the expense, usually how the expense is referenced/named in spreadsheet i.e. \"New Home Loan\""
},
"Entered": {
"type": "object",
"description": "Values that are entered into the lender spreadsheet for this specific expense",
"properties": {
"Amount": {
"type": "number",
"description": "Amount"
},
"Frequency": {
"type": ["string", "null"],
"description": "What is the frequency of this expense, usually `Monthly`"
},
"InterestRate": {
"type": ["number", "null"],
"description": "For any home loans the applicant may have, interest rate is entered here"
},
"Definition": {
"type": ["string", "null"],
"description": "Can be set to \"Limit\" which is used when a credit card is submitted (Limit is used to tell UI how to render this expense entered value)",
"enum": [
null,
"Limit",
"Balance"
]
}
},
"required": ["Amount"]
},
"Assessed": {
"type": "object",
"description": "Values that are assessed by the lender spreadsheet (including \"shading\" that lenders apply to the entered values)",
"properties": {
"Amount": {
"type": "number",
"description": "Amount"
},
"Frequency": {
"type": "string",
"description": "What is the assessed frequency of this expense, likely in all cases `Monthly`"
}
},
"required": ["Amount", "Frequency"]
}
},
"required": ["Group", "Label", "Entered", "Assessed"]
}
},
"TotalMonthlyIncome": {
"type": "number",
"description": "Total assessed monthly income"
},
"TotalMonthlyExpense": {
"type": "number",
"description": "Total assessed monthly expenses"
},
"UMI": {
"type": "object",
"description": "Uncommitted Monthly Income assessment",
"properties": {
"Value": {
"type": "number",
"description": "Calculated UMI value"
},
"Required": {
"type": ["number", "string"],
"description": "Required minimum UMI value or indication if not applicable"
},
"Status": {
"type": "string",
"description": "Pass/Fail status of the UMI assessment",
"enum": ["Pass", "Fail", "N/A"]
},
"SecurityUsageType": {
"type": ["string", "null"],
"description": "Usage type of the security property"
},
"LvrValue": {
"type": ["number", "null"],
"description": "Loan to Value Ratio value"
}
},
"required": ["Value", "Required", "Status"]
},
"Servicing": {
"type": "object",
"description": "Servicing assessment",
"properties": {
"Type": {
"type": "string",
"description": "Type of servicing assessment"
},
"Value": {
"type": "number",
"description": "Calculated servicing value"
},
"Required": {
"type": "number",
"description": "Required minimum servicing value"
},
"Status": {
"type": "string",
"description": "Pass/Fail status of the servicing assessment",
"enum": ["Pass", "Fail", "N/A"]
}
},
"required": ["Type", "Value", "Required", "Status"]
},
"LVR": {
"type": "array",
"description": "Loan to Value Ratio assessments",
"items": {
"type": "object",
"properties": {
"Reference": {
"type": "string",
"description": "Reference identifier for the LVR assessment"
},
"LoanId": {
"type": ["integer", "null"],
"description": "ID of the loan being assessed"
},
"LVRLimit": {
"type": "array",
"description": "LVR limit factors",
"items": {
"type": "object",
"properties": {
"Label": {
"type": "string",
"description": "Label for the limit factor i.e. 'Property Type'"
},
"Description": {
"type": "string",
"description": "description/extra information for this LVRLIMIT, i.e. '{Security.PropertyType}' or 'Unknown'"
},
"MaxLVR": {
"type": "number",
"description": "Between 0 and 1 (inclusive), represents the maximum accepted lvr value"
}
},
"required": ["Label", "Description", "MaxLVR"]
}
},
"Value": {
"type": "number",
"description": "Calculated LVR value"
},
"RequiredMaxLVR": {
"type": "number",
"description": "Maximum allowed LVR value"
},
"Status": {
"type": "string",
"description": "Pass/Fail status of the LVR assessment",
"enum": ["Pass", "Fail", "N/A"]
}
},
"required": ["Reference", "Value", "RequiredMaxLVR", "Status"]
}
},
"LEM": {
"type": "array",
"description": "Lenders Equity Margin assessments",
"items": {
"type": "object",
"properties": {
"Label": {
"type": "string",
"description": "Label for the LEM assessment"
},
"LoanId": {
"type": ["integer", "null"],
"description": "ID of the loan being assessed"
},
"Assessed": {
"type": "number",
"description": "Assessed LVR value"
},
"Margin": {
"type": "number",
"description": "Margin percentage"
},
"Amount": {
"type": "number",
"description": "Calculated LEM amount"
}
},
"required": ["Label", "Assessed", "Margin", "Amount"]
}
},
"DTI": {
"type": "object",
"description": "Debt to Income assessment",
"properties": {
"TotalIncome": {
"type": "number",
"description": "Total income used for DTI calculation"
},
"TotalDebt": {
"type": "number",
"description": "Total debt used for DTI calculation"
},
"Value": {
"type": "number",
"description": "Calculated DTI value"
},
"RequiredMaxDTI": {
"type": ["number", "string"],
"description": "Maximum allowed DTI value or indication if not applicable"
},
"Status": {
"type": "string",
"description": "Pass/Fail status of the DTI assessment",
"enum": ["Pass", "Fail", "N/A"]
}
},
"required": ["Value", "Status"]
},
"Deposit": {
"type": "object",
"description": "Deposit details",
"properties": {
"Amount": {
"type": "number",
"description": "Deposit amount"
}
},
"required": ["Amount"]
}
},
"required": ["AssessedIncome", "AssessedExpense", "TotalMonthlyIncome", "TotalMonthlyExpense", "UMI", "Servicing"]
},
"Warnings": {
"type": "array",
"description": "Warning messages from the lender's assessment",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Warning message text"
},
"ReferenceObjectType": {
"type": ["string", "null"],
"description": "Type of object the warning refers to"
},
"ReferenceObjectId": {
"type": ["string", "integer", "null"],
"description": "ID of the object the warning refers to"
},
"Reference": {
"type": "string",
"description": "Reference path for the warning"
}
},
"required": ["Message", "Reference"]
}
},
"Errors": {
"type": "array",
"description": "Error messages from the lender's assessment",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Error message text"
},
"ReferenceObjectType": {
"type": ["string", "null"],
"description": "Type of object the error refers to"
},
"ReferenceObjectId": {
"type": ["string", "integer", "null"],
"description": "ID of the object the error refers to"
},
"Reference": {
"type": "string",
"description": "Reference path for the error"
}
},
"required": ["Message", "Reference"]
}
},
"Resources": {
"type": "array",
"description": "Additional resources related to the assessment",
"items": {
"type": "object",
"properties": {
"Type": {
"type": "string",
"description": "Type of resource",
"enum": ["Image", "Document", "Link"]
},
"Reference": {
"type": "string",
"description": "Reference path the resource relates to"
},
"URL": {
"type": "string",
"description": "URL to the resource"
}
},
"required": ["Type", "Reference", "URL"]
}
},
"Accuracy": {
"type": "number",
"description": "Accuracy score of the assessment (0-1)",
"minimum": 0,
"maximum": 1
},
"Version": {
"type": "object",
"description": "Version information for the lender's assessment model",
"properties": {
"VersionNumber": {
"type": "string",
"description": "Version number"
},
"ReleaseDate": {
"type": "string",
"description": "Release date of the version",
"format": "date"
},
"VersionReleaseNote": {
"type": "string",
"description": "Release notes for the version"
}
},
"required": ["VersionNumber", "ReleaseDate"]
}
},
"required": ["Lender", "Result", "Accuracy"]
}
}
},
"required": ["Id", "LenderResult"]
}
},
"Accuracy": {
"type": "number",
"description": "Overall accuracy score of the report (0-1)",
"minimum": 0,
"maximum": 1
}
},
"required": ["Id", "Cases"]
}