|
IHS Markit API |
POST v1/Facilities/{id}/FacilityRateOptions
Description
Add a rate option for facility with a WSO ID of {id}
Base Url
https://services.wsoweb.com/
Rest Call Syntax
POST SecurityMaster/v1/Facilities/{id}/FacilityRateOptions
POST SecurityMaster/v1/Facilities/{id}/FacilityRateOptions
Name
Description
Type
Additional Information
Frequency
The default payment frequency associated with this facility option (4 for quarterly, 12 for monthly).
integer
Required
RateOptionName
The name of the Rate Option (i.e. LIBOR, Prime, etc.)
string
Required, Rate Option must be unique on the Facility
AALSpread
The AAL spread of the facility option.
decimal number
DateOffset
The number of days to offset the Effective Date passed to GetBaseRate.
integer
FirstPaymentDate
The default first payment date of this facility option.
date
IsBaseRateObservationShiftEnabled
Gets or sets a flag indicating whether or not base rate observation shift is enabled for this facility option.
boolean
SkimInterestEnabled
SkimInterest feature of facility option.
boolean
Spread
The spread, rate, or fee rate of the facility option.
decimal number
Limitations
There are no limitations specified.
Request Information
Parameters
Name
Description
Type
Additional Information
id
WSO ID of facility
integer
Required
Request body formats
application/json, text/json
{
"rateOptionName": "sample string 1",
"baseRateCompoundMethod": "Unassigned",
"baseRateInterestMethod": "Unassigned",
"dateOffset": 2,
"firstPaymentDate": "2024-11-23T01:20:34.8687878-06:00",
"frequency": 3,
"monthCount": "ACT",
"yearCount": "ACT",
"spread": 4.1,
"isBaseRateObservationShiftEnabled": true,
"skimInterestEnabled": true,
"aalSpread": 7.1
}
application/xml, text/xml
<FacilityRateOptionAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <AALSpread>7.1</AALSpread> <BaseRateCompoundMethod>Unassigned</BaseRateCompoundMethod> <BaseRateInterestMethod>Unassigned</BaseRateInterestMethod> <DateOffset>2</DateOffset> <FirstPaymentDate>2024-11-23T01:20:34.8687878-06:00</FirstPaymentDate> <Frequency>3</Frequency> <IsBaseRateObservationShiftEnabled>true</IsBaseRateObservationShiftEnabled> <MonthCount>ACT</MonthCount> <RateOptionName>sample string 1</RateOptionName> <SkimInterestEnabled>true</SkimInterestEnabled> <Spread>4.1</Spread> <YearCount>ACT</YearCount> </FacilityRateOptionAdd>
application/x-www-form-urlencoded
Sample not available.
Response Information
FacilityRateOption
Name
Description
Type
Additional Information
AALSpread
The AAL spread of the facility option.
decimal number
BaseRateRoundingPrecision
The precision to which the base rate should be rounded.
decimal number
DateOffset
The number of days to offset the Effective Date passed to GetBaseRate.
integer
FirstPay
The default first payment date of this facility option.
date
Frequency
The default payment frequency associated with this facility option (4 for quarterly, 12 for monthly).
integer
Id
The id of the Facility Option. This is for internal use only
integer
IsBaseRateObservationShiftEnabled
Gets or sets a flag indicating whether or not base rate observation shift is enabled for this facility option.
boolean
IsBaseRateRoundingEnabled
A flag indicating whether or not base rate rounding is enabled for this facility option.
boolean
RateOptionName
The name of the facility option.
string
SkimInterestEnabled
SkimInterest feature of facility option.
boolean
Spread
The spread, rate, or fee rate of the facility option.
decimal number
Response Body Formats
application/json, text/json
{
"dateOffset": 1,
"id": 3,
"rateOptionName": "sample string 4",
"firstPay": "2024-11-23T01:20:34.8845907-06:00",
"frequency": 5,
"monthCount": "ACT",
"yearCount": "ACT",
"spread": 6.1,
"behavior": "LIBOR",
"isBaseRateRoundingEnabled": true,
"baseRateRoundingPrecision": 8.1,
"baseRateRoundingDirection": "None",
"isBaseRateObservationShiftEnabled": true,
"baseRateInterestMethod": "Unassigned",
"baseRateCompoundMethod": "Unassigned",
"skimInterestEnabled": true,
"aalSpread": 11.1,
"links": [
{
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
{
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
}
]
}
application/xml, text/xml
<FacilityRateOption xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AALSpread>11.1</AALSpread>
<BaseRateCompoundMethod>Unassigned</BaseRateCompoundMethod>
<BaseRateInterestMethod>Unassigned</BaseRateInterestMethod>
<BaseRateRoundingDirection>None</BaseRateRoundingDirection>
<BaseRateRoundingPrecision>8.1</BaseRateRoundingPrecision>
<Behavior>LIBOR</Behavior>
<DateOffset>1</DateOffset>
<FirstPay>2024-11-23T01:20:34.8845907-06:00</FirstPay>
<Frequency>5</Frequency>
<Id>3</Id>
<IsBaseRateObservationShiftEnabled>true</IsBaseRateObservationShiftEnabled>
<IsBaseRateRoundingEnabled>true</IsBaseRateRoundingEnabled>
<Links>
<Link>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Link>
<Link>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Link>
</Links>
<MonthCount>ACT</MonthCount>
<RateOptionName>sample string 4</RateOptionName>
<SkimInterestEnabled>true</SkimInterestEnabled>
<Spread>6.1</Spread>
<YearCount>ACT</YearCount>
</FacilityRateOption>