realty-investor-timeline

@cubedelement.com/realty-investor-timeline


@cubedelement.com/realty-investor-timeline / ledger/ledger-collection / ILedgerCollection

Interface: ILedgerCollection

Defined in: ledger/ledger-collection.ts:10

Methods

add()

add(item): void

Defined in: ledger/ledger-collection.ts:19

Parameters

item
LedgerItem Iterable<LedgerItem>

Returns

void


clone()

clone(): ILedgerCollection

Defined in: ledger/ledger-collection.ts:77

Returns

ILedgerCollection


filter()

filter(pred?): LedgerItem[]

Defined in: ledger/ledger-collection.ts:17

Parameters

pred?

LedgerItemPredicate

Returns

LedgerItem[]


getAvailableSavings()

getAvailableSavings(date, properties, minMonthsRequired?): number

Defined in: ledger/ledger-collection.ts:71

should be the total balance - savings for single family

Parameters

date

Date

properties

IRentalPropertyEntity[]

minMonthsRequired?

number

Returns

number


getBalance()

getBalance(date?): number

Defined in: ledger/ledger-collection.ts:15

the total balance in the ledger collection

Parameters

date?

Date

Returns

number


getCashFlowMonth()

getCashFlowMonth(date?): number

Defined in: ledger/ledger-collection.ts:21

Parameters

date?

Date

Returns

number


getCashFlowMonthCollection()

getCashFlowMonthCollection(year?): number[]

Defined in: ledger/ledger-collection.ts:51

used to get the cashFlow of all 12 months

Parameters

year?

number

Returns

number[]


getCashFlowYearAverage()

getCashFlowYearAverage(date?): number

Defined in: ledger/ledger-collection.ts:57

used to get the average cash flow for the year.

Parameters

date?

Date

Returns

number


getLastLedgerMonth()

getLastLedgerMonth(): LedgerItem[]

Defined in: ledger/ledger-collection.ts:75

Returns

LedgerItem[]


getLatestLedgerItem()

getLatestLedgerItem(): LedgerItem

Defined in: ledger/ledger-collection.ts:73

Returns

LedgerItem


getMinimumSavings()

getMinimumSavings(properties, date, minMonthsRequired?): number

Defined in: ledger/ledger-collection.ts:33

This method gets the total of savings needed for all properties by x amount of months.

Parameters

properties

IRentalPropertyEntity[]

date

Date

minMonthsRequired?

number

Returns

number

Examples

Example, you typically need 6 months of month per single family home, so if you had 3 homes at 6 months and mortgage was $1000. It would be doing the following: `getMinimumSavings = 3 (SF) * $1000 (mort) * 6 (months) = $18,000`
totals all properties getExpensesByDate * amount needed to save by month, so properties[].getExpensesByDate() * minMonthsRequired.

getSummariesAnnual()

getSummariesAnnual(year?): ILedgerSummary[]

Defined in: ledger/ledger-collection.ts:63

Parameters

year?

number

Returns

ILedgerSummary[]


getSummaryAnnual()

getSummaryAnnual(year?): ILedgerSummary

Defined in: ledger/ledger-collection.ts:61

Parameters

year?

number

Returns

ILedgerSummary


getSummaryMonth()

getSummaryMonth(date): ILedgerSummary

Defined in: ledger/ledger-collection.ts:59

Parameters

date

Date

Returns

ILedgerSummary


hasMinimumSavings()

hasMinimumSavings(properties, date, minMonthsRequired?): boolean

Defined in: ledger/ledger-collection.ts:45

determines if there is enough money in the account while forcing a hold on the getMinimumSavings amount.

Parameters

properties

IRentalPropertyEntity[]

date

Date

minMonthsRequired?

number

Returns

boolean

Example

hasMinimumSavings = getBalance >= getMinimumSavings