GET v1/AccrualPayments

Description

Retrieve list of AccrualPayments satisfying the input search criteria.

Base Url

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


Rest Call Syntax


GET TradeManagement/v1/AccrualPayments

GET TradeManagement/v1/AccrualPayments

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

AccrualTypeId

The flag indicating if the issuer is soft deleted in the system

integer

IssuerId

The flag indicating if the issuer is soft deleted in the system

integer

PageNumber

Specified Page number to search

integer

PageSize

Specified Page size to search

integer

PortfolioId

The flag indicating if the issuer is soft deleted in the system

integer

PositionId

The flag indicating if the issuer is soft deleted in the system

integer




Response Information


Paged List of AccrualPayments


PagedList Of AccrualPaymentListItem

Name

Description

Type

Additional Information

Items

Collection of AccrualPaymentListItem

Links

Collection of Link

PagingInformation




Response Body Formats



application/json, text/json

Sample:
{
  "items": [
    {
      "id": 1,
      "accrualPaymentName": "sample string 2",
      "accrualTypeId": 3,
      "currencyTypeId": 4,
      "dayCount": "sample string 5",
      "direction": "sample string 6",
      "exchangeRate": 7.1,
      "frequency": "sample string 8",
      "isReceived": true,
      "linkingId": 10,
      "notes": "sample string 11",
      "periodEnd": "2024-10-08T05:33:29.6970553-05:00",
      "periodStart": "2024-10-08T05:33:29.6970553-05:00",
      "portfolioId": 14,
      "positionId": 15,
      "rateOptionId": 16,
      "receiveDate": "2024-10-08T05:33:29.6970553-05:00",
      "addDate": "2024-10-08T05:33:29.6970553-05:00",
      "lastChangeDate": "2024-10-08T05:33:29.6970553-05:00",
      "issuerId": 20,
      "borrowerName": "sample string 21",
      "isBorrowerTransaction": true,
      "amount": 23.0,
      "addId": "sample string 24",
      "lastChangeId": "sample string 25",
      "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,
      "accrualPaymentName": "sample string 2",
      "accrualTypeId": 3,
      "currencyTypeId": 4,
      "dayCount": "sample string 5",
      "direction": "sample string 6",
      "exchangeRate": 7.1,
      "frequency": "sample string 8",
      "isReceived": true,
      "linkingId": 10,
      "notes": "sample string 11",
      "periodEnd": "2024-10-08T05:33:29.6970553-05:00",
      "periodStart": "2024-10-08T05:33:29.6970553-05:00",
      "portfolioId": 14,
      "positionId": 15,
      "rateOptionId": 16,
      "receiveDate": "2024-10-08T05:33:29.6970553-05:00",
      "addDate": "2024-10-08T05:33:29.6970553-05:00",
      "lastChangeDate": "2024-10-08T05:33:29.6970553-05:00",
      "issuerId": 20,
      "borrowerName": "sample string 21",
      "isBorrowerTransaction": true,
      "amount": 23.0,
      "addId": "sample string 24",
      "lastChangeId": "sample string 25",
      "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:
<PagedListOfAccrualPaymentListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <AccrualPaymentListItem>
      <AccrualPaymentName>sample string 2</AccrualPaymentName>
      <AccrualTypeId>3</AccrualTypeId>
      <AddDate>2024-10-08T05:33:29.6970553-05:00</AddDate>
      <AddId>sample string 24</AddId>
      <Amount>23</Amount>
      <BorrowerName>sample string 21</BorrowerName>
      <CurrencyTypeId>4</CurrencyTypeId>
      <DayCount>sample string 5</DayCount>
      <Direction>sample string 6</Direction>
      <ExchangeRate>7.1</ExchangeRate>
      <Frequency>sample string 8</Frequency>
      <Id>1</Id>
      <IsBorrowerTransaction>true</IsBorrowerTransaction>
      <IsReceived>true</IsReceived>
      <IssuerId>20</IssuerId>
      <LastChangeDate>2024-10-08T05:33:29.6970553-05:00</LastChangeDate>
      <LastChangeId>sample string 25</LastChangeId>
      <LinkingId>10</LinkingId>
      <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 11</Notes>
      <PeriodEnd>2024-10-08T05:33:29.6970553-05:00</PeriodEnd>
      <PeriodStart>2024-10-08T05:33:29.6970553-05:00</PeriodStart>
      <PortfolioId>14</PortfolioId>
      <PositionId>15</PositionId>
      <RateOptionId>16</RateOptionId>
      <ReceiveDate>2024-10-08T05:33:29.6970553-05:00</ReceiveDate>
    </AccrualPaymentListItem>
    <AccrualPaymentListItem>
      <AccrualPaymentName>sample string 2</AccrualPaymentName>
      <AccrualTypeId>3</AccrualTypeId>
      <AddDate>2024-10-08T05:33:29.6970553-05:00</AddDate>
      <AddId>sample string 24</AddId>
      <Amount>23</Amount>
      <BorrowerName>sample string 21</BorrowerName>
      <CurrencyTypeId>4</CurrencyTypeId>
      <DayCount>sample string 5</DayCount>
      <Direction>sample string 6</Direction>
      <ExchangeRate>7.1</ExchangeRate>
      <Frequency>sample string 8</Frequency>
      <Id>1</Id>
      <IsBorrowerTransaction>true</IsBorrowerTransaction>
      <IsReceived>true</IsReceived>
      <IssuerId>20</IssuerId>
      <LastChangeDate>2024-10-08T05:33:29.6970553-05:00</LastChangeDate>
      <LastChangeId>sample string 25</LastChangeId>
      <LinkingId>10</LinkingId>
      <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 11</Notes>
      <PeriodEnd>2024-10-08T05:33:29.6970553-05:00</PeriodEnd>
      <PeriodStart>2024-10-08T05:33:29.6970553-05:00</PeriodStart>
      <PortfolioId>14</PortfolioId>
      <PositionId>15</PositionId>
      <RateOptionId>16</RateOptionId>
      <ReceiveDate>2024-10-08T05:33:29.6970553-05:00</ReceiveDate>
    </AccrualPaymentListItem>
  </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>
</PagedListOfAccrualPaymentListItem>



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.