@lendi/act-credit-decisions-transform 2.0.0

package/lib/schemas/public-funding-position-event.json

@@ -0,0 +1,419 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "The funding position event schema",
+  "description": "This event is the public funding position event",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "version": {
+      "type": "string",
+      "description": "schema version"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["FundingPosition"]
+    },
+    "payload": {
+      "$ref": "#/definitions/Payload"
+    }
+  },
+  "required": ["version", "type", "payload"],
+  "definitions": {
+    "Payload": {
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Application ID"
+        },
+        "applicationId": {
+          "type": "string",
+          "description": "Application ID"
+        },
+        "properties": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Property"
+          },
+          "description": "List of refinance or new purchase property"
+        },
+        "fundsRequiredBreakdown": {
+          "$ref": "#/definitions/FundsRequiredBreakdown"
+        },
+        "totalCashOut": {
+          "type": "number",
+          "description": "The total amount of customer-specified cash out."
+        },
+        "totalTopUp": {
+          "type": "number",
+          "description": "The total amount of customer-specified top up."
+        },
+        "totalDeposit": {
+          "type": "number",
+          "description": "The total deposit amount for all properties."
+        },
+        "totalDebtConsolidation": {
+          "type": "number",
+          "description": "The total amount of debt to be consolidated."
+        },
+        "totalGovernmentContributions": {
+          "type": "number",
+          "description": "The total amount available for settlement from government grants."
+        },
+        "fundsRequested": {
+          "type": "number",
+          "description": "The final loan amount requested by the customer or broker."
+        },
+        "fundsRequired": {
+          "type": "number",
+          "description": "The amount required to balance all costs with contributions. The minimum loan amount required for settlement."
+        },
+        "lvr": {
+          "type": "number",
+          "description": "Loan to value ratio. Calculated as the loan amount divided by the value of all properties being used as security."
+        },
+        "baseFundsRequested": {
+          "type": "number",
+          "description": "The loan amount input by the customer or broker, but does not include the lmi. See fundsRequested for the final loan amount requested that includes lmi if lmiIncluded is true."
+        },
+        "baseLVR": {
+          "type": "number",
+          "description": "Loan to value ratio. Calculated as the loan amount divided by the value of all properties being used as security. Based on the baseFundsRequested field, which does not include the lmi."
+        },
+        "netSurplus": {
+          "type": "number",
+          "description": "The amount remaining after settlement. Calculated as the difference between the funds requested and funds required."
+        },
+        "lmi": {
+          "type": "number",
+          "description": "Lenders Mortgage Insurance premium. An additional cost required by lenders for higher risk loans."
+        },
+        "lmiIncluded": {
+          "type": "boolean",
+          "description": "Whether the lmi premium is included in the funds required."
+        },
+        "cashoutCustomerActionRequired": {
+          "type": "boolean",
+          "description": "Customer action on cash-out required."
+        },
+        "cashoutCustomerActionCompleted": {
+          "type": "boolean",
+          "description": "Customer action on cash-out completed."
+        },
+        "cashoutCustomerAcknowledgement": {
+          "type": "boolean",
+          "description": "Cash-out acknowledgement completed by customer."
+        },
+        "cashoutBrokerCompleted": {
+          "type": "boolean",
+          "description": "All cash-out reasons are completed with comment by broker."
+        },
+        "topUpBrokerCompleted": {
+          "type": "boolean",
+          "description": "All top-up reasons are completed with comment by broker. Value undefined is equivalent to false."
+        },
+        "totalLendingAmount": {
+          "type": "number",
+          "description": "Total lending amount is fundsRequested plus the current loan amount, an example for the current loan amount is the loan amount on a land and the land would be used as security for a construction loan. If lmiIncluded is true it will include the lmi."
+        },
+        "totalLendingLvr": {
+          "type": "number",
+          "description": "Loan to value ratio. Calculated as the total lending amount divided by the value of all properties (including new purchase, refinance, security, and construction). Based on the totalLendingAmount field, which may include the lmi."
+        },
+        "totalPledgeAmount": {
+          "type": "number",
+          "description": "This is the total amount ($) of equity that the Guarantors are offering up as part of the Security Guarantee to the Borrowers application."
+        },
+        "totalPropertyValue": {
+          "type": "number",
+          "description": "Total property value excluding guarantor security properties."
+        }
+      },
+      "required": [
+        "id",
+        "applicationId",
+        "properties",
+        "fundsRequiredBreakdown",
+        "totalCashOut",
+        "totalTopUp",
+        "totalDeposit",
+        "totalDebtConsolidation",
+        "totalGovernmentContributions",
+        "fundsRequested",
+        "fundsRequired",
+        "lvr",
+        "netSurplus",
+        "lmi",
+        "lmiIncluded"
+      ]
+    },
+    "OtherConsolidatingHomeLoanLiability": {
+      "type": "object",
+      "properties": {
+        "assetId": {
+          "type": "string",
+          "description": "The asset ID of the property associated with the home loan liability"
+        },
+        "liabilityId": {
+          "type": "string",
+          "description": "The home loan liability ID"
+        },
+        "outstandingAmount": {
+          "type": "number",
+          "description": "The home loan liability outstanding amount"
+        }
+      },
+      "required": ["assetId", "liabilityId", "outstandingAmount"]
+    },
+    "Property": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Property ID"
+        },
+        "mortgageRegistrationFee": {
+          "type": "number",
+          "description": "A fee paid to the Land Titles Office for the registration of a mortgage over a property."
+        },
+        "lenderSetupFee": {
+          "type": "number",
+          "description": "Fees payable to the lender on setting up a home loan and completing settlement."
+        },
+        "otherSundries": {
+          "type": "number",
+          "description": "Other fees payable to an interested party to ensure settlement can proceed."
+        },
+        "contributionAmount": {
+          "type": "number",
+          "description": "The amount that a customer is contributing towards the settlement."
+        },
+        "governmentContributions": {
+          "type": "number",
+          "description": "The amount available for settlement from government grants."
+        },
+        "constructionCosts": {
+          "type": ["number"],
+          "description": "The amount that will be used for construction purposes."
+        },
+        "totalCosts": {
+          "type": "number",
+          "description": "A sum of all costs and charges involved with funding the loan and settlement."
+        },
+        "totalContributions": {
+          "type": "number",
+          "description": "A sum of all contributions made towards settlement."
+        },
+        "purchasePrice": {
+          "type": "number",
+          "description": "The agreed price that a property has been purchased for."
+        },
+        "transferFee": {
+          "type": "number",
+          "description": "A fee paid to the Land Titles Office fee for transferring the property title from the seller to the buyer."
+        },
+        "stampDuty": {
+          "type": "number",
+          "description": "Tax paid to the State Revenue Office when purchasing a property."
+        },
+        "conveyancingCost": {
+          "type": "number",
+          "description": "The costs involved with a conveyancer who assists with settlement."
+        },
+        "foreignBuyerSurcharge": {
+          "type": ["number"],
+          "description": "An additional fee payable to the Land Titles Office for property buyers that are not permanent residents. "
+        },
+        "totalRequired": {
+          "type": "number",
+          "description": "Total fund required. The sum of purchase price, and fees."
+        },
+        "propertyValue": {
+          "type": "number",
+          "description": "The value of a property."
+        },
+        "currentLoanAmount": {
+          "type": "number",
+          "description": "The credit limit of an existing home loan that is secured by a property."
+        },
+        "lenderDischargeFee": {
+          "type": "number",
+          "description": "A fee charged by a customer’s existing lender when closing a home loan account."
+        },
+        "accruedInterest": {
+          "type": "number",
+          "description": "The interest accrued before an existing loan has been discharged and payable to the existing lender at settlement."
+        },
+        "debtConsolidation": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/DebtConsolidation"
+          }
+        },
+        "cashOutAmount": {
+          "type": "number",
+          "description": "The additional amount of money requested by the customer as part of the loan."
+        },
+        "cashOuts": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/CashOut"
+          }
+        },
+        "pledgeAmount": {
+          "type": "number",
+          "description": "This is the amount ($) of equity that the Guarantor is offering up as part of the Security Guarantee to the Borrowers application."
+        },
+        "topUps": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/TopUp"
+          }
+        },
+        "topUpAmount": {
+          "type": "number",
+          "description": "The additional amount of money requested by the customer as part of the top-up loan."
+        }
+      },
+      "required": [
+        "id",
+        "mortgageRegistrationFee",
+        "lenderSetupFee",
+        "otherSundries",
+        "contributionAmount",
+        "governmentContributions",
+        "constructionCosts",
+        "totalCosts",
+        "totalContributions",
+        "totalRequired"
+      ]
+    },
+    "DebtConsolidation": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "ID"
+        },
+        "amount": {
+          "type": "number",
+          "description": "Amount"
+        },
+        "liabilityType": {
+          "type": ["string", "null"],
+          "description": "Liability type"
+        },
+        "financialInstitutionShortName": {
+          "type": ["string", "null"],
+          "description": "Financial institution short name"
+        },
+        "toConsolidate": {
+          "type": "boolean",
+          "description": "to consolidate"
+        }
+      },
+      "required": ["id", "amount", "liabilityType", "financialInstitutionShortName", "toConsolidate"]
+    },
+    "FundsRequiredBreakdown": {
+      "type": "object",
+      "properties": {
+        "mortgageRegistrationFee": {
+          "type": "number",
+          "description": "A fee paid to the Land Titles Office for the registration of a mortgage over a property."
+        },
+        "lenderSetupFee": {
+          "type": "number",
+          "description": "Fees payable to the lender on setting up a home loan and completing settlement."
+        },
+        "otherSundries": {
+          "type": "number",
+          "description": "Other fees payable to an interested party to ensure settlement can proceed."
+        },
+        "constructionCosts": {
+          "type": ["number"],
+          "description": "The amount that will be used for construction purposes."
+        },
+        "transferFee": {
+          "type": "number",
+          "description": "A fee paid to the Land Titles Office fee for transferring the property title from the seller to the buyer."
+        },
+        "stampDuty": {
+          "type": "number",
+          "description": "Tax paid to the State Revenue Office when purchasing a property."
+        },
+        "conveyancingCost": {
+          "type": "number",
+          "description": "The costs involved with a conveyancer who assists with settlement."
+        },
+        "foreignBuyerSurcharge": {
+          "type": ["number"],
+          "description": "An additional fee payable to the Land Titles Office for property buyers that are not permanent residents. "
+        },
+        "lenderDischargeFee": {
+          "type": "number",
+          "description": "A fee charged by a customer’s existing lender when closing a home loan account."
+        },
+        "accruedInterest": {
+          "type": "number",
+          "description": "The interest accrued before an existing loan has been discharged and payable to the existing lender at settlement."
+        },
+        "otherConsolidatingHomeLoanLiabilities": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/OtherConsolidatingHomeLoanLiability"
+          },
+          "description": "List of home loan liabilities to be consolidated, tied to a home loan asset not to be used as security."
+        }
+      },
+      "required": [
+        "mortgageRegistrationFee",
+        "lenderSetupFee",
+        "otherSundries",
+        "constructionCosts",
+        "transferFee",
+        "stampDuty",
+        "conveyancingCost",
+        "foreignBuyerSurcharge",
+        "lenderDischargeFee",
+        "accruedInterest"
+      ]
+    },
+    "CashOut": {
+      "type": "object",
+      "properties": {
+        "amount": {
+          "type": "number",
+          "description": "The amount of cash-out with reason."
+        },
+        "reason": {
+          "type": "string",
+          "enum": [
+            "EDUCATION_EXPENSES",
+            "HOLIDAY_EXPENSES",
+            "PROPERTY_DEPOSIT",
+            "NON_STRUCTURAL_RENOVATIONS",
+            "MARITAL_SETTLEMENT",
+            "MEDICAL_EXPENSES",
+            "OTHER",
+            "INVESTMENT_PURPOSES",
+            "VEHICLE_PURCHASE",
+            "WEDDING_EXPENSES"
+          ]
+        },
+        "description": {
+          "type": "string",
+          "description": "Additional description for the cash-out reason."
+        },
+        "comment": {
+          "type": "string",
+          "description": "Comment by broker for the cash-out."
+        }
+      },
+      "required": ["amount"]
+    },
+    "TopUp": {
+      "allOf": [{ "$ref": "#/definitions/CashOut" }]
+    }
+  }
+}

package/lib/schemas/public-income-event.json

@@ -0,0 +1,242 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "frequency": {
+      "type": "string",
+      "enum": ["FORTNIGHTLY", "MONTHLY", "WEEKLY", "QUARTERLY", "YEARLY"]
+    },
+    "ownership": {
+      "type": "object",
+      "required": ["applicantId", "percent"],
+      "properties": {
+        "applicantId": {
+          "type": "string",
+          "format": "uuid"
+        },
+        "percent": {
+          "type": "number",
+          "description": "how much percent for the corresponding applicant"
+        }
+      }
+    },
+    "ownershipProportion": {
+      "type": "object",
+      "required": ["owners"],
+      "properties": {
+        "proportions": {
+          "enum": ["EQUAL", "SPECIFIED", "NOT_SPECIFIED"],
+          "description": "Indicate whether ownership proportions are equal, specified individually for each one or not specified."
+        },
+        "owners": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/definitions/ownership"
+          }
+        }
+      }
+    },
+    "year": {
+      "type": "number",
+      "description": "Year the vehicle was made."
+    },
+    "AddBackDefinition": {
+      "type": "object",
+      "description": "add-back is an expense that is added back to the profits of the business",
+      "properties": {
+        "depreciation": {
+          "type": "number",
+          "example": 3200
+        },
+        "interest": {
+          "type": "number",
+          "example": 4600
+        },
+        "lease": {
+          "type": "number",
+          "example": 7600
+        },
+        "nonRecurringExpenses": {
+          "type": "number",
+          "example": 7810
+        },
+        "salary": {
+          "type": "number",
+          "example": 9000
+        },
+        "superannuationExcess": {
+          "type": "number",
+          "example": 1300
+        },
+        "other": {
+          "type": "number",
+          "example": 6600
+        }
+      }
+    },
+    "BASDefinition": {
+      "type": "object",
+      "description": "Business activity statement details",
+      "properties": {
+        "quarter": {
+          "type": "number",
+          "example": 1,
+          "enum": [1, 2, 3, 4]
+        },
+        "salesAmount": {
+          "type": "number",
+          "example": 54570
+        }
+      },
+      "required": ["quarter"]
+    },
+    "IncomeBusinessDetails": {
+      "type": "object",
+      "description": "Earnings for a company over a specified financial year",
+      "properties": {
+        "year": {
+          "$ref": "#/definitions/year"
+        },
+        "companyProfitBeforeTax": {
+          "type": "number",
+          "example": 200000
+        },
+        "addback": {
+          "$ref": "#/definitions/AddBackDefinition"
+        },
+        "nonRecurringIncome": {
+          "type": "number",
+          "example": 9100
+        }
+      }
+    },
+    "incomeDefinition": {
+      "type": "object",
+      "required": ["id", "applicationId", "income"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "description": "uuid of Expense"
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        },
+        "applicationId": {
+          "type": "string"
+        },
+        "income": {
+          "type": "object",
+          "required": ["type"],
+          "properties": {
+            "amount": {
+              "type": "number"
+            },
+            "assetId": {
+              "type": "string",
+              "format": "uuid"
+            },
+            "benefitType": {
+              "type": "string",
+              "enum": ["FAMILY_TAX", "AGE_PENSION", "DISABILITY_SUPPORT_PENSION", "OTHER"]
+            },
+            "comments": {
+              "type": "string"
+            },
+            "description": {
+              "type": "string"
+            },
+            "companyId": {
+              "type": "string",
+              "format": "uuid"
+            },
+            "gross": {
+              "type": "number",
+              "example": 235000
+            },
+            "incomes": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/IncomeBusinessDetails"
+              }
+            },
+            "bas": {
+              "type": "array",
+              "uniqueItems": true,
+              "items": {
+                "$ref": "#/definitions/BASDefinition"
+              }
+            },
+            "employmentId": {
+              "type": "string",
+              "format": "uuid",
+              "description": "Company Applicant"
+            },
+            "frequency": {
+              "$ref": "#/definitions/frequency"
+            },
+            "percentOwned": {
+              "$ref": "#/definitions/ownershipProportion"
+            },
+            "type": {
+              "type": "string",
+              "enum": [
+                "CHILD_MAINTENANCE",
+                "FOREIGN_INCOME",
+                "GOVT_BENEFIT",
+                "INVESTMENT_INCOME",
+                "OTHER_INCOME",
+                "PAYG_BASE_SALARY",
+                "PAYG_COMMISSION_INCOME",
+                "PAYG_BONUS_INCOME",
+                "PAYG_OVERTIME_INCOME",
+                "PAYG_CAR_ALLOWANCE",
+                "PAYG_ALLOWANCES_TAXED",
+                "PAYG_ALLOWANCES_NOT_TAXED",
+                "PAYG_COMPANY_CAR",
+                "PAYG_NON_VOLUNTARY_DEDUCTIONS_PRE_TAX",
+                "PAYG_SALARY_SACRIFICE",
+                "RENTAL_INCOME",
+                "SELF_EMPLOYED_BUSINESS_INCOME",
+                "SELF_EMPLOYED_BUSINESS_INCOME_FULL_DOC",
+                "SELF_EMPLOYED_BUSINESS_INCOME_LOW_DOC",
+                "SUPER_ANNUITY_PENSION",
+                "WORKERS_COMPENSATION"
+              ]
+            }
+          }
+        }
+      }
+    },
+    "meta": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "The metadata of the alieo",
+      "properties": {
+        "actionedBy": {
+          "description": "uuid of user who made the action (create/update/delete)",
+          "type": "string"
+        },
+        "actionedByRole": {
+          "description": "role of the user that made the action",
+          "enum": ["team", "customer"]
+        }
+      },
+      "required": ["actionedBy", "actionedByRole"]
+    }
+  },
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "enum": ["IncomeCreated", "IncomeUpdated"]
+    },
+    "version": {
+      "type": "string"
+    },
+    "payload": {
+      "$ref": "#/definitions/incomeDefinition"
+    }
+  },
+  "required": ["type", "version", "payload"]
+}