realty-investor-timeline

@cubedelement.com/realty-investor-timeline


@cubedelement.com/realty-investor-timeline / account/i-user-investor-check / IUserInvestorCheck

Interface: IUserInvestorCheck

Defined in: account/i-user-investor-check.ts:9

Extends

Extended by

Properties

holdRules

holdRules: IRuleEvaluation<HoldRuleTypes>[]

Defined in: account/i-user-investor-check.ts:23

a system to determine how to hold onto the properties the longest. This scenario says as long as it meets 1 rule


ledgerCollection

readonly ledgerCollection: ILedgerCollection

Defined in: account/i-user-investor-check.ts:13

the collection which is used to keep a balance sheet.


loanSettings

loanSettings: ILoanSetting[]

Defined in: account/i-user-investor-check.ts:18

a collection of loan settings for how to get a loan for single family or some other kind of property


monthlyIncomeAmountGoal

monthlyIncomeAmountGoal: number

Defined in: account/i-user-goal.ts:5

used to determine how much you need want for monthly expenses

Inherited from

IUserGoal.monthlyIncomeAmountGoal


purchaseRules

purchaseRules: IRuleEvaluation<PurchaseRuleTypes>[]

Defined in: account/i-user-investor-check.ts:60

a system to weed out the properties you don’t want. This scenario says as long as it meets 1 rule

Methods

getAvailableSavings()

getAvailableSavings(date, properties): number

Defined in: account/i-user-investor-check.ts:55

should be the total balance - savings, using getMinimumSavings, for determining monthly cash to save for single family properties

Parameters

date

Date

properties

IRentalPropertyEntity[]

Returns

number


getMinimumSavings()

getMinimumSavings(date, properties): number

Defined in: account/i-user-investor-check.ts:48

used to retrieve the amount required to keep in savings

Parameters

date

Date

properties

IRentalPropertyEntity[]

Returns

number


hasMinimumSavings()

hasMinimumSavings(date, properties): boolean

Defined in: account/i-user-investor-check.ts:41

a way to determine if the user has enough money. This is different because with single family homes, you would have to save a certain amount of monthly mortgage

Parameters

date

Date

properties

IRentalPropertyEntity[]

Returns

boolean


hasMoneyToInvest()

hasMoneyToInvest(date, properties, contribution?): boolean

Defined in: account/i-user-investor-check.ts:33

based upon getMinimumSavings, it checks to see if there is an amount remaining that can be used along with the contribution.

Parameters

date

Date

properties

IRentalPropertyEntity[]

contribution?

number

Returns

boolean

Example

availableSavings - contribution >= 0;

metAverageQuarterlyGoal()

metAverageQuarterlyGoal(today): boolean

Defined in: account/i-user-goal.ts:17

takes data from a quarterly average cash flow and compares it to the monthly goal. The reason on quarterly is that apartments do distributions quarterly, so you have to spread those out monthly

Parameters

today

Date

Returns

boolean

Inherited from

IUserGoal.metAverageQuarterlyGoal


metMonthlyGoal()

metMonthlyGoal(today): boolean

Defined in: account/i-user-goal.ts:11

method used to help determine if you have met your expenses

Parameters

today

Date

Returns

boolean

Inherited from

IUserGoal.metMonthlyGoal