Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Income

An income item. By default, annual, but can be constrained to a particular period of time.

Key fields:

Hierarchy

  • CashFlow<"income">
    • Income

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Optional #temporal

#temporal?: Temporal<ItemImpl<"income">> = undefined

Readonly categories

categories: Category[]

Optional Readonly end

end?: boolean

Readonly id

id: `income/${string}`

Readonly name

name: string

Optional notes

notes?: string

paymentPeriod

paymentPeriod: CalendarUnit

Payment frequency

prettyName

prettyName: string

Readonly scenario

scenario: IFScenario

Readonly scenarios

scenarios: string[]

sort

sort: number

Sort order

Readonly start

start: Date

Readonly type

type: "income"

Readonly value

value: Money

Accessors

temporal

Methods

hasCategory

  • hasCategory(category: Category): boolean

  • Determine if an item is in a specified category.

    Parameters

    Returns boolean

inScenario

  • inScenario(scenario: string): boolean

  • Determine if an item is in a specified scenario.

    Parameters

    • scenario: string

    Returns boolean

stepper

Static inScenario

  • inScenario(scenario: string, scenarios: string[] | IItem<"asset" | "liability" | "income" | "expense" | "incomeStream" | "incomeTax" | "person" | "text" | "scenario">): boolean

  • Parameters

    • scenario: string
    • scenarios: string[] | IItem<"asset" | "liability" | "income" | "expense" | "incomeStream" | "incomeTax" | "person" | "text" | "scenario">

    Returns boolean

Generated using TypeDoc