GET v1/Contracts/{id}

Description

Retrieve a Contract with WSO ID of {id}.

Base Url

https://api-zion.wsohosting.com/


Rest Call Syntax


GET Contract/v1/Contracts/{id}

GET Contract/v1/Contracts/{id}

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

id

WSO ID of Contract

integer

Required




Response Information



Contract

Name

Description

Type

Additional Information

AccrualBasis

Indicates how the accrual contract notional amount and some other contract details, are determined.

AllInRate

The current all in rate of this contract

decimal number

Amount

The position's commitment amount for this contract.

decimal number

BaseRate

The current base rate of this contract

decimal number

ContractName

The name of the contract

string

ContractType

A pointer to the contract type object .

CurrencyType

Link to the CurrencyType

FacilityRateOption

Link to the FacilityRateOption

Frequency

The payment frequency of this contract

integer

GlobalAmount

The current global amount of this contract

decimal number

Id

The unique ID for this contract.

integer

InterestDue

The current amount of interest that is due for this contract

decimal number

InterestReceived

the current amount of interest that has been received on this contract

decimal number

MarkitEntityId

The Markit entity id for this Contract.

string

MaturityDate

The date that this contract is scheduled to pay interest and reset the base rate.

date

MonthCount

The month count that this contract is based on.

NextPaymentDate

The next date that this contract is scheduled to pay interest

date

Notes

Notes for this contract

string

Spread

The current spread of this contract

decimal number

SpreadAdjustment

The Spread Adjustment of the new contract.

decimal number

StartDate

The date that this contract started accruing interest/fees.

date

YearCount

The year count object that this contract is based on




Response Body Formats



application/json, text/json

Sample:
{
  "id": 1,
  "accrualBasis": "Standard",
  "allInRate": 3.1,
  "amount": 4.0,
  "baseRate": 7.1,
  "contractName": "sample string 9",
  "contractType": "TermFunded",
  "currencyType": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "facilityRateOption": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "frequency": 14,
  "globalAmount": 15.0,
  "interestDue": 16.0,
  "interestReceived": 17.0,
  "markitEntityId": "sample string 21",
  "maturityDate": "2024-10-08T05:36:49.5742164-05:00",
  "monthCount": "ACT",
  "nextPaymentDate": "2024-10-08T05:36:49.5742164-05:00",
  "notes": "sample string 24",
  "spread": 28.1,
  "spreadAdjustment": 29.1,
  "startDate": "2024-10-08T05:36:49.5742164-05:00",
  "yearCount": "ACT"
}

application/xml, text/xml

Sample:
<Contract xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AccrualBasis>Standard</AccrualBasis>
  <AllInRate>3.1</AllInRate>
  <Amount>4</Amount>
  <BaseRate>7.1</BaseRate>
  <ContractName>sample string 9</ContractName>
  <ContractType>TermFunded</ContractType>
  <CurrencyType>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </CurrencyType>
  <FacilityRateOption>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </FacilityRateOption>
  <Frequency>14</Frequency>
  <GlobalAmount>15</GlobalAmount>
  <Id>1</Id>
  <InterestDue>16</InterestDue>
  <InterestReceived>17</InterestReceived>
  <MarkitEntityId>sample string 21</MarkitEntityId>
  <MaturityDate>2024-10-08T05:36:49.5742164-05:00</MaturityDate>
  <MonthCount>ACT</MonthCount>
  <NextPaymentDate>2024-10-08T05:36:49.5742164-05:00</NextPaymentDate>
  <Notes>sample string 24</Notes>
  <Spread>28.1</Spread>
  <SpreadAdjustment>29.1</SpreadAdjustment>
  <StartDate>2024-10-08T05:36:49.5742164-05:00</StartDate>
  <YearCount>ACT</YearCount>
</Contract>



Feedback



(0 out of 1500 characters used)
Feedback has been submitted. Thank you for your feedback.
Automatic feedback submission has been turned off by your system administrator. Your feedback has been logged to the exceptions table. Please contact support to find out how to manually send in your feedback. Thank you.