GET v1/Accruals

Description

Retrieve list of Accruals satisfying the input search criteria.

Base Url

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

Rest Call Syntax


GET TradeManagement/v1/Accruals

Execute API

GET TradeManagement/v1/Accruals

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

AccrualPaymentId

Search the accrual payment"

integer

PageNumber

Specified Page number to search

integer

PageSize

Specified Page size to search

integer

PortfolioId

Search the accrual payment"

integer

PositionId

Search the accrual payment"

integer



Response Information


Paged List of Accruals


PagedList Of Accrual

Name

Description

Type

Additional Information

Items

Collection of Accrual

Links

Collection of Link

PagingInformation



Response Body Formats



application/json, text/json

Sample: 
{
  "items": [
    {
      "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-08T05:39:56.2043397-05:00",
      "startDate": "2024-10-08T05:39:56.2043397-05:00",
      "addId": "sample string 17",
      "addNode": "sample string 18",
      "addDate": "2024-10-08T05:39:56.2043397-05:00",
      "lastChangeId": "sample string 20",
      "lastChangeNode": "sample string 21",
      "lastChangeDate": "2024-10-08T05:39:56.2043397-05: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"
        }
      ]
    },
    {
      "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-08T05:39:56.2043397-05:00",
      "startDate": "2024-10-08T05:39:56.2043397-05:00",
      "addId": "sample string 17",
      "addNode": "sample string 18",
      "addDate": "2024-10-08T05:39:56.2043397-05:00",
      "lastChangeId": "sample string 20",
      "lastChangeNode": "sample string 21",
      "lastChangeDate": "2024-10-08T05:39:56.2043397-05: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"
        }
      ]
    }
  ],
  "pagingInformation": {
    "totalItems": 1,
    "totalPages": 2,
    "itemsPerPage": 3,
    "currentPage": 4,
    "startRow": 5,
    "endRow": 6
  },
  "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: 
<PagedListOfAccrual xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <Accrual>
      <AccrualName>sample string 11</AccrualName>
      <AccrualPaymentId>8</AccrualPaymentId>
      <AddDate>2024-10-08T05:39:56.2043397-05: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-08T05:39:56.2043397-05:00</EndDate>
      <Estimated>true</Estimated>
      <Id>1</Id>
      <LastChangeDate>2024-10-08T05:39:56.2043397-05: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-08T05:39:56.2043397-05:00</StartDate>
    </Accrual>
    <Accrual>
      <AccrualName>sample string 11</AccrualName>
      <AccrualPaymentId>8</AccrualPaymentId>
      <AddDate>2024-10-08T05:39:56.2043397-05: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-08T05:39:56.2043397-05:00</EndDate>
      <Estimated>true</Estimated>
      <Id>1</Id>
      <LastChangeDate>2024-10-08T05:39:56.2043397-05: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-08T05:39:56.2043397-05:00</StartDate>
    </Accrual>
  </Items>
  <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>
  <PagingInformation>
    <CurrentPage>4</CurrentPage>
    <EndRow>6</EndRow>
    <ItemsPerPage>3</ItemsPerPage>
    <StartRow>5</StartRow>
    <TotalItems>1</TotalItems>
    <TotalPages>2</TotalPages>
  </PagingInformation>
</PagedListOfAccrual>


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.