Data.Tax.ATO.FY

Types and functions related to financial years.

Documentation

data Days (n :: Nat)

Some number of days in a year. Use days to construct.

Instances

Show (Days n)

Defined in Data.Tax.ATO.FY

Methods

showsPrec :: Int -> Days n -> ShowS

show :: Days n -> String

showList :: [Days n] -> ShowS

days :: forall a. FinancialYear a => Integer -> Days a

Construct a Days value. If out of range, the number of days is clamped to 0 or 365/366 (no runtime errors).

daysAll :: forall a. FinancialYear a => Days a

Every day of the year

daysNone :: Days a

Zero days of the year

getDays :: Days n -> Integer

Get the number of days, which is between 0 and 365/366 inclusive.

getFraction :: forall a frac. (FinancialYear a, Fractional frac) => Days a -> frac

Get the number of days as a fractional value. The denominator is determined by the year type.

type FinancialYear = KnownNat

financialYear :: Day -> Year

The financial year in which the given day falls.

financialYearRange :: Year -> (Day, Day)

Get the range of days (inclusive) for the financial year (July to June) ending in the given year.

financialYearRangeFromProxy :: forall n. FinancialYear n => Proxy n -> (Day, Day)

Get the financial year range (inclusive) for the given type-level financial year. See also financialYearRange.