Common Block: schedule

Public

Updated February 25, 2020 09:44.

This section describe the < schedule > block, which is basically … the schedule of the deal (list of payment date and payment amount).

A < schedule > consist of one or several < drawing >, < amortization > or < payment > block.

< drawing > Block

There can be one initial drawing (full notional amount drawn at the start date of the deal), or several drawings (notional amount drawn in several steps)

Available Blocks under the < drawing > Block

Block	M/O	Comments
< referenceDate >	Mandatory	type=Date. Reference Date of the Drawing.
< paymentDate >	Mandatory	type=Date. Payment Date of the Drawing.
< principal >	Mandatory	type=Decimal. Amount of the Drawing.
< currency >	Mandatory	type=String. ISO code of the currency.

< amortization > Block

This block has to be used for amortization occurring in the middle of period which is not part of standard amortization at end of period.

If the amortization is part of the standard amortization, < principal > field in the < payment > block must be used instead.

Available Blocks under the < amortization > Block

Block	M/O	Comments
< referenceDate >	Mandatory	type=Date. Reference Date of the Amortization.
< paymentDate >	Mandatory	type=Date. Payment Date of the Amortization.
< principal >	Mandatory	type=Decimal. Amount of the Amortization.
< currency >	Mandatory	type=String. ISO code of the currency.

< payment > Block

This block represent an interest period.

There are as many < payment > blocks as interest payments in the schedule.

Available Blocks under the < payment > Block

Block	M/O	Comments
< startDate >	Mandatory	type=Date. The start date of the first interest period must be equal to the start date of the deal.
< endDate >	Mandatory	type=Date. The end date of period N must be equal to the start date of period N+1. The end date of the last interest period must be equal to the maturity date of the deal.
< paymentDate >	Mandatory	type=Date.
< interests >	Mandatory	type=Decimal. Interest Amount.
< subsidyInterests >	Mandatory	type=Decimal. Subsidy Interest Amount.
< principal >	Mandatory	type=Decimal. Principal amount, in case of a standard amortization occurring at the end of the interest period..
< fee >	Mandatory	type=Decimal. This field is deprecated. Please do not use.
< currency >	Mandatory	type=String. ISO code of the currency.
< fixing >	Optional	This block provides computation details. Those computation details are displayed in the platform, and help users to understand how are computed interest amount. Block content is described below.
< estimated >	Mandatory	type=Boolean. FALSE means that the interest amount is known (e.g. fixed-rate loan, or already known period for floating-rate loans) TRUE means that the interest amount is unknown (e.g. period in the future for floating-rate loans)

Available Blocks for the < fixing > Block under the < payment > Block

Block	M/O	Comments
< date >	Optional	type=Date. Fixing date, if any (irrelevant for fixed rate loans).
< value >	Mandatory	type=Decimal. Fixing value (or fixed rate in case of fixed rate loan). Expressed in base 1 (e.g. 0.01 is 1%)
< indexReference >	Optional	type=String. Reference of the index. The reference has to be part of the list of available indexes supported by Fairways Debt. E.g. EURIBOR3M, EURIBOR6M, LIBORGBP3M, LIBORUSD3M, etc.
< spread >	Optional	type=Decimal. Spread for the interest period, if any (irrelevant for fixed rate loans). Expressed in base 1 (e.g. 0.01 is 1%).
< dayCountConvention >	Mandatory	Available values are listed in DaycountConvention.