@lendi/integrations-transform 1.7.5 → 1.7.7

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

@@ -45,6 +45,10 @@
           "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."
@@ -59,7 +63,7 @@
         },
         "fundsRequested": {
           "type": "number",
-          "description": "The final loan amount amount requested by the customer or broker."
+          "description": "The final loan amount requested by the customer or broker."
         },
         "fundsRequired": {
           "type": "number",
@@ -69,6 +73,14 @@
           "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."
@@ -80,6 +92,42 @@
         "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": [
@@ -88,6 +136,7 @@
         "properties",
         "fundsRequiredBreakdown",
         "totalCashOut",
+        "totalTopUp",
         "totalDeposit",
         "totalDebtConsolidation",
         "totalGovernmentContributions",
@@ -99,6 +148,24 @@
         "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": {
@@ -187,6 +254,26 @@
         "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": [
@@ -270,6 +357,13 @@
         "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": [
@@ -284,6 +378,42 @@
         "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/types/events/public-funding-position.d.ts

@@ -15,7 +15,35 @@ export interface Payload {
      */
     applicationId: string;
     /**
-     * The final loan amount amount requested by the customer or broker.
+     * 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.
+     */
+    baseFundsRequested?: number;
+    /**
+     * 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.
+     */
+    baseLVR?: number;
+    /**
+     * All cash-out reasons are completed with comment by broker.
+     */
+    cashoutBrokerCompleted?: boolean;
+    /**
+     * Cash-out acknowledgement completed by customer.
+     */
+    cashoutCustomerAcknowledgement?: boolean;
+    /**
+     * Customer action on cash-out completed.
+     */
+    cashoutCustomerActionCompleted?: boolean;
+    /**
+     * Customer action on cash-out required.
+     */
+    cashoutCustomerActionRequired?: boolean;
+    /**
+     * The final loan amount requested by the customer or broker.
      */
     fundsRequested: number;
     /**
@@ -51,6 +79,11 @@ export interface Payload {
      * List of refinance or new purchase property
      */
     properties: Property[];
+    /**
+     * All top-up reasons are completed with comment by broker. Value undefined is equivalent to
+     * false.
+     */
+    topUpBrokerCompleted?: boolean;
     /**
      * The total amount of customer-specified cash out.
      */
@@ -67,6 +100,31 @@ export interface Payload {
      * The total amount available for settlement from government grants.
      */
     totalGovernmentContributions: number;
+    /**
+     * 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.
+     */
+    totalLendingAmount?: number;
+    /**
+     * 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.
+     */
+    totalLendingLvr?: number;
+    /**
+     * This is the total amount ($) of equity that the Guarantors are offering up as part of the
+     * Security Guarantee to the Borrowers application.
+     */
+    totalPledgeAmount?: number;
+    /**
+     * Total property value excluding guarantor security properties.
+     */
+    totalPropertyValue?: number;
+    /**
+     * The total amount of customer-specified top up.
+     */
+    totalTopUp: number;
 }
 export interface FundsRequiredBreakdown {
     /**
@@ -99,6 +157,11 @@ export interface FundsRequiredBreakdown {
      * A fee paid to the Land Titles Office for the registration of a mortgage over a property.
      */
     mortgageRegistrationFee: number;
+    /**
+     * List of home loan liabilities to be consolidated, tied to a home loan asset not to be
+     * used as security.
+     */
+    otherConsolidatingHomeLoanLiabilities?: OtherConsolidatingHomeLoanLiability[];
     /**
      * Other fees payable to an interested party to ensure settlement can proceed.
      */
@@ -113,6 +176,20 @@ export interface FundsRequiredBreakdown {
      */
     transferFee: number;
 }
+export interface OtherConsolidatingHomeLoanLiability {
+    /**
+     * The asset ID of the property associated with the home loan liability
+     */
+    assetId: string;
+    /**
+     * The home loan liability ID
+     */
+    liabilityId: string;
+    /**
+     * The home loan liability outstanding amount
+     */
+    outstandingAmount: number;
+}
 export interface Property {
     /**
      * The interest accrued before an existing loan has been discharged and payable to the
@@ -123,6 +200,7 @@ export interface Property {
      * The additional amount of money requested by the customer as part of the loan.
      */
     cashOutAmount?: number;
+    cashOuts?: CashOut[];
     /**
      * The amount that will be used for construction purposes.
      */
@@ -169,6 +247,11 @@ export interface Property {
      * Other fees payable to an interested party to ensure settlement can proceed.
      */
     otherSundries: number;
+    /**
+     * This is the amount ($) of equity that the Guarantor is offering up as part of the
+     * Security Guarantee to the Borrowers application.
+     */
+    pledgeAmount?: number;
     /**
      * The value of a property.
      */
@@ -181,6 +264,11 @@ export interface Property {
      * Tax paid to the State Revenue Office when purchasing a property.
      */
     stampDuty?: number;
+    /**
+     * The additional amount of money requested by the customer as part of the top-up loan.
+     */
+    topUpAmount?: number;
+    topUps?: CashOut[];
     /**
      * A sum of all contributions made towards settlement.
      */
@@ -199,6 +287,33 @@ export interface Property {
      */
     transferFee?: number;
 }
+export interface CashOut {
+    /**
+     * The amount of cash-out with reason.
+     */
+    amount: number;
+    /**
+     * Comment by broker for the cash-out.
+     */
+    comment?: string;
+    /**
+     * Additional description for the cash-out reason.
+     */
+    description?: string;
+    reason?: Reason;
+}
+export declare enum Reason {
+    EducationExpenses = "EDUCATION_EXPENSES",
+    HolidayExpenses = "HOLIDAY_EXPENSES",
+    InvestmentPurposes = "INVESTMENT_PURPOSES",
+    MaritalSettlement = "MARITAL_SETTLEMENT",
+    MedicalExpenses = "MEDICAL_EXPENSES",
+    NonStructuralRenovations = "NON_STRUCTURAL_RENOVATIONS",
+    Other = "OTHER",
+    PropertyDeposit = "PROPERTY_DEPOSIT",
+    VehiclePurchase = "VEHICLE_PURCHASE",
+    WeddingExpenses = "WEDDING_EXPENSES"
+}
 export interface DebtConsolidation {
     /**
      * Amount

package/lib/types/events/public-funding-position.js

@@ -1,6 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Type = void 0;
+exports.Type = exports.Reason = void 0;
+var Reason;
+(function (Reason) {
+    Reason["EducationExpenses"] = "EDUCATION_EXPENSES";
+    Reason["HolidayExpenses"] = "HOLIDAY_EXPENSES";
+    Reason["InvestmentPurposes"] = "INVESTMENT_PURPOSES";
+    Reason["MaritalSettlement"] = "MARITAL_SETTLEMENT";
+    Reason["MedicalExpenses"] = "MEDICAL_EXPENSES";
+    Reason["NonStructuralRenovations"] = "NON_STRUCTURAL_RENOVATIONS";
+    Reason["Other"] = "OTHER";
+    Reason["PropertyDeposit"] = "PROPERTY_DEPOSIT";
+    Reason["VehiclePurchase"] = "VEHICLE_PURCHASE";
+    Reason["WeddingExpenses"] = "WEDDING_EXPENSES";
+})(Reason = exports.Reason || (exports.Reason = {}));
 var Type;
 (function (Type) {
     Type["FundingPosition"] = "FundingPosition";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lendi/integrations-transform",
-  "version": "1.7.5",
+  "version": "1.7.7",
   "description": "Library for kafka event data transforming",
   "author": "Integrations <integrations@lendi.com.au>",
   "homepage": "https://bitbucket.org/lendi-dev/integrations-shared-packages#readme",