@lendi/act-credit-decisions-transform 2.0.0

package/lib/types/events/public-funding-position.d.ts

@@ -0,0 +1,341 @@
+/**
+ * This event is the public funding position event
+ */
+export interface PublicFundingPosition {
+    payload: Payload;
+    type: Type;
+    /**
+     * schema version
+     */
+    version: string;
+}
+export interface Payload {
+    /**
+     * Application ID
+     */
+    applicationId: string;
+    /**
+     * 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;
+    /**
+     * The amount required to balance all costs with contributions. The minimum loan amount
+     * required for settlement.
+     */
+    fundsRequired: number;
+    fundsRequiredBreakdown: FundsRequiredBreakdown;
+    /**
+     * Application ID
+     */
+    id: string;
+    /**
+     * Lenders Mortgage Insurance premium. An additional cost required by lenders for higher
+     * risk loans.
+     */
+    lmi: number;
+    /**
+     * Whether the lmi premium is included in the funds required.
+     */
+    lmiIncluded: boolean;
+    /**
+     * Loan to value ratio. Calculated as the loan amount divided by the value of all properties
+     * being used as security.
+     */
+    lvr: number;
+    /**
+     * The amount remaining after settlement. Calculated as the difference between the funds
+     * requested and funds required.
+     */
+    netSurplus: number;
+    /**
+     * 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.
+     */
+    totalCashOut: number;
+    /**
+     * The total amount of debt to be consolidated.
+     */
+    totalDebtConsolidation: number;
+    /**
+     * The total deposit amount for all properties.
+     */
+    totalDeposit: number;
+    /**
+     * 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 {
+    /**
+     * The interest accrued before an existing loan has been discharged and payable to the
+     * existing lender at settlement.
+     */
+    accruedInterest: number;
+    /**
+     * The amount that will be used for construction purposes.
+     */
+    constructionCosts: number;
+    /**
+     * The costs involved with a conveyancer who assists with settlement.
+     */
+    conveyancingCost: number;
+    /**
+     * An additional fee payable to the Land Titles Office for property buyers that are not
+     * permanent residents.
+     */
+    foreignBuyerSurcharge: number;
+    /**
+     * A fee charged by a customer’s existing lender when closing a home loan account.
+     */
+    lenderDischargeFee: number;
+    /**
+     * Fees payable to the lender on setting up a home loan and completing settlement.
+     */
+    lenderSetupFee: number;
+    /**
+     * 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.
+     */
+    otherSundries: number;
+    /**
+     * Tax paid to the State Revenue Office when purchasing a property.
+     */
+    stampDuty: number;
+    /**
+     * A fee paid to the Land Titles Office fee for transferring the property title from the
+     * seller to the buyer.
+     */
+    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
+     * existing lender at settlement.
+     */
+    accruedInterest?: number;
+    /**
+     * 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.
+     */
+    constructionCosts: number;
+    /**
+     * The amount that a customer is contributing towards the settlement.
+     */
+    contributionAmount: number;
+    /**
+     * The costs involved with a conveyancer who assists with settlement.
+     */
+    conveyancingCost?: number;
+    /**
+     * The credit limit of an existing home loan that is secured by a property.
+     */
+    currentLoanAmount?: number;
+    debtConsolidation?: DebtConsolidation[];
+    /**
+     * An additional fee payable to the Land Titles Office for property buyers that are not
+     * permanent residents.
+     */
+    foreignBuyerSurcharge?: number;
+    /**
+     * The amount available for settlement from government grants.
+     */
+    governmentContributions: number;
+    /**
+     * Property ID
+     */
+    id: string;
+    /**
+     * A fee charged by a customer’s existing lender when closing a home loan account.
+     */
+    lenderDischargeFee?: number;
+    /**
+     * Fees payable to the lender on setting up a home loan and completing settlement.
+     */
+    lenderSetupFee: number;
+    /**
+     * A fee paid to the Land Titles Office for the registration of a mortgage over a property.
+     */
+    mortgageRegistrationFee: number;
+    /**
+     * 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.
+     */
+    propertyValue?: number;
+    /**
+     * The agreed price that a property has been purchased for.
+     */
+    purchasePrice?: number;
+    /**
+     * 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.
+     */
+    totalContributions: number;
+    /**
+     * A sum of all costs and charges involved with funding the loan and settlement.
+     */
+    totalCosts: number;
+    /**
+     * Total fund required. The sum of purchase price, and fees.
+     */
+    totalRequired: number;
+    /**
+     * A fee paid to the Land Titles Office fee for transferring the property title from the
+     * seller to the buyer.
+     */
+    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
+     */
+    amount: number;
+    /**
+     * Financial institution short name
+     */
+    financialInstitutionShortName: null | string;
+    /**
+     * ID
+     */
+    id: string;
+    /**
+     * Liability type
+     */
+    liabilityType: null | string;
+    /**
+     * to consolidate
+     */
+    toConsolidate: boolean;
+}
+export declare enum Type {
+    FundingPosition = "FundingPosition"
+}

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

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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";
+})(Type = exports.Type || (exports.Type = {}));

package/lib/types/events/public-income.d.ts

@@ -0,0 +1,144 @@
+export interface PublicIncome {
+    payload: IncomeDefinition;
+    type: PublicIncomeType;
+    version: string;
+}
+export interface IncomeDefinition {
+    applicationId: string;
+    /**
+     * uuid of Expense
+     */
+    id: string;
+    income: Income;
+    meta?: Meta;
+}
+export interface Income {
+    amount?: number;
+    assetId?: string;
+    bas?: BASDefinition[];
+    benefitType?: BenefitType;
+    comments?: string;
+    companyId?: string;
+    description?: string;
+    /**
+     * Company Applicant
+     */
+    employmentId?: string;
+    frequency?: Frequency;
+    gross?: number;
+    incomes?: IncomeBusinessDetails[];
+    percentOwned?: OwnershipProportion;
+    type: IncomeType;
+}
+/**
+ * Business activity statement details
+ */
+export interface BASDefinition {
+    quarter: number;
+    salesAmount?: number;
+}
+export declare enum BenefitType {
+    AgePension = "AGE_PENSION",
+    DisabilitySupportPension = "DISABILITY_SUPPORT_PENSION",
+    FamilyTax = "FAMILY_TAX",
+    Other = "OTHER"
+}
+export declare enum Frequency {
+    Fortnightly = "FORTNIGHTLY",
+    Monthly = "MONTHLY",
+    Quarterly = "QUARTERLY",
+    Weekly = "WEEKLY",
+    Yearly = "YEARLY"
+}
+/**
+ * Earnings for a company over a specified financial year
+ */
+export interface IncomeBusinessDetails {
+    addback?: AddBackDefinition;
+    companyProfitBeforeTax?: number;
+    nonRecurringIncome?: number;
+    year?: number;
+}
+/**
+ * add-back is an expense that is added back to the profits of the business
+ */
+export interface AddBackDefinition {
+    depreciation?: number;
+    interest?: number;
+    lease?: number;
+    nonRecurringExpenses?: number;
+    other?: number;
+    salary?: number;
+    superannuationExcess?: number;
+}
+export interface OwnershipProportion {
+    owners: Ownership[];
+    /**
+     * Indicate whether ownership proportions are equal, specified individually for each one or
+     * not specified.
+     */
+    proportions?: Proportions;
+}
+export interface Ownership {
+    applicantId: string;
+    /**
+     * how much percent for the corresponding applicant
+     */
+    percent: number;
+}
+/**
+ * Indicate whether ownership proportions are equal, specified individually for each one or
+ * not specified.
+ */
+export declare enum Proportions {
+    Equal = "EQUAL",
+    NotSpecified = "NOT_SPECIFIED",
+    Specified = "SPECIFIED"
+}
+export declare enum IncomeType {
+    ChildMaintenance = "CHILD_MAINTENANCE",
+    ForeignIncome = "FOREIGN_INCOME",
+    GovtBenefit = "GOVT_BENEFIT",
+    InvestmentIncome = "INVESTMENT_INCOME",
+    OtherIncome = "OTHER_INCOME",
+    PaygAllowancesNotTaxed = "PAYG_ALLOWANCES_NOT_TAXED",
+    PaygAllowancesTaxed = "PAYG_ALLOWANCES_TAXED",
+    PaygBaseSalary = "PAYG_BASE_SALARY",
+    PaygBonusIncome = "PAYG_BONUS_INCOME",
+    PaygCarAllowance = "PAYG_CAR_ALLOWANCE",
+    PaygCommissionIncome = "PAYG_COMMISSION_INCOME",
+    PaygCompanyCar = "PAYG_COMPANY_CAR",
+    PaygNonVoluntaryDeductionsPreTax = "PAYG_NON_VOLUNTARY_DEDUCTIONS_PRE_TAX",
+    PaygOvertimeIncome = "PAYG_OVERTIME_INCOME",
+    PaygSalarySacrifice = "PAYG_SALARY_SACRIFICE",
+    RentalIncome = "RENTAL_INCOME",
+    SelfEmployedBusinessIncome = "SELF_EMPLOYED_BUSINESS_INCOME",
+    SelfEmployedBusinessIncomeFullDoc = "SELF_EMPLOYED_BUSINESS_INCOME_FULL_DOC",
+    SelfEmployedBusinessIncomeLowDoc = "SELF_EMPLOYED_BUSINESS_INCOME_LOW_DOC",
+    SuperAnnuityPension = "SUPER_ANNUITY_PENSION",
+    WorkersCompensation = "WORKERS_COMPENSATION"
+}
+/**
+ * The metadata of the alieo
+ */
+export interface Meta {
+    /**
+     * uuid of user who made the action (create/update/delete)
+     */
+    actionedBy: string;
+    /**
+     * role of the user that made the action
+     */
+    actionedByRole: ActionedByRole;
+}
+/**
+ * role of the user that made the action
+ */
+export declare enum ActionedByRole {
+    Customer = "customer",
+    Team = "team"
+}
+export declare enum PublicIncomeType {
+    IncomeCreated = "IncomeCreated",
+    IncomeUpdated = "IncomeUpdated"
+}

package/lib/types/events/public-income.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicIncomeType = exports.ActionedByRole = exports.IncomeType = exports.Proportions = exports.Frequency = exports.BenefitType = void 0;
+var BenefitType;
+(function (BenefitType) {
+    BenefitType["AgePension"] = "AGE_PENSION";
+    BenefitType["DisabilitySupportPension"] = "DISABILITY_SUPPORT_PENSION";
+    BenefitType["FamilyTax"] = "FAMILY_TAX";
+    BenefitType["Other"] = "OTHER";
+})(BenefitType = exports.BenefitType || (exports.BenefitType = {}));
+var Frequency;
+(function (Frequency) {
+    Frequency["Fortnightly"] = "FORTNIGHTLY";
+    Frequency["Monthly"] = "MONTHLY";
+    Frequency["Quarterly"] = "QUARTERLY";
+    Frequency["Weekly"] = "WEEKLY";
+    Frequency["Yearly"] = "YEARLY";
+})(Frequency = exports.Frequency || (exports.Frequency = {}));
+/**
+ * Indicate whether ownership proportions are equal, specified individually for each one or
+ * not specified.
+ */
+var Proportions;
+(function (Proportions) {
+    Proportions["Equal"] = "EQUAL";
+    Proportions["NotSpecified"] = "NOT_SPECIFIED";
+    Proportions["Specified"] = "SPECIFIED";
+})(Proportions = exports.Proportions || (exports.Proportions = {}));
+var IncomeType;
+(function (IncomeType) {
+    IncomeType["ChildMaintenance"] = "CHILD_MAINTENANCE";
+    IncomeType["ForeignIncome"] = "FOREIGN_INCOME";
+    IncomeType["GovtBenefit"] = "GOVT_BENEFIT";
+    IncomeType["InvestmentIncome"] = "INVESTMENT_INCOME";
+    IncomeType["OtherIncome"] = "OTHER_INCOME";
+    IncomeType["PaygAllowancesNotTaxed"] = "PAYG_ALLOWANCES_NOT_TAXED";
+    IncomeType["PaygAllowancesTaxed"] = "PAYG_ALLOWANCES_TAXED";
+    IncomeType["PaygBaseSalary"] = "PAYG_BASE_SALARY";
+    IncomeType["PaygBonusIncome"] = "PAYG_BONUS_INCOME";
+    IncomeType["PaygCarAllowance"] = "PAYG_CAR_ALLOWANCE";
+    IncomeType["PaygCommissionIncome"] = "PAYG_COMMISSION_INCOME";
+    IncomeType["PaygCompanyCar"] = "PAYG_COMPANY_CAR";
+    IncomeType["PaygNonVoluntaryDeductionsPreTax"] = "PAYG_NON_VOLUNTARY_DEDUCTIONS_PRE_TAX";
+    IncomeType["PaygOvertimeIncome"] = "PAYG_OVERTIME_INCOME";
+    IncomeType["PaygSalarySacrifice"] = "PAYG_SALARY_SACRIFICE";
+    IncomeType["RentalIncome"] = "RENTAL_INCOME";
+    IncomeType["SelfEmployedBusinessIncome"] = "SELF_EMPLOYED_BUSINESS_INCOME";
+    IncomeType["SelfEmployedBusinessIncomeFullDoc"] = "SELF_EMPLOYED_BUSINESS_INCOME_FULL_DOC";
+    IncomeType["SelfEmployedBusinessIncomeLowDoc"] = "SELF_EMPLOYED_BUSINESS_INCOME_LOW_DOC";
+    IncomeType["SuperAnnuityPension"] = "SUPER_ANNUITY_PENSION";
+    IncomeType["WorkersCompensation"] = "WORKERS_COMPENSATION";
+})(IncomeType = exports.IncomeType || (exports.IncomeType = {}));
+/**
+ * role of the user that made the action
+ */
+var ActionedByRole;
+(function (ActionedByRole) {
+    ActionedByRole["Customer"] = "customer";
+    ActionedByRole["Team"] = "team";
+})(ActionedByRole = exports.ActionedByRole || (exports.ActionedByRole = {}));
+var PublicIncomeType;
+(function (PublicIncomeType) {
+    PublicIncomeType["IncomeCreated"] = "IncomeCreated";
+    PublicIncomeType["IncomeUpdated"] = "IncomeUpdated";
+})(PublicIncomeType = exports.PublicIncomeType || (exports.PublicIncomeType = {}));

package/lib/types/events/public-liability.d.ts

@@ -0,0 +1,140 @@
+/**
+ * The liability event schema
+ */
+export interface PublicLiability {
+    payload: LiabilityPayload;
+    type: Type;
+    /**
+     * schema version
+     */
+    version: string;
+}
+/**
+ * create / update liability payload
+ */
+export interface LiabilityPayload {
+    applicationId: string;
+    /**
+     * uuid of liability
+     */
+    id: string;
+    liability: Liability;
+    meta?: Meta;
+}
+export interface Liability {
+    annualInterestRate?: number;
+    balloonRepaymentAmount?: number;
+    clearingFromOtherSource?: ClearingFromOtherSource;
+    clearingFromThisLoan?: boolean;
+    creditLimit?: number;
+    description?: string;
+    financialInstitution?: string;
+    financialInstitutionAccountNumber?: string;
+    financialInstitutionBsb?: string;
+    financialInstitutionShortName?: string;
+    interestOnlyDuration?: number;
+    interestOnlyRemainingTerm?: number;
+    interestType?: InterestType;
+    newLimit?: number;
+    originalBalance?: number;
+    outstandingBalance: number;
+    percentOwned?: PercentOwned;
+    remainingTermDuration?: number;
+    repaymentAmount?: number;
+    repaymentFrequency?: RepaymentFrequency;
+    repaymentTypeDetails?: RepaymentTypeDetails;
+    /**
+     * Is the loan (split) to be topped up
+     */
+    toBeToppedUp?: boolean;
+    type: LiabilityType;
+}
+export declare enum ClearingFromOtherSource {
+    PayingOut = "PAYING_OUT",
+    Reducing = "REDUCING"
+}
+export declare enum InterestType {
+    FixedRate = "FIXED_RATE",
+    Variable = "VARIABLE"
+}
+export interface PercentOwned {
+    owners: ApplicantOwnership[];
+    /**
+     * Indicate whether ownership proportions are equal, specified individually for each one or
+     * not specified.
+     */
+    proportions?: Proportions;
+}
+export interface ApplicantOwnership {
+    /**
+     * The applicant Identifier
+     */
+    applicantId: string;
+    customerId?: string;
+    /**
+     * how much percent for the corresponding applicant
+     */
+    percent: number;
+}
+/**
+ * Indicate whether ownership proportions are equal, specified individually for each one or
+ * not specified.
+ */
+export declare enum Proportions {
+    Equal = "EQUAL",
+    NotSpecified = "NOT_SPECIFIED",
+    Specified = "SPECIFIED"
+}
+export declare enum RepaymentFrequency {
+    Fortnightly = "FORTNIGHTLY",
+    Monthly = "MONTHLY",
+    Weekly = "WEEKLY",
+    Yearly = "YEARLY"
+}
+export declare enum RepaymentTypeDetails {
+    InterestOnly = "INTEREST_ONLY",
+    PrincipalAndInterest = "PRINCIPAL_AND_INTEREST"
+}
+/**
+ * LEASE_OR_HIRE_FINANCE is deprecated.
+ */
+export declare enum LiabilityType {
+    CarLoan = "CAR_LOAN",
+    CreditCard = "CREDIT_CARD",
+    HelpHecsDebt = "HELP_HECS_DEBT",
+    HirePurchase = "HIRE_PURCHASE",
+    HomeLoan = "HOME_LOAN",
+    Lease = "LEASE",
+    LeaseOrHireFinance = "LEASE_OR_HIRE_FINANCE",
+    LineOfCredit = "LINE_OF_CREDIT",
+    Other = "OTHER",
+    Overdraft = "OVERDRAFT",
+    PersonalLoan = "PERSONAL_LOAN",
+    ShortTermFinance = "SHORT_TERM_FINANCE",
+    StoreCard = "STORE_CARD",
+    TaxDebt = "TAX_DEBT"
+}
+/**
+ * The metadata of the alieo
+ */
+export interface Meta {
+    /**
+     * uuid of user who made the action (create/update/delete)
+     */
+    actionedBy: string;
+    /**
+     * role of the user that made the action
+     */
+    actionedByRole: ActionedByRole;
+}
+/**
+ * role of the user that made the action
+ */
+export declare enum ActionedByRole {
+    Customer = "customer",
+    Team = "team"
+}
+export declare enum Type {
+    LiabilityCreated = "LiabilityCreated",
+    LiabilityUpdated = "LiabilityUpdated"
+}