GET v1/Accruals/{id}

Description

Retrieve a accrual with WSO ID of {id}.

Base Url

https://api-mgi.uat.wsohosting.com/


Rest Call Syntax


GET TradeManagement/v1/Accruals/{id}

GET TradeManagement/v1/Accruals/{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 the accrual

integer

Required




Response Information


Get accrual


Accrual

Name

Description

Type

Additional Information

AccrualName

Gets or sets the AccrualName of the accrual.

string

AccrualPaymentId

Gets or sets the Id of the parent accrual payment object that is used to group all accruals for a single payment.

integer

AddDate

Gets or sets the date that this record was added.

date

AddId

Gets or sets the name of the user who added this record to the system.

string

AddNode

Gets or sets the name of the machine that added this record to the system.

string

AllInRate

The all in rate used to calculate the accrual

decimal number

Amount

The total amount that is being accrued over the period.

decimal number

BaseRate

The base rate used to calculate the accrual

decimal number

EndDate

The ending date of the accrual period.

date

Estimated

Indicates if the accrual is estimated

boolean

Id

The unique Id for this accrual.

integer

LastChangeDate

Gets or sets the date of the last change to this record.

date

LastChangeId

Gets or sets the name of the user that last made changes to this record.

string

LastChangeNode

Gets or sets the name of the machine that last made changes to this record.

string

Links

The Hateoas links related to this accural item

Collection of Link

Notes

Any applicable notes related to this accrual.

string

Notional

The principal amount that will be used to base the accrual on

decimal number

PortfolioId

Gets or sets the Id of the parent portfolio.

integer

PositionId

Gets or sets the Id of the position.

integer

Posted

Posted

boolean

Spread

The spread used to calculate the accrual

decimal number

StartDate

The starting date of the accrual period.

date




Response Body Formats



application/json, text/json

Sample:
{
  "id": 1,
  "posted": true,
  "amount": 3.0,
  "notional": 4.0,
  "allInRate": 5.1,
  "baseRate": 6.1,
  "spread": 7.1,
  "accrualPaymentId": 8,
  "portfolioId": 9,
  "positionId": 10,
  "accrualName": "sample string 11",
  "notes": "sample string 12",
  "estimated": true,
  "endDate": "2024-10-08T11:30:58.0280479+01:00",
  "startDate": "2024-10-08T11:30:58.0280479+01:00",
  "addId": "sample string 17",
  "addNode": "sample string 18",
  "addDate": "2024-10-08T11:30:58.0280479+01:00",
  "lastChangeId": "sample string 20",
  "lastChangeNode": "sample string 21",
  "lastChangeDate": "2024-10-08T11:30:58.0280479+01:00",
  "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

Sample:
<Accrual xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AccrualName>sample string 11</AccrualName>
  <AccrualPaymentId>8</AccrualPaymentId>
  <AddDate>2024-10-08T11:30:58.0280479+01:00</AddDate>
  <AddId>sample string 17</AddId>
  <AddNode>sample string 18</AddNode>
  <AllInRate>5.1</AllInRate>
  <Amount>3</Amount>
  <BaseRate>6.1</BaseRate>
  <EndDate>2024-10-08T11:30:58.0280479+01:00</EndDate>
  <Estimated>true</Estimated>
  <Id>1</Id>
  <LastChangeDate>2024-10-08T11:30:58.0280479+01:00</LastChangeDate>
  <LastChangeId>sample string 20</LastChangeId>
  <LastChangeNode>sample string 21</LastChangeNode>
  <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>
  <Notes>sample string 12</Notes>
  <Notional>4</Notional>
  <PortfolioId>9</PortfolioId>
  <PositionId>10</PositionId>
  <Posted>true</Posted>
  <Spread>7.1</Spread>
  <StartDate>2024-10-08T11:30:58.0280479+01:00</StartDate>
</Accrual>



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.