|
IHS Markit API |
GET v1/Facilities/Global/{globalFacilityId}
Description
Retrieve an facility with {globalId} of facility.
Base Url
https://services.wsoweb.com/
Rest Call Syntax
GET SecurityMaster/v1/Facilities/Global/{globalFacilityId}
GET SecurityMaster/v1/Facilities/Global/{globalFacilityId}
Limitations
There are no limitations specified.
Request Information
Parameters
Name
Description
Type
Additional Information
globalFacilityId
Global Id and isShell of the facility
integer
Required
IsShell
global id for facility search
boolean
Response Information
Facility
Name
Description
Type
Additional Information
Abbreviation
The abbreviated name for the asset
string
AccountAdministratorId
The account administrator listed by ID value
integer
AllowFeeAccrual
The flag indicating if the asset has a Fee Accrual contract
boolean
AllowFXAdjustment
flag to determine if FX Rate change adjustment should be done or not
boolean
AllowPIKAccrual
The flag indicating if the asset has a PIK Accrual contract
boolean
AssetClassId
The class of the asset by ID value
integer
BaseCurrencyCode
The ISO currency code
string
Collateral
The description of the collateral that is backing the asset
string
CountryId
The legal country of this asset by ID value
integer
DebtType
What type of debt is the asset
string
DefaultDate
The date the asset went into default
date
DefaultType
The type of default that has occurred
string
EnableLimits
The flag indicating if the asset has limits enabled - must be TRUE to add Limits
boolean
ExpectedMaturityDate
The expected maturity date of the asset - optional field
date
FacilityName
The name of the facility
string
FixedRate
The fixed rate
decimal number
FreezeBorrowing
The flag indicating if borrowing is frozen on the asset
boolean
FXChangeDirectionId
The kind of of change in contract amount in base currency (for any contract in this facility) Increase / Decrease / Either
FXThreshold
% of change in contract amount in base currency (for any contract in this facility) that should trigger FXRate change adjustment
decimal number
GlobalId
Globalid of facility
integer
GuarantorId
The guarantor for the asset by ID value
integer
HasDefaulted
The flag indicating if the asset has defaulted
boolean
HasFXRisk
The flag indicating if the asset has foreign exchange risk
boolean
HolidayCalendarId
The holiday calendar for the asset by ID value
integer
Id
The WSO ID of the object
integer
IncludeLOCInCommitment
Include LOC amounts In Commitment accruals
boolean
IncludeLOCInUtilized
Include LOC amounts In Utilized(Funded) accruals
boolean
InsurerId
The insurer of the asset by ID value
integer
IsCollateralized
The flag indicating if the asset is collateralized
boolean
IsCovenantLite
Sets or gets IsCovenantLite of the facility
boolean
IsDelayedDraw
The flag indicating if the asset is a Delayed Draw Term Loan which must be TRUE for this type of facility to function correctly
boolean
IsDeleted
The flag indicating if the asset has been soft deleted
boolean
IsDIP
The flag indicating if the asset is a Debtor In Possession (DIP)
boolean
IsEmergingMarket
The flag indicating if the asset is from an emerging market
boolean
IsFixedRateLoan
The flag indicating if the asset is a fixed rate loan
boolean
IsGuaranteed
The flag indicating if the asset is guaranteed by another entity
boolean
IsLCCreditLinked
Sets or gets IsLCCreditLinked of the facility
boolean
IsLetterOfCredit
The flag indicating if the asset is a letter of credit
boolean
IsMostSenior
The flag indicating if the asset is the most senior tranche
boolean
IsMultiCurrency
The flag indicating if the asset is a Multi-currency Revolver
boolean
IsPIK
The flag indicating if the asset is a PIK facility
boolean
IsPrivate
The flag indicating if the asset is a private security
boolean
IsRestructured
The flag indicating if the security has been restructured since it was initially issued
boolean
IsStructuredFinanceObligation
The flag indicating if the security belongs to a structured finance obligation
boolean
IsSubscribed
flag to show facility is subscribed
boolean
IssuePrice
The original price at which the asset was issued
decimal number
IsSynthetic
The flag indicating if this a synthetic security
boolean
IsTradedAccrued
The flag indicating if the asset trades with accrued interest
boolean
LIBORSpread
The current LIBOR spread
decimal number
LienType
The type of lien that exists on the loan
string
LOCFee
The current letter of credit rate
decimal number
MaturityDate
The maturity date of the asset
date
MinimumAssignment
The minimum assignment for the asset
decimal number
MinimumHold
The minimum hold for the asset
decimal number
Notes
Notes regarding the asset
string
OriginalGlobalAmount
The original global commitment for the asset
decimal number
PayNonBusinessDirection
Pay Offset - if the coupon falls on a non-business day this field determines when the coupon will pay
integer
PayOffsetDays
Pay Offset - the number of days that coupon payment occurs differing from the coupon date
integer
PayOffsetDirection
Pay Offset - whether the offset is before or after the payment date
integer
PRIMESpread
The current prime spread
decimal number
RegistrationType
The registration type
string
SeniorityId
The seniority of the asset listed by ID value
integer
TradeWithAccruedFee
The flag indicating if the asset trades with accrued fees
boolean
TradeWithAccruedPIK
The flag indicating if the asset trades with accrued PIK
boolean
TradeWithDirtyPricing
The flag indicating if the asset trades with dirty pricing
boolean
UnfundedFee
The current unfunded fee rate
decimal number
Response Body Formats
application/json, text/json
{
"id": 1,
"abbreviation": "sample string 2",
"allowFeeAccrual": true,
"allowPIKAccrual": true,
"assetClassId": 1,
"bankDeal": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"collateral": "sample string 5",
"debtType": "sample string 6",
"defaultDate": "2024-11-23T01:30:06.9748092-06:00",
"defaultType": "sample string 7",
"facilityName": "sample string 8",
"facilityType": "Unassigned",
"freezeBorrowing": true,
"hasDefaulted": true,
"hasFXRisk": true,
"isDIP": true,
"isPIK": true,
"isLetterOfCredit": true,
"includeLOCInUtilized": true,
"includeLOCInCommitment": true,
"issuer": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"amortPaymentFrequency": "Annually",
"prepaymentApplication": "None",
"isEmergingMarket": true,
"isFixedRateLoan": true,
"isMostSenior": true,
"isMultiCurrency": true,
"isPrivate": true,
"isRestructured": true,
"isStructuredFinanceObligation": true,
"issuePrice": 1.1,
"isSynthetic": true,
"isTradedAccrued": true,
"lienType": "sample string 26",
"maturityDate": "2024-11-23T01:30:06.9748092-06:00",
"minimumAssignment": 1.0,
"minimumHold": 1.0,
"isLCCreditLinked": true,
"isCovenantLite": true,
"fixedRate": 1.1,
"isCollateralized": true,
"isDelayedDraw": true,
"isGuaranteed": true,
"liborSpread": 1.1,
"locFee": 1.1,
"expectedMaturityDate": "2024-11-23T01:30:06.9748092-06:00",
"notes": "sample string 33",
"originalGlobalAmount": 1.0,
"payNonBusinessDirection": 34,
"payOffsetDays": 35,
"payOffsetDirection": 36,
"payOffsetType": "BusinessDays",
"primeSpread": 1.1,
"registrationType": "sample string 37",
"tradeWithAccruedFee": true,
"tradeWithAccruedPIK": true,
"tradeWithDirtyPricing": true,
"unfundedFee": 1.1,
"enableLimits": true,
"isDeleted": true,
"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"
}
],
"accountAdministratorId": 1,
"countryId": 1,
"country": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"baseCurrencyCode": "sample string 43",
"guarantorId": 44,
"holidayCalendarId": 1,
"insurerId": 45,
"seniorityId": 1,
"currencies": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"facilityRateOptions": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"rateLimits": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"assetLimits": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"callSchedule": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"facilitySpreads": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"identifiers": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"ratings": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"udfs": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"fxThreshold": 46.1,
"fxChangeDirectionId": "Unassigned",
"allowFXAdjustment": true,
"globalId": 48,
"isSubscribed": true
}
application/xml, text/xml
<Facility xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Abbreviation>sample string 2</Abbreviation>
<AccountAdministratorId>1</AccountAdministratorId>
<AllowFXAdjustment>true</AllowFXAdjustment>
<AllowFeeAccrual>true</AllowFeeAccrual>
<AllowPIKAccrual>true</AllowPIKAccrual>
<AmortPaymentFrequency>Annually</AmortPaymentFrequency>
<AssetClassId>1</AssetClassId>
<AssetLimits>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</AssetLimits>
<BankDeal>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</BankDeal>
<BaseCurrencyCode>sample string 43</BaseCurrencyCode>
<CallSchedule>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</CallSchedule>
<Collateral>sample string 5</Collateral>
<Country>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Country>
<CountryId>1</CountryId>
<Currencies>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Currencies>
<DebtType>sample string 6</DebtType>
<DefaultDate>2024-11-23T01:30:06.9748092-06:00</DefaultDate>
<DefaultType>sample string 7</DefaultType>
<EnableLimits>true</EnableLimits>
<ExpectedMaturityDate>2024-11-23T01:30:06.9748092-06:00</ExpectedMaturityDate>
<FXChangeDirectionId>Unassigned</FXChangeDirectionId>
<FXThreshold>46.1</FXThreshold>
<FacilityName>sample string 8</FacilityName>
<FacilityRateOptions>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</FacilityRateOptions>
<FacilitySpreads>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</FacilitySpreads>
<FacilityType>Unassigned</FacilityType>
<FixedRate>1.1</FixedRate>
<FreezeBorrowing>true</FreezeBorrowing>
<GlobalId>48</GlobalId>
<GuarantorId>44</GuarantorId>
<HasDefaulted>true</HasDefaulted>
<HasFXRisk>true</HasFXRisk>
<HolidayCalendarId>1</HolidayCalendarId>
<Id>1</Id>
<Identifiers>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Identifiers>
<IncludeLOCInCommitment>true</IncludeLOCInCommitment>
<IncludeLOCInUtilized>true</IncludeLOCInUtilized>
<InsurerId>45</InsurerId>
<IsCollateralized>true</IsCollateralized>
<IsCovenantLite>true</IsCovenantLite>
<IsDIP>true</IsDIP>
<IsDelayedDraw>true</IsDelayedDraw>
<IsDeleted>true</IsDeleted>
<IsEmergingMarket>true</IsEmergingMarket>
<IsFixedRateLoan>true</IsFixedRateLoan>
<IsGuaranteed>true</IsGuaranteed>
<IsLCCreditLinked>true</IsLCCreditLinked>
<IsLetterOfCredit>true</IsLetterOfCredit>
<IsMostSenior>true</IsMostSenior>
<IsMultiCurrency>true</IsMultiCurrency>
<IsPIK>true</IsPIK>
<IsPrivate>true</IsPrivate>
<IsRestructured>true</IsRestructured>
<IsStructuredFinanceObligation>true</IsStructuredFinanceObligation>
<IsSubscribed>true</IsSubscribed>
<IsSynthetic>true</IsSynthetic>
<IsTradedAccrued>true</IsTradedAccrued>
<IssuePrice>1.1</IssuePrice>
<Issuer>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Issuer>
<LIBORSpread>1.1</LIBORSpread>
<LOCFee>1.1</LOCFee>
<LienType>sample string 26</LienType>
<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>
<MaturityDate>2024-11-23T01:30:06.9748092-06:00</MaturityDate>
<MinimumAssignment>1</MinimumAssignment>
<MinimumHold>1</MinimumHold>
<Notes>sample string 33</Notes>
<OriginalGlobalAmount>1</OriginalGlobalAmount>
<PRIMESpread>1.1</PRIMESpread>
<PayNonBusinessDirection>34</PayNonBusinessDirection>
<PayOffsetDays>35</PayOffsetDays>
<PayOffsetDirection>36</PayOffsetDirection>
<PayOffsetType>BusinessDays</PayOffsetType>
<PrepaymentApplication>None</PrepaymentApplication>
<RateLimits>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</RateLimits>
<Ratings>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Ratings>
<RegistrationType>sample string 37</RegistrationType>
<SeniorityId>1</SeniorityId>
<TradeWithAccruedFee>true</TradeWithAccruedFee>
<TradeWithAccruedPIK>true</TradeWithAccruedPIK>
<TradeWithDirtyPricing>true</TradeWithDirtyPricing>
<Udfs>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Udfs>
<UnfundedFee>1.1</UnfundedFee>
</Facility>