Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncomeTax

A tax on income, state or federal.

Hierarchy

  • CashFlow<"incomeTax">
    • IncomeTax

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Optional #temporal

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

Readonly categories

categories: Category[]

Optional Readonly end

end?: boolean

Readonly id

id: `incomeTax/${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 state

state: "US" | "AL" | "AK" | "AS" | "AZ" | "AR" | "CA" | "CO" | "CT" | "DE" | "DC" | "FM" | "FL" | "GA" | "GU" | "HI" | "ID" | "IL" | "IN" | "IA" | "KS" | "KY" | "LA" | "ME" | "MH" | "MD" | "MA" | "MI" | "MN" | "MS" | "MO" | "MT" | "NE" | "NV" | "NH" | "NJ" | "NM" | "NY" | "NC" | "ND" | "MP" | "OH" | "OK" | "OR" | "PW" | "PA" | "PR" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VT" | "VI" | "VA" | "WA" | "WV" | "WI" | "WY"

A state postal code or 'US' for federal income tax. This controls what tax tables are used.

Readonly type

type: "incomeTax"

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