Daml.Finance.Interface.Instrument.Bond.Types¶
Data Types¶
data DateRelativeToEnum
The specification of whether payments/resets occur relative to the first or last day of a calculation period.
Payments/Resets will occur relative to the first day of each calculation period.Payments/Resets will occur relative to the last day of each calculation period.instance Eq DateRelativeToEnum
instance Show DateRelativeToEnum
data DayTypeEnum
A day type classification used in counting the number of days between two dates.
When calculating the number of days between two dates the count includes only business days.When calculating the number of days between two dates the count includes all calendar days.instance Eq DayTypeEnum
instance Show DayTypeEnum
data FixingDates
Specifies the fixing date relative to the reset date in terms of a business days offset and an associated set of financial business centers.
Field Type Description period PeriodEnum The unit of the date offset, e.g. D means that the date offset is specified in days. periodMultiplier Int The number of days (if period is D) before or after the base date the fixing is observed. dayType Optional DayTypeEnum Indicate whether the date offset is given in Business days or Calendar days. businessDayConvention BusinessDayConventionEnum Business day convention that describes how a non-business day is adjusted. businessCenters [Text] The identifiers of the holiday calendars to be used for date adjustment (if any). instance Eq FixingDates
instance Show FixingDates
data FloatingRate
Specifies the data required for a floating rate coupon.
Field Type Description referenceRateId Text The identifier of the reference rate to be used for the coupon, e.g. Libor-3M. referenceRateType ReferenceRateTypeEnum The type of reference rate, which defines how the reference rate is calcuated. fixingDates FixingDates Specifies the fixing dates as an offset of the calculation date, e.g. -2 business days. instance Eq FloatingRate
instance Show FloatingRate
The type of reference rate, which defines how the reference rate is calcuated.
SingleFixing DateRelativeToEnum
The reference rate is fixed on one observation date. This is usually the case for Libor and similar reference rates. A DateRelativeToEnum is required to indicate whether the reference rate will reset relative to the first or the last day of the calculation period.CompoundedIndex DayCountConventionEnum
The reference rate is a regularly (e.g. daily) compounded reference rate, e.g. compounded SOFR, calculated via an index that is continuously compounded since a specified start date. This enables efficient calculation using only the index values at the start and at the end of the calculation period: SOFR_INDEX_END / SOFR_INDEX_START - 1, as described here: https://www.newyorkfed.org/markets/reference-rates/additional-information-about-reference-rates#tgcr_bgcr_sofr_calculation_methodology The day count convention used for the index calculation (by the index provider) is also required. For example, in the case of SOFR this is Act360, which is implied by the 360/dc factor in the formula in the "Calculation Methodology for the SOFR Averages and Index" section in the link above.instance Eq ReferenceRateTypeEnum
instance Show ReferenceRateTypeEnum